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

    Interface StudyMaterial

    Study materials store user-specific notes and synonyms for a given subject. The records are created as soon as the user enters any study information.

    interface StudyMaterial {
        data: StudyMaterialBaseData & {
            created_at: DatableString;
            hidden: boolean;
            subject_id: number;
            subject_type: SubjectType;
        };
        data_updated_at: DatableString;
        id: number;
        object: "study_material";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data: StudyMaterialBaseData & {
        created_at: DatableString;
        hidden: boolean;
        subject_id: number;
        subject_type: SubjectType;
    }

    Data for the returned study material.

    Type declaration

    • created_at: DatableString

      Timestamp when the study material was created.

    • hidden: boolean

      Indicates if the associated subject has been hidden, preventing it from appearing in lessons or reviews.

    • subject_id: number

      Unique identifier of the associated subject.

    • subject_type: SubjectType

      The type of the associated subject.

    data_updated_at: DatableString

    For a resource, this is the last time that particular resource was updated.

    id: number

    A unique number identifying the study material.

    object: "study_material"

    The kind of object returned.

    url: string

    The URL of the requested resource.