Class Prompt<T>

Represents the prompt ui.

Type Parameters

T extends Answers = Answers

Hierarchy

UI
- Prompt

Index

Constructors

Properties

activePrompt answers process prompts rl

Methods

close fetchAnswer filterIfRunnable onCompletion onForceClose processQuestion run setDefaultType

Constructors

constructor

new Prompt<T extends Answers = Answers>(
prompts: PromptCollection,
options?: StreamOptions,
): Prompt<T>
Initializes a new instance of the Prompt class.
Type Parameters
- T extends Answers = Answers
Parameters
- prompts: PromptCollection
  The prompts for the ui.
- Optionaloptions: StreamOptions
  The input- and output-stream of the ui.
Returns Prompt<T>
Overrides UI.constructor
- Defined in node_modules/@types/inquirer/index.d.ts:1013

Properties

`Protected`activePrompt

activePrompt: PromptBase

Gets or sets the currently active prompt.

answers

answers: T

Gets or sets the answers provided by the user.

process

process: Observable<QuestionAnswer<T>>

Gets or sets the event-flow of the process.

prompts

prompts: PromptCollection

Gets or sets the prompts of the ui.

`Protected`rl

rl: Interface

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

Methods

`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`fetchAnswer

fetchAnswer(question: FetchedQuestion<T>): Observable<FetchedAnswer>
Fetches the answer to a question.
Parameters
- question: FetchedQuestion<T>
  The question to fetch the answer for.
Returns Observable<FetchedAnswer>
The answer to the question.
- Defined in node_modules/@types/inquirer/index.d.ts:1053

`Protected`filterIfRunnable

filterIfRunnable(question: DistinctQuestion<T>): Observable<DistinctQuestion<T>>
Filters the question if it is runnable.
Parameters
- question: DistinctQuestion<T>
  The question to filter.
Returns Observable<DistinctQuestion<T>>
Either the event-flow of the question if it is runnable or an empty event-flow.
- Defined in node_modules/@types/inquirer/index.d.ts:1079

`Protected`onCompletion

onCompletion(): T
Finishes the process.

Returns T
- Defined in node_modules/@types/inquirer/index.d.ts:1029

`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`processQuestion

processQuestion(question: DistinctQuestion<T>): Observable<FetchedAnswer>
Processes a question.
Parameters
- question: DistinctQuestion<T>
  The question to process.
Returns Observable<FetchedAnswer>
The answer to the question.
- Defined in node_modules/@types/inquirer/index.d.ts:1040

run

run(questions: DistinctQuestion<T>[]): Promise<T>
Runs the prompt-UI.
Parameters
- questions: DistinctQuestion<T>[]
  The questions to prompt the user to answer.
Returns Promise<T>
The answers provided by the user.
- Defined in node_modules/@types/inquirer/index.d.ts:1024

`Protected`setDefaultType

setDefaultType(question: DistinctQuestion<T>): Observable<DistinctQuestion<T>>
Sets the type of the question if no question-type is specified.
Parameters
- question: DistinctQuestion<T>
  The question to set the default type for.
Returns Observable<DistinctQuestion<T>>
The processed question.
- Defined in node_modules/@types/inquirer/index.d.ts:1066