listr2

Appearance

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

Class: ListrInquirerPromptAdapter ​

Defined in: prompt-adapter-inquirer/src/prompt.ts:4

Extends ​

  • ListrPromptAdapter

Constructors ​

Constructor ​

new ListrInquirerPromptAdapter(task, wrapper): ListrInquirerPromptAdapter

Defined in: listr2/dist/index.d.ts:440

Parameters ​

task ​

Task<any, any, any>

wrapper ​

TaskWrapper<any, any, any>

Returns ​

ListrInquirerPromptAdapter

Inherited from ​

ListrPromptAdapter.constructor

Properties ​

task ​

protected task: Task<any, any, any>

Defined in: listr2/dist/index.d.ts:437

Inherited from ​

ListrPromptAdapter.task

wrapper ​

protected wrapper: TaskWrapper<any, any, any>

Defined in: listr2/dist/index.d.ts:438

Inherited from ​

ListrPromptAdapter.wrapper

Accessors ​

instance ​

Get Signature ​

get instance(): Promise<any>

Defined in: prompt-adapter-inquirer/src/prompt.ts:11

Get the current running instance of inquirer.

Returns ​

Promise<any>

Methods ​

run() ​

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

Defined in: prompt-adapter-inquirer/src/prompt.ts:18

Create a new prompt with inquirer.

Type Parameters ​

T ​

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

Parameters ​

prompt ​

T

__namedParameters ​

...Parameters<T>

Returns ​

Promise<ReturnType<T>>

Overrides ​

ListrPromptAdapter.run

cancel() ​

cancel(): void

Defined in: prompt-adapter-inquirer/src/prompt.ts:51

Cancel the ongoing prompt.

Returns ​

void

reportStarted() ​

protected reportStarted(): void

Defined in: listr2/dist/index.d.ts:441

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportStarted

reportFailed() ​

protected reportFailed(): void

Defined in: listr2/dist/index.d.ts:442

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportFailed

reportCompleted() ​

protected reportCompleted(): void

Defined in: listr2/dist/index.d.ts:443

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportCompleted

restoreState() ​

protected restoreState(): void

Defined in: listr2/dist/index.d.ts:444

Returns ​

void

Inherited from ​

ListrPromptAdapter.restoreState