listr2

Appearance

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

Interface: EnquirerPromptInstance ​

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:166

Extends ​

  • Omit<EnquirerBasePromptOptions, "onCancel" | "onSubmit">

Properties ​

message ​

message: string | (() => string) | (() => Promise<string>)

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:11

Inherited from ​

Omit.message

initial? ​

optional initial?: string | number | boolean | number[] | (() => string) | (() => Promise<string>)

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:12

Inherited from ​

Omit.initial

required? ​

optional required?: boolean

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

Inherited from ​

Omit.required

stdin? ​

optional stdin?: ReadStream

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:14

Inherited from ​

Omit.stdin

stdout? ​

optional stdout?: WriteStream

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:15

Inherited from ​

Omit.stdout

optional header?: string

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:16

Inherited from ​

Omit.header

optional footer?: string

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:17

Inherited from ​

Omit.footer

skip? ​

optional skip?: (value) => boolean | Promise<boolean>

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:18

Parameters ​

value ​

any

Returns ​

boolean | Promise<boolean>

Inherited from ​

Omit.skip

format? ​

optional format?: (value) => any

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:19

Parameters ​

value ​

any

Returns ​

any

Inherited from ​

Omit.format

result? ​

optional result?: (value) => any

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:20

Parameters ​

value ​

any

Returns ​

any

Inherited from ​

Omit.result

validate? ​

optional validate?: (value, state) => string | boolean | Promise<string> | Promise<boolean> | Promise<string | boolean>

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:21

Parameters ​

value ​

any

state ​

any

Returns ​

string | boolean | Promise<string> | Promise<boolean> | Promise<string | boolean>

Inherited from ​

Omit.validate

submit ​

submit: () => void

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:167

Returns ​

void

cancel ​

cancel: (err?) => void

Defined in: prompt-adapter-enquirer/src/prompt.interface.ts:168

Parameters ​

err? ​

string

Returns ​

void