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

• PaginationOptions
  • DatasetClientListItemOptions
    • DatasetClientCreateItemsUrlOptions
    • DatasetClientDownloadItemsOptions

Index

Properties

• chunkSize
• clean
• desc
• fields
• flatten
• limit
• offset
• omit
• signature
• skipEmpty
• skipHidden
• unwind
• view

Properties

optionalinheritedchunkSize

chunkSize?: number

Inherited from PaginationOptions.chunkSize

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.

optionalclean

clean?: boolean

optionaldesc

desc?: boolean

optionalfields

fields?: string[]

optionalflatten

flatten?: string[]

optionalinheritedlimit

limit?: number

Inherited from PaginationOptions.limit

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Inherited from PaginationOptions.offset

Position of the first returned entry.

optionalomit

omit?: string[]

optionalsignature

signature?: string

optionalskipEmpty

skipEmpty?: boolean

optionalskipHidden

skipHidden?: boolean

optionalunwind

unwind?: string | string[]

optionalview

view?: string