@bachman-dev/wanikani-api-types - v1.8.0
    Preparing search index...

    Interface WKAssignmentParameters

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

    interface WKAssignmentParameters {
        available_after?: WKDatableString | Date;
        available_before?: WKDatableString | Date;
        burned?: boolean;
        hidden?: boolean;
        ids?: number[];
        immediately_available_for_lessons?: boolean;
        immediately_available_for_review?: boolean;
        in_review?: boolean;
        levels?: WKLevel[];
        page_after_id?: number;
        page_before_id?: number;
        srs_stages?: WKSrsStageNumber[];
        started?: boolean;
        subject_ids?: number[];
        subject_types?: WKSubjectTuple;
        unlocked?: boolean;
        updated_after?: WKDatableString | Date;
    }

    Hierarchy (View Summary)

    Index

    Properties

    available_after? available_before? burned? hidden? ids? immediately_available_for_lessons? immediately_available_for_review? in_review? levels? page_after_id? page_before_id? srs_stages? started? subject_ids? subject_types? unlocked? updated_after?

    Properties

    available_after?: WKDatableString | Date

    Only assignments available at or after this time are returned.

    available_before?: WKDatableString | Date

    Only assignments available at or before this time are returned.

    burned?: boolean

    When set to true, returns assignments that have a value in data.burned_at. Returns assignments with a null data.burned_at if false.

    hidden?: boolean

    Return assignments with a matching value in the hidden attribute.

    ids?: number[]

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

    immediately_available_for_lessons?: boolean

    When set to true, returns assignments which are immediately available for lessons.

    immediately_available_for_review?: boolean

    When set to true, returns assignments which are immediately available for review.

    in_review?: boolean

    When set to true, returns assignments which are in the review state.

    levels?: WKLevel[]

    Only assignments where the associated subject level matches one of the array values are returned. Valid values range from 1 to 60.

    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.

    srs_stages?: WKSrsStageNumber[]

    Only assignments where data.srs_stage matches one of the array values are returned. Valid values range from 0 to 9.

    started?: boolean

    When set to true, returns assignments that have a value in data.started_at. Returns assignments with a null data.started_at if false.

    subject_ids?: number[]

    Only assignments where data.subject_id matches one of the array values are returned.

    subject_types?: WKSubjectTuple

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

    unlocked?: boolean

    When set to true, returns assignments that have a value in data.unlocked_at. Returns assignments with a null data.unlocked_at if false.

    updated_after?: WKDatableString | Date

    Only resources updated after this time are returned.

    Settings

    On This Page

    Properties