Skip to main content
Version: Next

RunIterateDatasetItemsOptions

Options for iterating over the items of a run's default dataset while the run is still producing them.

Hierarchy

Index

Properties

optionalchunkSize

chunkSize?: number

Maximum number of dataset rows requested per API call. Default is 1000.

optionalclean

clean?: boolean

If true, returns only non-empty items and skips hidden fields.

optionalfields

fields?: string[]

Field names to include in the items. Omits all other fields.

optionalinheritedlimit

limit?: number

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Position of the first returned entry.

optionalomit

omit?: string[]

Field names to exclude from the items.

optionalpollIntervalSecs

pollIntervalSecs?: number

How long to wait for the run to finish between polls, in seconds. Default is 5.

optionalinheritedsignal

signal?: AbortSignal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalskipEmpty

skipEmpty?: boolean

If true, skips empty items.

optionalskipHidden

skipHidden?: boolean

If true, skips hidden fields (fields starting with #).

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.

optionalunwind

unwind?: string[]

Field names to unwind. Each array value creates a separate item.