[TypeScript] WaniKani API Types

Version 1.2 is now available! It’s a small update accommodating a big change (well, I think it’s kinda big anyway) to WaniKani’s subjects.

Kana Vocabulary Types

We’ve added type definitions for Kana Vocabulary, a new subject type that is like vocabulary, but is only made up of hiragana and/or katakana, and thus has no kanji readings attached.

  • WKKanaVocabulary for an entire single kana-only vocabulary resource (top-level)
  • WKKanaVocabularyCollection for a collection of kana-only vocabulary
  • WKKanaVocabularyData for the actual data found within the resource (characters, parts of speech, the mnemonic, etc.)
  • WKSubject was also updated to include WKKanaVocabulary in its union, in case you’re working with mixed or unknown subject types

Other Changes

The documentation now has a nice sidebar with dropdowns of all the categories of things this library exports.

The supported TypeScript version range in our peerDependencies has also been updated to better illustrate the correct supported versions. Previously, it was ^4.5.0 || ^5.0.0, which did not correctly specify our support of only TypeScript 4.5 to 5.0, not including 5.1, 5.2, etc. until they are released and tested against (since TS doesn’t use Semantic Versioning). The range now reads 4.5.x - 5.0.x which should be more clear on which TS versions are supported.

Last, we now provide package provenance on package versions. This will give you a quick glimpse on where the version was built, what git commit was referenced, what build steps were taken, etc. Most users won’t need this info, but it can help for those with a knack for version integrity in their dependency tree.

Unless WaniKani surprises us with another new feature in the next couple weeks, see y’all in early June for 1.3 and TypeScript 5.1 support!

1 Like