Interface SearchParameters

interface SearchParameters {
    after_id?: string;
    filter?: string;
    limit?: number;
    page?: number;
    skip?: number;
    sort?: string;
    [param: string]: string | number | boolean;
}

Indexable

[param: string]: string | number | boolean

Properties

after_id? filter? limit? page? skip? sort?

Properties

Optional after_id

after_id?: string

Paginate after the given ID. Cannot be used with sort, page or skip.

Optional filter

filter?: string

Filter to apply e.g. label=my-label,created>2018-09-22

Optional limit

limit?: number

Maximum number of entries to return

Optional page

page?: number

Page number i.e. skip limit * page entries

Optional skip

skip?: number

Number of entries to skip

Optional sort

sort?: string

Sort fields and order e.g. label:asc,created:desc

Settings

Member Visibility

Theme

On This Page

after_idfilterlimitpageskipsort