npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wanikani-notifier

v3.0.1

Published

Wanikani new lessons and reviews notifier

Downloads

13

Readme

wanikani-notifier

WaniKani new lessons and reviews notifier

Usage

Install

Package installation

Install the package globally:

npm i -g wanikani-notifier

Config file (Required!)

Create a file called .wanikani-notifierrc in your home directory (C:\Users\{user} on Windows).

Powered by rc.

You can put options in either JSON or INI format. See the rc documentation for details.

Options:

  • key - Required. Your WaniKani Public API key. Get and manage your API key at https://www.wanikani.com/account .
  • errorSuspendDuration - How long to wait after encountering an error, in milliseconds. Default: 5 minutes
  • notifiedSuspendDuration - How long to wait after delivering a notification, in milliseconds. Default: 10 minutes
  • waitingSuspendDuration - At least how long to wait after determining that there are no pending items, in milliseconds. Default: 36 seconds
  • dashboardOnBothPending - Whether to go to the dashboard when there are both pending lessons and reviews. Default: false -- goes to the lessons page.
  • minilag - A small amount of time to ensure pending items will be available the next time they are scheduled to be queried, in milliseconds. Default: 1 second.

Configure to run at startup

After package installation, run:

wanikani-notifier install

This will install and run the service.

(Alias: i)

To uninstall, run

wanikani-notifier uninstall

(Alias: un)

CLI

Run using the installed global package:

wanikani-notifier [opts]

The notifier, when run, will query the WaniKani API for pending lessons and reviews. If there are no pending items, it will suspend until the next review time.

It will continue running until closed from the terminal.

Options are the same as the config file's. Pass options kebab-cased. Powered by meow.

API

This package has an API, but it's in a different page since you'll most likely be interested in actually running it or the underlying source code (in which case the interesting bits are in wanikani-emitter).

License

MIT