Interface FilterOptions<P>

interface FilterOptions<P> {
    fields?: null | false | (keyof P)[];
    intersects?: string | LngLatBoundsArray | LngLatArray[];
    limit?: number;
    offset?: number;
    orderBy?: (string | keyof P)[];
    strategy?: "BBOX" | "BBOX+";
}

Type Parameters

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

Hierarchy

  • FilterOptions

    Properties

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

    Properties

    Optionalfields

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

    Optionalintersects

    intersects?: string | LngLatBoundsArray | LngLatArray[]

    WKT polygon geometry

    Optionallimit

    limit?: number

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

    Optionaloffset

    offset?: number

    Offset (paginated) where from entities should be taken.

    OptionalorderBy

    orderBy?: (string | keyof P)[]

    set fields for order

    Remarks

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

    Example

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

    Optionalstrategy

    strategy?: "BBOX" | "BBOX+"

    Settings

    Member Visibility

    On This Page

    Properties