Class Display

The Display class is the primary class responsible for providing spinner visualisations.

Hierarchy

Display

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Display(config: Config): Display

- Defined in classes/higher-order/Display.ts:23
Create an instance of Display to handle all messages broadcasted on the terminal.

Parameters
- config: Config
  
  The confguration object.
Returns Display

Properties

Private config

config: Config

The configuration object passed to this instance.

Protected spinner

spinner: Ora

The Ora spinner instance which is useful for display purposes.

Private started

started: boolean = false

A boolean to indicate if the process has started or not.

Methods

onBeforeRestart

onBeforeRestart(): void

- Defined in classes/higher-order/Display.ts:61
Display the config.display.onBeforeRestart message with the spinner before restarting.

Returns void

onBeforeStart

onBeforeStart(): void

- Defined in classes/higher-order/Display.ts:39
Display the config.display.onBeforeStart message with the spinner before executing.

Returns void

onRestart

onRestart(): void

- Defined in classes/higher-order/Display.ts:73
Display the config.display.onRestart message with the spinner after restarting.

Returns void

onStart

onStart(): void

- Defined in classes/higher-order/Display.ts:52
Display the config.display.onStart message with the spinner after executing.

Returns void

Generated using TypeDoc