Skip to content

dephub-js/spinner

Repository files navigation

@dephub/spinner ⏳

Simple cross-platform spinner for Node.js and browser environments.

NPM version ESM-only


Features ✨

  • ⏳ Lightweight CLI spinner for Node.js
  • 🌐 Fallback logging for browser environments
  • ✅ Success and ❌ error statuses
  • 🖥 Easy singleton instance for quick usage
  • 🎨 Customizable messages and intervals

Installation 📦

  • npm: npm install @dephub/spinner
  • pnpm: pnpm add @dephub/spinner
  • yarn: yarn add @dephub/spinner
  • bun: bun add @dephub/spinner

Usage 🎯

CLI 💻

import spinner from '@dephub/spinner';

spinner.start('Linting project');

await someAsyncTask();

spinner.stop('success', 'Lint completed');

API 🧩

import { Spinner, spinner } from '@dephub/spinner';

// Create a new instance
const mySpinner = new Spinner();
mySpinner.start('Building...');
await buildProject();
mySpinner.stop('success', 'Build finished');

// Use the singleton
spinner.start('Fetching data...');
await fetchData();
spinner.stop('success', 'Data loaded');

License 📄

MIT License – see LICENSE for details.

Author: Estarlin R (estarlincito.com)

About

Cross-platform CLI spinner for Node.js and browser with TypeScript support

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors