@loopback/docs

--- lang: en title: 'API docs: filter.filterbuilder' 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.filterbuilder.html ---  [Home](./index.md) > [@loopback/filter](./filter.md) > [FilterBuilder](./filter.filterbuilder.md) ## FilterBuilder class A builder for Filter. It provides fleunt APIs to add clauses such as `fields`, `order`, `where`, `limit`, `offset`, and `include`. **Signature:** ```typescript export declare class FilterBuilder<MT extends object = AnyObject> ``` ## Example ```ts 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 <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(f)](./filter.filterbuilder._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `FilterBuilder` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [filter](./filter.filterbuilder.filter.md) </td><td markdown="1"> </td><td markdown="1"> [Filter](./filter.filter.md)<MT> </td><td markdown="1"> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [build()](./filter.filterbuilder.build.md) </td><td markdown="1"> </td><td markdown="1"> Return the filter object </td></tr> <tr><td markdown="1"> [fields(f)](./filter.filterbuilder.fields.md) </td><td markdown="1"> </td><td markdown="1"> Describe what fields to be included/excluded </td></tr> <tr><td markdown="1"> [impose(constraint)](./filter.filterbuilder.impose.md) </td><td markdown="1"> </td><td markdown="1"> 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. </td></tr> <tr><td markdown="1"> [include(i)](./filter.filterbuilder.include.md) </td><td markdown="1"> </td><td markdown="1"> Declare `include` </td></tr> <tr><td markdown="1"> [limit(limit)](./filter.filterbuilder.limit.md) </td><td markdown="1"> </td><td markdown="1"> Set `limit` </td></tr> <tr><td markdown="1"> [offset(offset)](./filter.filterbuilder.offset.md) </td><td markdown="1"> </td><td markdown="1"> Set `offset` </td></tr> <tr><td markdown="1"> [order(o)](./filter.filterbuilder.order.md) </td><td markdown="1"> </td><td markdown="1"> Describe the sorting order </td></tr> <tr><td markdown="1"> [skip(skip)](./filter.filterbuilder.skip.md) </td><td markdown="1"> </td><td markdown="1"> Alias to `offset` </td></tr> <tr><td markdown="1"> [where(w)](./filter.filterbuilder.where.md) </td><td markdown="1"> </td><td markdown="1"> Declare a where clause </td></tr> </tbody></table>