@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
37 lines (26 loc) • 1.81 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/loopbackio/loopback-next/tree/master/packages/filter
permalink: /doc/en/lb4/apidocs.filter.filter.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[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> | <i>(Optional)</i> To include/exclude fields |
| [include?](./filter.filter.include.md) | [InclusionFilter](./filter.inclusionfilter.md)<!-- -->\[\] | <i>(Optional)</i> To include related objects |
| [limit?](./filter.filter.limit.md) | number | <i>(Optional)</i> Maximum number of entities |
| [offset?](./filter.filter.offset.md) | number | <i>(Optional)</i> Offset N number of entities. An alias for <code>skip</code> |
| [order?](./filter.filter.order.md) | string\[\] | <i>(Optional)</i> 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 | <i>(Optional)</i> Skip N number of entities |
| [where?](./filter.filter.where.md) | [Where](./filter.where.md)<!-- --><MT> | <i>(Optional)</i> The matching criteria |