Interface WKUserData

Data for a user returned from the WaniKani API.

See

https://docs.api.wanikani.com/20170710/#user

interface WKUserData {
    current_vacation_started_at: null | WKDatableString;
    id: string;
    level: WKLevel;
    preferences: WKUserPreferences;
    profile_url: string;
    started_at: WKDatableString;
    subscription: WKUserSubscription;
    username: string;
}

Index

Properties

current_vacation_started_at id level preferences profile_url started_at subscription username

Properties

current_vacation_started_at

current_vacation_started_at: null | WKDatableString

If the user is on vacation, this will be the timestamp of when that vacation started. If the user is not on vacation, this is null.

id

id: string

A user's unique ID string.

level

level: WKLevel

The current level of the user. This ignores subscription status.

preferences

preferences: WKUserPreferences

User settings specific to the WaniKani application.

profile_url

profile_url: string

The URL to the user's public facing profile page.

started_at

started_at: WKDatableString

The signup date for the user.

subscription

subscription: WKUserSubscription

Details about the user's subscription state.

username

username: string

The user's username.