Version: Next

DatasetClientDownloadItemsOptions

Options for downloading dataset items in a specific format.

Extends DatasetClientListItemOptions with format-specific options, minus chunkSize - this downloads the whole range in one request, so there is nothing to size.

Hierarchy

Omit<DatasetClientListItemOptions, chunkSize>
- DatasetClientDownloadItemsOptions

Index

Properties

attachment
bom
clean
delimiter
desc
fields
flatten
limit
offset
omit
signal
signature
skipEmpty
skipHeaderRow
skipHidden
timeoutSecs
unwind
view
xmlRoot
xmlRow

Properties

optionalattachment

attachment?: boolean

optionalbom

bom?: boolean

optionalinheritedclean

clean?: boolean

optionaldelimiter

delimiter?: string

optionalinheriteddesc

desc?: boolean

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

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.

optionalinheritedsignature

signature?: string

Added in 2.13.0

optionalinheritedskipEmpty

skipEmpty?: boolean

optionalskipHeaderRow

skipHeaderRow?: boolean

optionalinheritedskipHidden

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.

optionalinheritedunwind

unwind?: string | string[]

optionalinheritedview

view?: string

Added in 2.2.0

optionalxmlRoot

xmlRoot?: string

optionalxmlRow

xmlRow?: string