Skip to content

Documentation / @listr2/prompt-adapter-inquirer / ListrInquirerPromptAdapter

Class: ListrInquirerPromptAdapter

Extends

  • ListrPromptAdapter

Constructors

new ListrInquirerPromptAdapter()

new ListrInquirerPromptAdapter(task, wrapper): ListrInquirerPromptAdapter

Parameters

task: Task<any, any, any>

wrapper: TaskWrapper<any, any, any>

Returns

ListrInquirerPromptAdapter

Inherited from

ListrPromptAdapter.constructor

Source

listr2/dist/index.d.ts:411

Properties

task

protected task: Task<any, any, any>

Inherited from

ListrPromptAdapter.task

Source

listr2/dist/index.d.ts:408


wrapper

protected wrapper: TaskWrapper<any, any, any>

Inherited from

ListrPromptAdapter.wrapper

Source

listr2/dist/index.d.ts:409


prompt

private prompt: CancelablePromise<any>

Source

prompt-adapter-inquirer/src/prompt.ts:5

Accessors

instance

get instance(): CancelablePromise<any>

Get the current running instance of inquirer.

Returns

CancelablePromise<any>

Source

prompt-adapter-inquirer/src/prompt.ts:10

Methods

reportStarted()

protected reportStarted(): void

Returns

void

Inherited from

ListrPromptAdapter.reportStarted

Source

listr2/dist/index.d.ts:412


reportFailed()

protected reportFailed(): void

Returns

void

Inherited from

ListrPromptAdapter.reportFailed

Source

listr2/dist/index.d.ts:413


reportCompleted()

protected reportCompleted(): void

Returns

void

Inherited from

ListrPromptAdapter.reportCompleted

Source

listr2/dist/index.d.ts:414


restoreState()

protected restoreState(): void

Returns

void

Inherited from

ListrPromptAdapter.restoreState

Source

listr2/dist/index.d.ts:415


run()

run<T>(prompt, ...__namedParameters): Promise<ReturnType<T>>

Create a new prompt with inquirer.

Type parameters

T extends Prompt<any, any> = Prompt<any, any>

Parameters

prompt: T

• ...__namedParameters: Parameters<T>

Returns

Promise<ReturnType<T>>

Overrides

ListrPromptAdapter.run

Source

prompt-adapter-inquirer/src/prompt.ts:17


cancel()

cancel(): void

Cancel the ongoing prompt.

Returns

void

Source

prompt-adapter-inquirer/src/prompt.ts:49