https://github.com/fabiospampinato/tiny-spinner

A simple, yet beautiful, CLI spinner.
https://github.com/fabiospampinato/tiny-spinner

cli loading pretty spinner terminal tiny

Last synced: about 1 month ago
JSON representation

A simple, yet beautiful, CLI spinner.

• Host: GitHub
• URL: https://github.com/fabiospampinato/tiny-spinner
• Owner: fabiospampinato
• License: mit
• Created: 2022-02-08T23:50:17.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T16:11:48.000Z (4 months ago)
• Last Synced: 2024-11-11T20:38:56.067Z (about 2 months ago)
• Topics: cli, loading, pretty, spinner, terminal, tiny
• Language: TypeScript
• Homepage:
• Size: 215 KB
• Stars: 15
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        



  



# Tiny Spinner

A simple, yet beautiful, CLI spinner.

## Install

```sh

npm install --save tiny-spinner

```

## Usage

```ts

import Spinner from 'tiny-spinner';

// Create spinner

const spinner = new Spinner ();

// Start spinner with initial message

spinner.start ( 'Doing something' );

// Update message

spinner.update ( 'Still doing something' );

// Exit with a warning message

spinner.warning ( 'Some warning message' );

// Exit with an error message

spinner.error ( 'Some error message' );

// Exit with a success message

spinner.success ( 'Some success message' );

// Exit with a custom message (no prefix symbol)

spinner.stop ( 'Some stop message' );

// Exit without a message

spinner.stop ();

```

## License

MIT © Fabio Spampinato