Interface WKSubjectParameters

Parameters that can be passed to the WaniKani API to filter a request for a Subject Collection.

See

interface WKSubjectParameters {
    hidden?: boolean;
    ids?: number[];
    levels?: WKLevel[];
    page_after_id?: number;
    page_before_id?: number;
    slugs?: string[];
    types?: WKSubjectTuple;
    updated_after?: WKDatableString | Date;
}

Hierarchy (View Summary)

Properties

hidden? ids? levels? page_after_id? page_before_id? slugs? types? updated_after?

Properties

Optionalhidden

hidden?: boolean

Return subjects which are or are not hidden from the user-facing application.

Optionalids

ids?: number[]

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

Optionallevels

levels?: WKLevel[]

Return subjects at the specified levels.

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.

Optionalslugs

slugs?: string[]

Return subjects of the specified slug.

Optionaltypes

types?: WKSubjectTuple

Return subjects of the specified types.

Optionalupdated_after

updated_after?: WKDatableString | Date

Only resources updated after this time are returned.

Settings

On This Page

Properties