Interface WKStudyMaterialParameters

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

See

interface WKStudyMaterialParameters {
    hidden?: boolean;
    ids?: number[];
    page_after_id?: number;
    page_before_id?: number;
    subject_ids?: number[];
    subject_types?: WKSubjectTuple;
    updated_after?: WKDatableString | Date;
}

Hierarchy (View Summary)

Properties

hidden? ids? page_after_id? page_before_id? subject_ids? subject_types? updated_after?

Properties

Optionalhidden

hidden?: boolean

Return study materials with a matching value in the hidden attribute.

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.

Optionalsubject_ids

subject_ids?: number[]

Only study material records where data.subject_id matches one of the array values are returned.

Optionalsubject_types

subject_types?: WKSubjectTuple

Only study material records where data.subject_type matches one of the array values are returned. Valid values are: radical, kanji, or vocabulary.

Optionalupdated_after

updated_after?: WKDatableString | Date

Only resources updated after this time are returned.

Settings

On This Page

Properties