DatasetDataOptions

Index

Properties

• clean
• desc
• fields
• limit
• offset
• skipEmpty
• skipHidden
• unwind

Properties

optionalclean

clean?: boolean = ```ts 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.

optionaldesc

desc?: boolean = ```ts false ```

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

optionalfields

fields?: string[]

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

optionallimit

limit?: number = ```ts 250000 ```

Maximum number of array elements to return.

optionaloffset

offset?: number = ```ts 0 ```

Number of array elements that should be skipped at the start.

optionalskipEmpty

skipEmpty?: boolean = ```ts 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.

optionalskipHidden

skipHidden?: boolean = ```ts false ```

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

optionalunwind

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.