Class WKRequestFactory

A factory for preparing requests to the WaniKani API, with methods that return a WKRequest that can be used in any HTTP API/Library to make the request.

Index

Constructors

Accessors

assignments levelProgressions resets reviewStatistics reviews spacedRepetitionSystems srs studyMaterials subjects summary user voiceActors

Methods

addCustomHeaders setApiRevision setApiToken setCustomHeaders validateHeader

Constructors

constructor

new WKRequestFactory(init): WKRequestFactory
Initialize the Request Factory.
Parameters
- init: WKRequestFactoryInit
  Initialization options for the factory.
Returns WKRequestFactory
- Defined in requests/v20170710.ts:66

Accessors

assignments

get assignments(): WKAssignmentRequests
Returns a collection of requests pertaining to Assignments on the WaniKani API.

Returns WKAssignmentRequests
- Defined in requests/v20170710.ts:86

levelProgressions

get levelProgressions(): WKLevelProgressionRequests
Returns a collection of requests pertaining to Level Progressions on the WaniKani API.

Returns WKLevelProgressionRequests
- Defined in requests/v20170710.ts:143

resets

get resets(): WKResetRequests
Returns a collection of requests pertaining to Resets on the WaniKani API.

Returns WKResetRequests
- Defined in requests/v20170710.ts:181

reviewStatistics

get reviewStatistics(): WKReviewStatisticRequests
Returns a collection of requests pertaining to Review Statistics on the WaniKani API.

Returns WKReviewStatisticRequests
- Defined in requests/v20170710.ts:276

reviews

get reviews(): WKReviewRequests
Returns a collection of requests pertaining to Reviews on the WaniKani API.

Returns WKReviewRequests
- Defined in requests/v20170710.ts:219

spacedRepetitionSystems

get spacedRepetitionSystems(): WKSpacedRepetitionSystemRequests
Returns a collection of requests pertaining to Spaced Repetition Systems (SRS) on the WaniKani API.

Returns WKSpacedRepetitionSystemRequests
- Defined in requests/v20170710.ts:314

srs

get srs(): WKSpacedRepetitionSystemRequests
Returns a collection of requests pertaining to Spaced Repetition Systems (SRS) on the WaniKani API.

Returns WKSpacedRepetitionSystemRequests
- Defined in requests/v20170710.ts:352

studyMaterials

get studyMaterials(): WKStudyMaterialRequests
Returns a collection of requests pertaining to Study Materials on the WaniKani API.

Returns WKStudyMaterialRequests
- Defined in requests/v20170710.ts:359

subjects

get subjects(): WKSubjectRequests
Returns a collection of requests pertaining to Subjects on the WaniKani API.

Returns WKSubjectRequests
- Defined in requests/v20170710.ts:439

summary

get summary(): WKSummaryRequests
Returns a collection of requests pertaining to Summaries on the WaniKani API.

Returns WKSummaryRequests
- Defined in requests/v20170710.ts:477

user

get user(): WKUserRequests
Returns a collection of requests pertaining to Users on the WaniKani API.

Returns WKUserRequests
- Defined in requests/v20170710.ts:509

voiceActors

get voiceActors(): WKVoiceActorRequests
Returns a collection of requests pertaining to Voice Actors on the WaniKani API.

Returns WKVoiceActorRequests
- Defined in requests/v20170710.ts:560

Methods

addCustomHeaders

addCustomHeaders(headers): this
Add additional custom headers to be used in all requests generated by the factory.
Parameters
- headers: Record<string, string>
  An object containing HTTP headers and their values.
Returns this
The factory, with the added custom headers.
- Defined in requests/v20170710.ts:616

setApiRevision

setApiRevision(revision): this
Sets a new WaniKani API Revision to use in requests returned by the factory.
Parameters
- revision: "20170710"
  The WaniKani API Revision to use.
Returns this
The factory, with the newly set WaniKani API Revision.
- Defined in requests/v20170710.ts:630

setApiToken

setApiToken(token): this
Sets a new WaniKani API Token to use in requests returned by the factory.
Parameters
- token: string
  The new WaniKani API Token to use.
Returns this
The factory, with the newly set WaniKani API Token.
- Defined in requests/v20170710.ts:642

setCustomHeaders

setCustomHeaders(headers): this
Sets the custom headers for all requests gerated by the factory to those passed to this function, removing any previously set custom headers, and keeping API Revision and Token settings.
Parameters
- headers: Record<string, string>
  An object containing HTTP headers and their values.
Returns this
The factory, with the only custom headers being those passed to this function.
- Defined in requests/v20170710.ts:655

`Static`validateHeader

validateHeader(key, value): void
Validates custom-set headers to make sure type checking isn't circumvented.
Parameters
- key: string
  The header key, e.g. Accpet or X-Forwarded-For
- value: string
  The header value, e.g. application/json or 192.168.1.1
Returns void
Throws
A TypeError if there is an attempt to improperly set type-checked headers.
- Defined in requests/v20170710.ts:601