Skip filter

A skip filter omits the specified number of returned records. This is useful, for example, to paginate responses.

Use offset as an alias for skip.

Node.js

{skip: n}

Where n is the number of records to skip.

REST API

?filter[skip]=n

You can also use stringified JSON format in a REST query.

Examples

To Skip the first three records:

await orderRepository.find({skip: 3});

/orders?filter[skip]=3

Or stringified JSON format:

/orders?filter={"skip":3}

Pagination Example

The following requests illustrate how to paginate a query result. Each request request returns ten records: the first returns the first ten, the second returns the 11th through the 20th, and so on…

/orders?filter[limit]=10&filter[skip]=0
/orders?filter[limit]=10&filter[skip]=10
/orders?filter[limit]=10&filter[skip]=20
...

await orderRepository.find({limit: 10, skip: 0});
await orderRepository.find({limit: 10, skip: 10});
await orderRepository.find({limit: 10, skip: 20});