Interface WKAssignmentRequests

Types of Assignment Requests available in the WaniKani API.

interface WKAssignmentRequests {
get: ((idOrParams?: number | WKAssignmentParameters, options?: WKRequestGetOptions) => WKRequest);
start: ((id: number, payload: WKAssignmentPayload, options?: WKRequestPostPutOptions) => WKRequest);
}

Index

Properties

Properties

get

get: ((idOrParams?: number | WKAssignmentParameters, options?: WKRequestGetOptions) => WKRequest)

Get an Assignment or Assignment Collection from the WaniKani API.

Type declaration

- (idOrParams?, options?): WKRequest
- Parameters
  - OptionalidOrParams: number | WKAssignmentParameters
    The Assignment ID for individual Assignments, or parameters for Assignment Collections.
  - Optionaloptions: WKRequestGetOptions
    Options for making GET requests to the API.
  Returns WKRequest
  A Get Assignment(s) Request usabile in any HTTP API/Library.

start

start: ((id: number, payload: WKAssignmentPayload, options?: WKRequestPostPutOptions) => WKRequest)

Start an Assignment (i.e. move from Lessons to Reviews) via the WaniKani API.

Type declaration

- (id, payload, options?): WKRequest
- Parameters
  - id: number
    The Assignment ID to start.
  - payload: WKAssignmentPayload
    The payload to send when starting the Assignment.
  - Optionaloptions: WKRequestPostPutOptions
    Options for making PUT requests to the API.
  Returns WKRequest
  A Start Assignment Request usable in any HTTP API/Library.