Page Contents

Home > @loopback/filter > Filter

Filter interface

Query filter object

Signature:

export interface Filter<MT extends object = AnyObject>

Properties

Property Modifiers Type Description

fields?

Fields<MT>

(Optional) To include/exclude fields

include?

InclusionFilter[]

(Optional) To include related objects

limit?

number

(Optional) Maximum number of entities

offset?

number

(Optional) Offset N number of entities. An alias for skip

order?

string[]

(Optional) Sorting order for matched entities. Each item should be formatted as fieldName ASC or fieldName DESC. For example: ['f1 ASC', 'f2 DESC', 'f3 ASC'].

We might want to use Order in the future. Keep it as string[] for now for compatibility with LoopBack 3.x.

skip?

number

(Optional) Skip N number of entities

where?

Where<MT>

(Optional) The matching criteria