Version: Next

DatasetClientCreateItemsUrlOptions

Options for creating a public URL to access dataset items.

Extends DatasetClientListItemOptions with URL expiration control.

Hierarchy

DatasetClientListItemOptions
- DatasetClientCreateItemsUrlOptions

Added in 2.16.0

Index

Properties

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

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

optionalinheritedclean

clean?: boolean

optionalinheriteddesc

desc?: boolean

optionalexpiresInSecs

expiresInSecs?: number

optionalinheritedfields

fields?: string[]

optionalinheritedflatten

flatten?: string[]

Added in 2.6.1

optionalinheritedlimit

limit?: number

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Position of the first returned entry.

optionalinheritedomit

omit?: string[]

optionalinheritedsignature

signature?: string

Added in 2.13.0

optionalinheritedskipEmpty

skipEmpty?: boolean

optionalinheritedskipHidden

skipHidden?: boolean

optionalinheritedunwind

unwind?: string | string[]

optionalinheritedview

view?: string

Added in 2.2.0