Interface WKUserRequests

Types of User Requests available in the WaniKani API.

interface WKUserRequests {
    get: (options?: WKRequestGetOptions) => WKRequest;
    updatePreferences: (
        payload: WKUserPreferencesPayload,
        options?: WKRequestPostPutOptions,
    ) => WKRequest;
}

Index

Properties

get updatePreferences

Properties

get

get: (options?: WKRequestGetOptions) => WKRequest

Get a user's information from the WaniKani API.

Type declaration

- (options?: WKRequestGetOptions): WKRequest
- Parameters
  - Optionaloptions: WKRequestGetOptions
    Options for making GET requests to the API.
  Returns WKRequest
  A Get User Request usabile in any HTTP API/Library.

updatePreferences

updatePreferences: (
payload: WKUserPreferencesPayload,
options?: WKRequestPostPutOptions,
) => WKRequest

Update a User's Preferences via the WaniKani API.

Type declaration

- (
  payload: WKUserPreferencesPayload,
  options?: WKRequestPostPutOptions,
  ): WKRequest
- Parameters
  - payload: WKUserPreferencesPayload
    The payload containing changed Preferences to send for the update.
  - Optionaloptions: WKRequestPostPutOptions
    Options for making PUT requests to the API.
  Returns WKRequest
  An Update User Preferences Request usabile in any HTTP API/Library.