Interface QueryParams

interface QueryParams {
    after?: string;
    before?: string;
    country?: string;
    limit?: number;
}

Properties

after? before? country? limit?

Properties

Optionalafter

after?: string

The upper bound. Use this to paginate downwards: take the lowest seen prisecter and pass that back through this field to continue scrolling.

Optionalbefore

before?: string

The lower bound. Use this to paginate upwards: take the highest seen prisecter and pass that back through this field to continue scrolling. If set, the search order is reversed (returning the lowest items that match the query)

Optionalcountry

country?: string

The ISO 3166-1 country code to filter to. Leave unset to not filter by country.

Optionallimit

limit?: number

The amount of entries to return, between 1 and 100. 50 by default.

Settings

Member Visibility

On This Page

Properties