[TypeScript] WaniKani API Types

WaniKani API And Third-Party Apps
10

Howdy everyone. Can’t believe there’s only a couple weeks left in the year!

Happy to announce that version 1.0.0 is out – as Stable as it can be. Aside from removing some types that were either deprecated based on testing this library against the API, or from being replaced with better typedefs, the only other breaking change was the removal of the wanikani_compatibility_mode property under WKUserPreferences, reflecting the removal of Script Compatibility Mode at the end of November.

In addition to supporting TypeScript 5.0 when it launches this Spring, I have a couple new features sitting in my brain that I’ll eventually get coded. Still putting some thought into them, but ideally…

  1. Provide a Routes object with functions that return everything one needs to make a request to any API endpoint; they won’t make the request for you, but will provide a URL and RequestInit (or similar) for you to use in fetch() or whatever HTTP/request library you prefer.
  2. Regex Pattern Matchers for Markup Highlighting, with Named Capture Groups so you can extract, format, etc. any radicals, kanji, vocab, meanings, and readings that show up in subject mnemonics and hints.

And of course, if anyone has any feature ideas that could improve this library, I’m welcome to suggestions here or on GitHub – in addition to any questions, comments, etc. you might have. Thanks in advance!

1 Like