Skip to content

@oneplatform/plugin-sdk


@oneplatform/plugin-sdk / BatchResult

Interface: BatchResult

Defined in: packages/plugin-sdk/src/types/connector.ts:33

Properties

estimatedTotal?

optional estimatedTotal?: number

Defined in: packages/plugin-sdk/src/types/connector.ts:53

Advisory hint for the platform progress UI. If unknown, omit this field. The platform never makes correctness decisions based on this value.


fetchedAt

fetchedAt: string

Defined in: packages/plugin-sdk/src/types/connector.ts:47

ISO 8601 timestamp of when this batch was fetched. Used for freshness tracking.


hasMore

hasMore: boolean

Defined in: packages/plugin-sdk/src/types/connector.ts:44

Set to true if there are more records after this batch (i.e., nextCursor is non-null).


nextCursor

nextCursor: string | null

Defined in: packages/plugin-sdk/src/types/connector.ts:41

Cursor for the next fetchBatch call. Set to null to signal that all records have been returned. The cursor value is opaque to the platform — it may be a page token, timestamp, offset, or any string the connector uses internally.


records

records: DataRecord[]

Defined in: packages/plugin-sdk/src/types/connector.ts:34