ora_spinners
A collection of Ora spinners that are compliant with the standard of cli-spinners but with some additions.
Installation
npm install ora_spinners
Usage
Import with
const ora_spinners = ;
Spinners are divided into categories. You can see all the spinners here.
const Ora = ;const spinners = ; const spin = ; spinstart;
cli-spinners
standard
Additions to the A spinner might have properties that define which symbols should be used when a spinner succeeds, fails, warns or infos instead of the standard Ora ones.
Example
const Ora = sp = spin = exec = ; const succeed = { s}; const reallyImportantWork = `for (let i = 0; i < 1e7; i++) {}` spinstart; ;
Exported object
const S = ;
is assumed.
All the spinners listed here are in this object.
S.succeed(path)
Given a path
for a spinner in the format category.name
, get the colored symbol to use with it on success. If none is defined, returns the standard one.
S.fail(path)
Given a path
for a spinner in the format category.name
, get the colored symbol to use with it on failure. If none is defined, returns the standard one.
S.warn(path)
Given a path
for a spinner in the format category.name
, get the colored symbol to use with it on warning. If none is defined, returns the standard one.
S.info(path)
Given a path
for a spinner in the format category.name
, get the colored symbol to use with it when logging an information. If none is defined, returns the standard one.
License
MIT