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
Inherited from
ListrPromptAdapter.constructor
Defined in
listr2/dist/index.d.ts:411
Properties
task
protected
task:Task
<any
,any
,any
>
Inherited from
ListrPromptAdapter.task
Defined in
listr2/dist/index.d.ts:408
wrapper
protected
wrapper:TaskWrapper
<any
,any
,any
>
Inherited from
ListrPromptAdapter.wrapper
Defined in
listr2/dist/index.d.ts:409
Accessors
instance
get
instance():CancelablePromise
<any
>
Get the current running instance of inquirer
.
Returns
CancelablePromise
<any
>
Defined in
prompt-adapter-inquirer/src/prompt.ts:10
Methods
reportStarted()
protected
reportStarted():void
Returns
void
Inherited from
ListrPromptAdapter.reportStarted
Defined in
listr2/dist/index.d.ts:412
reportFailed()
protected
reportFailed():void
Returns
void
Inherited from
ListrPromptAdapter.reportFailed
Defined in
listr2/dist/index.d.ts:413
reportCompleted()
protected
reportCompleted():void
Returns
void
Inherited from
ListrPromptAdapter.reportCompleted
Defined in
listr2/dist/index.d.ts:414
restoreState()
protected
restoreState():void
Returns
void
Inherited from
ListrPromptAdapter.restoreState
Defined in
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
Defined in
prompt-adapter-inquirer/src/prompt.ts:17
cancel()
cancel():
void
Cancel the ongoing prompt.
Returns
void
Defined in
prompt-adapter-inquirer/src/prompt.ts:49