Class Spinner

This class is a light wrapper around ux.action that allows us to automatically suppress any actions if --json flag is present.

Hierarchy (view full)

Constructors

constructor

Properties

outputEnabled

Accessors

status

Methods

pause start stop

Constructors

constructor

Properties

ReadonlyoutputEnabled

outputEnabled: boolean

Accessors

status

  • get status(): undefined | string

  • Get the status of the current spinner.

    Returns undefined | string

  • set status(status): void

  • Set the status of the current spinner.

    Parameters

    • status: undefined | string

    Returns void

Methods

pause

  • pause(fn, icon?): void

  • Pause the spinner on the console.

    Parameters

    • fn: (() => unknown)
        • (): unknown

        • Returns unknown

    • Optionalicon: string

    Returns void

start

  • start(action, status?, opts?): void

  • Start a spinner on the console.

    Parameters

    • action: string
    • Optionalstatus: string
    • Optionalopts: {
          stdout?: boolean;
      }
      • Optionalstdout?: boolean

    Returns void

stop

  • stop(msg?): void

  • Stop the spinner on the console.

    Parameters

    • Optionalmsg: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods