Interface WKSubjectRequests

Types of Subject Requests available in the WaniKani API.

interface WKSubjectRequests {
    get: (
        idOrParams?: number | WKSubjectParameters,
        options?: WKRequestGetOptions,
    ) => WKRequest;
}

Index

Properties

Properties

get

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

Get a Subject or Subject Collection from the WaniKani API.

Type declaration

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