Interface WKCollectionParameters

Query string parameters that can be sent to any WaniKani API collection endpoint.

See

stringifyParameters

interface WKCollectionParameters {
    ids?: number[];
    page_after_id?: number;
    page_before_id?: number;
    updated_after?: WKDatableString | Date;
}

Hierarchy (view full)

Properties

ids? page_after_id? page_before_id? updated_after?

Properties

Optionalids

ids?: number[]

Only resources where data.id matches one of the array values are returned.

Optionalpage_after_id

page_after_id?: number

Get a collection's next page containing pages.per_page resources after the given ID.

This will take precedence over page_before_id if both are specified.

Optionalpage_before_id

page_before_id?: number

Get a collection's previous page containing pages.per_page resources before the given ID.

The page_after_id parameter takes precedence over this if it is specified alongside this parameter.

Optionalupdated_after

updated_after?: WKDatableString | Date

Only resources updated after this time are returned.

Settings

On This Page

Properties