listr2

Appearance

Documentation / @listr2/prompt-adapter-enquirer / ListrEnquirerPromptAdapter

Class: ListrEnquirerPromptAdapter ​

Defined in: prompt-adapter-enquirer/src/prompt.ts:6

Extends ​

  • ListrPromptAdapter

Constructors ​

Constructor ​

new ListrEnquirerPromptAdapter(task, wrapper): ListrEnquirerPromptAdapter

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

Parameters ​

task ​

Task<any, any, any>

wrapper ​

TaskWrapper<any, any, any>

Returns ​

ListrEnquirerPromptAdapter

Inherited from ​

ListrPromptAdapter.constructor

Properties ​

error ​

error: PromptError

Defined in: prompt-adapter-enquirer/src/prompt.ts:7

task ​

protected task: Task<any, any, any>

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

Inherited from ​

ListrPromptAdapter.task

wrapper ​

protected wrapper: TaskWrapper<any, any, any>

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

Inherited from ​

ListrPromptAdapter.wrapper

Accessors ​

instance ​

Get Signature ​

get instance(): EnquirerPromptInstance

Defined in: prompt-adapter-enquirer/src/prompt.ts:13

Get the current running instance of enquirer.

Returns ​

EnquirerPromptInstance

Methods ​

run() ​

run<T>(options, settings?): Promise<T>

Defined in: prompt-adapter-enquirer/src/prompt.ts:22

Create a new prompt with enquirer.

enquirer is a peer dependency that must be installed seperately.

Type Parameters ​

T ​

T = any

Parameters ​

options ​

EnquirerPromptOptions | EnquirerPromptOptions<true>[]

settings? ​

EnquirerPromptSettings

Returns ​

Promise<T>

Overrides ​

ListrPromptAdapter.run

cancel() ​

cancel(options?): void

Defined in: prompt-adapter-enquirer/src/prompt.ts:98

Cancel the ongoing prompt.

Parameters ​

options? ​

EnquirerPromptCancelOptions

Returns ​

void

reportStarted() ​

protected reportStarted(): void

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

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportStarted

reportFailed() ​

protected reportFailed(): void

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

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportFailed

reportCompleted() ​

protected reportCompleted(): void

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

Returns ​

void

Inherited from ​

ListrPromptAdapter.reportCompleted

restoreState() ​

protected restoreState(): void

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

Returns ​

void

Inherited from ​

ListrPromptAdapter.restoreState