Skip to main content
Version: Next

DatasetClientListItemOptions

Options for listing items from a dataset.

Provides various filtering, pagination, and transformation options to customize the output format and content of retrieved items.

Hierarchy

Index

Properties

Properties

optionalinheritedchunkSize

chunkSize?: number

Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator will fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the limit is reached or once all items from API have been fetched.

Chunk size is usually limited by API. Minimum of those two limits will be used.

Added in 2.21.0

optionalclean

clean?: boolean

optionaldesc

desc?: boolean

optionalfields

fields?: string[]

optionalflatten

flatten?: string[]

Added in 2.6.1

optionalinheritedlimit

limit?: number

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Position of the first returned entry.

optionalomit

omit?: string[]

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.

optionalsignature

signature?: string

Added in 2.13.0

optionalskipEmpty

skipEmpty?: boolean

optionalskipHidden

skipHidden?: boolean

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 | string[]

optionalview

view?: string

Added in 2.2.0

Page Options