Interface WKReviewRequests

Types of Review Requests available in the WaniKani API.

interface WKReviewRequests {
    create: (
        payload: WKReviewPayload,
        options?: WKRequestPostPutOptions,
    ) => WKRequest;
    get: (
        idOrParams?: number | WKReviewParameters,
        options?: WKRequestGetOptions,
    ) => WKRequest;
}

Index

Properties

Properties

create

create: (
payload: WKReviewPayload,
options?: WKRequestPostPutOptions,
) => WKRequest

Create a new Review via the WaniKani API.

Type declaration

- (payload: WKReviewPayload, options?: WKRequestPostPutOptions): WKRequest
- Parameters
  - payload: WKReviewPayload
    The payload to send when creating the Review.
  - Optionaloptions: WKRequestPostPutOptions
    Options for making POST requests to the API.
  Returns WKRequest
  A Create Review Request usabile in any HTTP API/Library.

get

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

Get a Review or Review Collection from the WaniKani API.

Type declaration

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