Class BottomBar

Represents the bottom-bar UI.

Hierarchy

UI
- BottomBar

Index

Constructors

Properties

activePrompt log rl

Methods

clean close enforceLF onForceClose render updateBottomBar write writeLog

Constructors

constructor

new BottomBar(options?: BottomBarOptions): BottomBar
Initializes a new instance of the BottomBar class.
Parameters
- Optionaloptions: BottomBarOptions
  Provides options for the bottom-bar ui.
Returns BottomBar
Overrides UI.constructor
- Defined in node_modules/@types/inquirer/index.d.ts:940

Properties

`Protected`activePrompt

activePrompt: PromptBase

Gets or sets the currently active prompt.

log

log: ThroughStream

Gets or sets a stream to write logs to.

`Protected`rl

rl: Interface

Gets or sets an object for performing read from and write to the console.

Methods

`Protected`clean

clean(): this
Cleans the bottom bar.

Returns this
- Defined in node_modules/@types/inquirer/index.d.ts:958

`Protected`close

close(): void
Releases all unmanaged resources.

Returns void
Inherited from UI.close
- Defined in node_modules/@types/inquirer/lib/ui/baseUI.d.ts:34

`Protected`enforceLF

enforceLF(text: string): string
Fixes the new-line characters of the specified text.
Parameters
- text: string
  The text to process.
Returns string
- Defined in node_modules/@types/inquirer/index.d.ts:982

`Protected`onForceClose

onForceClose(): void
Handles a forced exit of the application.

Returns void
Inherited from UI.onForceClose
- Defined in node_modules/@types/inquirer/lib/ui/baseUI.d.ts:29

`Protected`render

render(): this
Renders the bottom bar.

Returns this
- Defined in node_modules/@types/inquirer/index.d.ts:953

updateBottomBar

updateBottomBar(text: string): this
Renders the specified text to the bottom bar.
Parameters
- text: string
  The text to print to the bottom bar.
Returns this
- Defined in node_modules/@types/inquirer/index.d.ts:948

`Protected`write

write(message: string): void
Writes a message to the bottom bar.
Parameters
- message: string
  The message to write.
Returns void
- Defined in node_modules/@types/inquirer/index.d.ts:966

`Protected`writeLog

writeLog(data: any): this
Writes the specified data to the log-zone.
Parameters
- data: any
  The data to write to the log-zone.
Returns this
- Defined in node_modules/@types/inquirer/index.d.ts:974