Page Contents
Home > @loopback/filter > FilterBuilder
FilterBuilder class
A builder for Filter. It provides fleunt APIs to add clauses such as fields, order, where, limit, offset, and include.
Signature:
export declare class FilterBuilder<MT extends object = AnyObject>
Example
const filterBuilder = new FilterBuilder();
const filter = filterBuilder
.fields('id', 'a', 'b')
.limit(10)
.offset(0)
.order(['a ASC', 'b DESC'])
.where({id: 1})
.build();
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| [(constructor)(f)](/doc/en/lb4/apidocs.filter.filterbuilder._constructor_.html) | Constructs a new instance of the `FilterBuilder` class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| [filter](/doc/en/lb4/apidocs.filter.filterbuilder.filter.html) | [Filter](/doc/en/lb4/apidocs.filter.filter.html)<MT> |
Methods
| Method | Modifiers | Description |
|---|---|---|
| [build()](/doc/en/lb4/apidocs.filter.filterbuilder.build.html) | Return the filter object | |
| [fields(f)](/doc/en/lb4/apidocs.filter.filterbuilder.fields.html) | Describe what fields to be included/excluded | |
| [impose(constraint)](/doc/en/lb4/apidocs.filter.filterbuilder.impose.html) | Add a Filter or Where constraint object. If it is a filter object, create an `and` clause for conflicting keys with its where object. For any other properties, throw an error. If it's not a Filter, coerce it to a filter, and carry out the same logic. | |
| [include(i)](/doc/en/lb4/apidocs.filter.filterbuilder.include.html) | Declare `include` | |
| [limit(limit)](/doc/en/lb4/apidocs.filter.filterbuilder.limit.html) | Set `limit` | |
| [offset(offset)](/doc/en/lb4/apidocs.filter.filterbuilder.offset.html) | Set `offset` | |
| [order(o)](/doc/en/lb4/apidocs.filter.filterbuilder.order.html) | Describe the sorting order | |
| [skip(skip)](/doc/en/lb4/apidocs.filter.filterbuilder.skip.html) | Alias to `offset` | |
| [where(w)](/doc/en/lb4/apidocs.filter.filterbuilder.where.html) | Declare a where clause |