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 Summary)

UxBase
- Spinner

Index

Constructors

Properties

Accessors

Methods

pause start stop

Constructors

constructor

new Spinner(outputEnabled: boolean): Spinner
Parameters
- outputEnabled: boolean
Returns Spinner
Overrides UxBase.constructor
- Defined in ux/spinner.ts:25

Properties

`Readonly`outputEnabled

outputEnabled: boolean

Accessors

status

get status(): string | undefined
Get the status of the current spinner.

Returns string | undefined
- Defined in ux/spinner.ts:33
set status(status: string | undefined): void
Set the status of the current spinner.
Parameters
- status: string | undefined
Returns void
- Defined in ux/spinner.ts:41

Methods

pause

pause(fn: () => unknown, icon?: string): void
Pause the spinner on the console.
Parameters
- fn: () => unknown
- Optionalicon: string
Returns void
- Defined in ux/spinner.ts:62

start

start(action: string, status?: string, opts?: { stdout?: boolean }): void
Start a spinner on the console.
Parameters
- action: string
- Optionalstatus: string
- Optionalopts: { stdout?: boolean }
Returns void
- Defined in ux/spinner.ts:48

stop

stop(msg?: string): void
Stop the spinner on the console.
Parameters
- Optionalmsg: string
Returns void
- Defined in ux/spinner.ts:55