@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

github.com/strongloop/loopback-next/tree/master/docs

37 lines (26 loc) • 1.67 kB

Markdown

--- lang: en title: 'API docs: filter.filter' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/strongloop/loopback-next/tree/master/packages/filter permalink: /doc/en/lb4/apidocs.filter.filter.html ---  [Home](./index.md) > [@loopback/filter](./filter.md) > [Filter](./filter.filter.md) ## Filter interface Query filter object <b>Signature:</b> ```typescript export interface Filter<MT extends object = AnyObject> ``` ## Properties | Property | Type | Description | | --- | --- | --- | | [fields](./filter.filter.fields.md) | [Fields](./filter.fields.md)<MT> | To include/exclude fields | | [include](./filter.filter.include.md) | [Inclusion](./filter.inclusion.md)\[\] | To include related objects | | [limit](./filter.filter.limit.md) | number | Maximum number of entities | | [offset](./filter.filter.offset.md) | number | Offset N number of entities. An alias for <code>skip</code> | | [order](./filter.filter.order.md) | string\[\] | Sorting order for matched entities. Each item should be formatted as <code>fieldName ASC</code> or <code>fieldName DESC</code>. For example: <code>['f1 ASC', 'f2 DESC', 'f3 ASC']</code>.We might want to use <code>Order</code> in the future. Keep it as <code>string[]</code> for now for compatibility with LoopBack 3.x. | | [skip](./filter.filter.skip.md) | number | Skip N number of entities | | [where](./filter.filter.where.md) | [Where](./filter.where.md)<MT> | The matching criteria |