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

    Interface Summary

    The summary report contains currently available lessons and reviews and the reviews that will become available in the next 24 hours, grouped by the hour.

    interface Summary {
        data: {
            lessons: SummaryInterval[];
            next_reviews_at: null | DatableString;
            reviews: SummaryInterval[];
        };
        data_updated_at: DatableString;
        object: "report";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data: {
        lessons: SummaryInterval[];
        next_reviews_at: null | DatableString;
        reviews: SummaryInterval[];
    }

    Data for the Summary report.

    Type declaration

    • lessons: SummaryInterval[]

      Details about subjects available for lessons.

    • next_reviews_at: null | DatableString

      Earliest date when the reviews are available. Is null when the user has no reviews scheduled.

    • reviews: SummaryInterval[]

      Details about subjects available for reviews now and in the next 24 hours by the hour (total of 25 objects).

    data_updated_at: DatableString

    The last time the report was updated.

    object: "report"

    The kind of object returned.

    url: string

    The URL of the requested report.