Version: Next

DatasetExportOptions

Hierarchy

Omit<DatasetDataOptions, offset | limit>
- DatasetExportOptions
  - DatasetExportToOptions

Index

Properties

clean
desc
fields
skipEmpty
skipHidden
unwind

Properties

optionalinheritedclean

clean?: boolean = false

If true then the function returns only non-empty items and skips hidden fields (i.e. fields starting with # character). Note that the clean parameter is a shortcut for skipHidden: true and skipEmpty: true options.

optionalinheriteddesc

desc?: boolean = false

If true then the objects are sorted by createdAt in descending order. Otherwise they are sorted in ascending order.

optionalinheritedfields

fields?: string[]

An array of field names that will be included in the result. If omitted, all fields are included in the results.

optionalinheritedskipEmpty

skipEmpty?: boolean = false

If true then the function doesn't return empty items. Note that in this case the returned number of items might be lower than limit parameter and pagination must be done using the limit value.

optionalinheritedskipHidden

skipHidden?: boolean = false

If true then the function doesn't return hidden fields (fields starting with "#" character).

optionalinheritedunwind

unwind?: string

Specifies a name of the field in the result objects that will be used to unwind the resulting objects. By default, the results are returned as they are.