ascorbic / tiny-spin

A CLI spinner in under 1kB

tiny-spin

A tiny, zero-dependency CLI spinner

Try it out

When you want a CLI spinner in just a few bytes. Installation:

npm i tiny-spin

or

yarn add tiny-spin

Usage:

// CommonJS
const { spin } = require("tiny-spin");

const stop = spin("Doing stuff");

// Do stuff

stop();

// ESM

import { spin } from "tiny-spin";

const stop = spin("Doing stuff");

// Do stuff

stop();

API

spin(message, frames, interval)

• message: the message displayed after the spinner. Default empty
• frames: an array of strings that are the frames displayed by the spinner. Default ["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"]
• interval: the interval between frames. Default 80ms.

Returns a function that you call to stop the spinner.

Author: Matt Kane. MIT licence.