Appearance

@graphty/graphty-element / index / SourceReportInfo

Interface: SourceReportInfo ​

Defined in: graph-io/dist/src/sources/types.d.ts:495

The source member of an ImportReport from a source load. Experimental.

Properties ​

budget? ​

readonly optional budget?: object

Defined in: graph-io/dist/src/sources/types.d.ts:511

What a metered service says is left.

remaining ​

readonly remaining: number

What the service says is left.

resetMs? ​

readonly optional resetMs?: number

When it resets, in milliseconds from now.

bytes ​

readonly bytes: number

Defined in: graph-io/dist/src/sources/types.d.ts:505

Decoded response bytes read.

endpoint ​

readonly endpoint: string | null

Defined in: graph-io/dist/src/sources/types.d.ts:501

The endpoint, origin and path only.

id ​

readonly id: string

Defined in: graph-io/dist/src/sources/types.d.ts:497

The source id.

next ​

readonly next: Readonly<Record<string, string | number | boolean | null>> | null

Defined in: graph-io/dist/src/sources/types.d.ts:507

Where to resume; null when the load is complete. Pass it as cursor.

requests ​

readonly requests: number

Defined in: graph-io/dist/src/sources/types.d.ts:503

Requests sent.

server? ​

readonly optional server?: Readonly<Record<string, string>>

Defined in: graph-io/dist/src/sources/types.d.ts:509

Facts about the server.

validators? ​

readonly optional validators?: SourceValidators

Defined in: graph-io/dist/src/sources/types.d.ts:518

What lets a later call tell whether the data changed.

version ​

readonly version: number

Defined in: graph-io/dist/src/sources/types.d.ts:499

The source's descriptor version.