decrunch

> An obstrusive loading indicator for the terminal, reminiscent of Commodore 64's "decrunching".

!GitHub branch check runs

Installation

``bash
npm install decrunch
`

Usage

$3

Wrap any async task with the loading animation:

`typescript
import { whileDecrunching } from './animation.js';

// Wrap any promise
const result = await whileDecrunching(
fetch('https://api.example.com/data'), {
// default options
border: 0,
fps: 25
}
);
`

$3

Start and stop the animation manually:

`typescript
import { startDecrunching } from './animation.js';

const stopDecrunching = startDecrunching({
// default options
border: 0
fps: 30,
});

// Do your work...
await someTask();

stopDecrunching();
`

$3

`shell
npx decrunch sleep 3
`

API

$3

Runs a loading animation while waiting for a promise to resolve.

$3

Starts the animation and returns a function to stop it.

Options

Both exported function accept the same options object:

$3

Type: number
Default: 25

Border with on all sides.

$3

Type: number`
Default: 25

Frames per second.

License ©️

This work is licensed under The MIT License.