Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

nyansole

amingoia6.4kBSD0.5.1

Nyancat in ur console!

nyan, nyancat, cat, console, animation, terminal, tty, cli

readme

nyansole

Nyancat in ur console!

nyansole

API

new Nyancat()

Create a new nyancat.

Nyancat#start()

Start nyancat flying across the screen.

Nyancat#stop()

Stop nyancat where it is.

Nyancat#progress(pct)

Set nyancat length to percentage of screen width, for use as progress bar.

Nyancat#end()

Stop animating the nyancat.

Nyancat#reset()

Reset the nyancat.

Events

Nyancat is an EventEmitter!

Nyancat#on('before draw', fn)

Emitted before the frame is cleared and a new one is drawn.

Nyancat#on('after draw', fn)

Emitted after the frame has been drawn.

BSD Licensed