Class Debugger

The Debugger() class provides basics console interaction for the unit.

Hierarchy

Debugger

Index

Constructors

Properties

Methods

dump err info loadingInfo pauseForAnyKey pauseForQuestion pauseForYNQuestion table warn debugTimestamp

Constructors

constructor

new Debugger(unit: string): Debugger
The Debugger() class provides basics console interaction for the unit.
Parameters
- unit: string
  
  Unit name
Returns Debugger
- Defined in util/debugger/Debugger.ts:20

Properties

`Private` `Readonly` unit

unit: string

Methods

dump

dump(data: any): void
The dump() method dumps any data into the console similar to console.log().
Parameters
- data: any
Returns void
- Defined in util/debugger/Debugger.ts:67

err

err(message: any): void
The err() method logs the given text message to the console similar to console.error().
Parameters
- message: any
  
  Any preferred string message.
Returns void
- Defined in util/debugger/Debugger.ts:92

info

info(message: string): void
The info() method logs the given text message to the console.
Parameters
- message: string
  
  Any preferred string message.
Returns void
- Defined in util/debugger/Debugger.ts:40

loadingInfo

loadingInfo(loadingText: string): Ora
The loadingInfo() method prints a spinner with a given message to the console.

Returns
A spinner controller.
Parameters
- loadingText: string
  
  Any preferred string message.
Returns Ora
- Defined in util/debugger/Debugger.ts:53

pauseForAnyKey

pauseForAnyKey(text?: string): void
The pauseForAnyKey() method pauses the runtime for any user produced keypress.
Parameters
- text: string = 'Press any key to continue.'
  
  Any preferred string text.
Returns void
- Defined in util/debugger/Debugger.ts:137

pauseForQuestion

pauseForQuestion(question: string): string
The pauseForQuestion() method pauses the runtime for a user produced text answer.

Returns
The user produced text answer.
Parameters
- question: string
  
  Any preferred string question.
Returns string
- Defined in util/debugger/Debugger.ts:117

pauseForYNQuestion

pauseForYNQuestion(question?: string): boolean
The pauseForYNQuestion() method pauses the runtime for a user produced y/n answer.

Returns
true when user answer 'y' or 'yes'.
Parameters
- question: string = 'Are you sure?'
  
  Any preferred string question.
Returns boolean
- Defined in util/debugger/Debugger.ts:128

table

table(data: any): void
The table() method dumps any array data as a table into the console similar to console.table().
Parameters
- data: any
Returns void
- Defined in util/debugger/Debugger.ts:79

warn

warn(message: string): void
The warn() method logs the given text message to the console similar to console.warn().
Parameters
- message: string
  
  Any preferred string message.
Returns void
- Defined in util/debugger/Debugger.ts:104

`Static` `Private` debugTimestamp

debugTimestamp(): string
Private
The debugTimestamp() method returns runtime's timestamp in HH:MM:SS format.

Returns string
- Defined in util/debugger/Debugger.ts:28

Generated using TypeDoc