• Version 0.2.3
  • Published
  • 4.13 kB
  • 1 dependency
  • MIT license


npm i @types/cli-spinner
yarn add @types/cli-spinner
pnpm add @types/cli-spinner


TypeScript definitions for cli-spinner



class Spinner

class Spinner {}


    constructor(titleOrOptions?: string | Options);

      property stream

      readonly stream: NodeJS.WritableStream;

        method clearLine

        clearLine: (stream: NodeJS.WritableStream) => this;

          method isSpinning

          isSpinning: () => boolean;

            method setDefaultSpinnerDelay

            static setDefaultSpinnerDelay: (spinnerDelay: number) => typeof Spinner;

              method setDefaultSpinnerString

              static setDefaultSpinnerString: (
              spinnerString: string | number
              ) => typeof Spinner;

                method setSpinnerDelay

                setSpinnerDelay: (spinnerDelay: number) => this;

                  method setSpinnerString

                  setSpinnerString: (spinnerString: string | number) => this;

                    method setSpinnerTitle

                    setSpinnerTitle: (title: string) => this;

                      method start

                      start: () => this;

                        method stop

                        stop: (clear?: boolean) => this;


                          interface Options

                          interface Options {}

                            property stream

                            stream?: NodeJS.WritableStream | undefined;

                              property text

                              text?: string | undefined;

                                method onTick

                                onTick: (this: Spinner, msg: string) => void;

                                  Package Files (1)

                                  Dependencies (1)

                                  Dev Dependencies (0)

                                  No dev dependencies.

                                  Peer Dependencies (0)

                                  No peer dependencies.


                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/cli-spinner.

                                  • Markdown
                                  • HTML
                                    <a href="https://www.jsdocs.io/package/@types/cli-spinner"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>