Interface FilterOptions<P>

Type Parameters

  • P extends {
        [field: string]: any;
    } = {
        [field: string]: any;
    }

Hierarchy

Properties

fields? intersects? limit? offset? orderBy? strategy?

Properties

Optional fields

fields?: null | false | (keyof P)[]

Optional intersects

intersects?: string | LngLatBoundsArray | LngLatArray[]

WKT polygon geometry

Optional limit

limit?: number

Limit (paginated) - max number of entities should be taken.

Optional offset

offset?: number

Offset (paginated) where from entities should be taken.

Optional orderBy

orderBy?: (string | keyof P)[]

set fields for order

Remarks

TODO: use typescript 4.1 template string type for map -${field}

Example

{ "orderBy": ["field1", "-field2"] }

Optional strategy

strategy?: "BBOX" | "BBOX+"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc