FindOptions Interface
Packages > @anticrm/core > FindOptions
Some options used to perform find opertion.
Signature:
export interface FindOptions<T>
Properties
| Property | Type | Description |
|---|---|---|
| countCallback | (skip: number, limit: number, total: number) => void | A function to be notified about current query skip, limit and total. |
| limit | number | undefined | If set will limit a number of objects. A limit value of 0 is equivalent to setting no limit. |
| skip | number | undefined | Specify how many items we should skip in results. |
| sort | DocumentSorting |
Define a sorting, with a required order. All embedded object sortings are also available. Please not order of passed fields will determine field ordering priority. |
Events
countCallback
A function to be notified about current query skip, limit and total.
Signature:
countCallback?: (skip: number, limit: number, total: number) => void;
limit
If set will limit a number of objects. A limit value of 0 is equivalent to setting no limit.
Signature:
limit?: number | undefined;
skip
Specify how many items we should skip in results.
Signature:
skip?: number | undefined;
sort
Define a sorting, with a required order. All embedded object sortings are also available. Please not order of passed fields will determine field ordering priority.
Signature:
sort?: DocumentSorting<T> | undefined;