Interface WKResource

The common properties across all Resources from the WaniKani API

See

https://docs.api.wanikani.com/20170710/#response-structure

interface WKResource {
    data:
        | WKAssignmentData
        | WKKanaVocabularyData
        | WKKanjiData
        | WKLevelProgressionData
        | WKRadicalData
        | WKResetData
        | WKReviewData
        | WKReviewStatisticData
        | WKSpacedRepetitionSystemData
        | WKStudyMaterialData
        | WKUserData
        | WKVocabularyData
        | WKVoiceActorData;
    data_updated_at: WKDatableString;
    object: WKResourceType | WKSubjectType;
    url: string;
    code?: undefined;
    error?: undefined;
    id?: number;
}

Hierarchy (view full)

Properties

data data_updated_at object url code? error? id?

Properties

data

data:
    | WKAssignmentData
    | WKKanaVocabularyData
    | WKKanjiData
    | WKLevelProgressionData
    | WKRadicalData
    | WKResetData
    | WKReviewData
    | WKReviewStatisticData
    | WKSpacedRepetitionSystemData
    | WKStudyMaterialData
    | WKUserData
    | WKVocabularyData
    | WKVoiceActorData

The resource's data, dependent on the particular type of resource.

data_updated_at

data_updated_at: WKDatableString

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

object

object: WKResourceType | WKSubjectType

The kind of object returned.

url

url: string

The URL of the requested resource.

Optionalcode

code?: undefined

A resource will never have a code property.

Optionalerror

error?: undefined

A resource will never have an error property.

Optionalid

id?: number

A unique identifying number present on all Resources except a User resource, where it is present the data object.

Settings

On This Page

Properties