@bachman-dev/wanikani-api-types - v2.0.0
    Preparing search index...

    Interface StudyMaterialParameters

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

    interface StudyMaterialParameters {
        hidden?: boolean;
        ids?: SafeInteger[];
        page_after_id?: SafeInteger;
        page_before_id?: SafeInteger;
        subject_ids?: SafeInteger[];
        subject_types?: SubjectTuple;
        updated_after?: Date | DatableString;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    hidden?: boolean

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

    ids?: SafeInteger[]

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

    Optionalpage_after_id

    page_after_id?: SafeInteger

    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?: SafeInteger

    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.

    subject_ids?: SafeInteger[]

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

    subject_types?: SubjectTuple

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

    updated_after?: Date | DatableString

    Only resources updated after this time are returned.

    Settings

    On This Page

    Properties