wanikani-api-js is a simple JavaScript WaniKani API wrapper.

• Node

To install wanikani-api-js simply run:

npm install wanikani-api-js

in your project folder.

To run the test a few changes need to be done.

1. Open the config.json in the tests folder
2. The WaniKani AuthToken can also be set in config.json or later as a parameter in the test command.

The tests can then be run via:

  npm test

or

  npm test -- --authToken=<Your WaniKani Auth Token>

in case the auth token was not already set in the config.json;

const WaniKaniApi = require('wanikani-js-api').WaniKaniApi;
const wanikani = new WaniKaniApi(apiToken);

wanikani.authToken = '<api_token_here>';

async function printUserData() {
  const user = await wanikani.getUser();
  const userData = await user.asUserData();

  console.log(userData);
}

printUserData();

import {WaniKaniApi} from 'wanikani-js-api';

class WaniKaniApiSample {
  public wanikani: WaniKaniApi = new WaniKaniApi();

  wanikani.authToken = '<api_token_here>';

  public async printUserData() {
    const user: JSON = await this.wanikani.getUser()
    const userData: JSON = await user.asUserData()

   console.log(userData);
  }
}

const waniKaniApi: WaniKaniApi = new WaniKaniApiSample();

waniKaniApi.printUserData();

• endpoint

  • The WaniKani api endpoint
  • Type: string
  • Get & Set
  • Default: https://api.wanikani.com/v2/

• authToken

  • The WaniKani AuthToken
  • Type: string
  • Get & Set
  • Default: Not set.

• configService

  • The service where all configs are stored
  • Type: ConfigService
  • Get & Set

• WaniKaniApi(authToken?: string)
  • Parameters
    • authToken [optional]
      • The WaniKani AuthToken
      • Type: string

• getUser(): Promise

  • Parameters

  • Returns

    • A Promise containing user
      • Type: IUser

• Owner(configService?: ConfigService)
  • Parameters
    • configService [optional]
      • A custom configService
      • Type: ConfigService

• asJson(): Promise

  • Parameters

    • None

  • Returns

    • A promise containing the data of the owner
      • Type: JSON

A WaniKani User.

• User(configService?: ConfigService)
  • Parameters
    • configService [optional]
      • A custom configService
      • Type: ConfigService

• asUserData(): Promise

  • Parameters

    • None

  • Returns

    • A promise containing the data of the user
      • Type: IUserData

• ✨ Add Basic Support for Users
• ✨ Add ConfigService
• ✨ Add HttpClient
• ✨ Add Declarations
• ✨ Add Registry
• ✨ Add Interfaces
• ✅ Add Tests
• 🏷 Add Types