Skip to content

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

Interface: EnquirerPromptInstance

Extends

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

Properties

message

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

Inherited from

Omit.message

Source

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


initial?

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

Inherited from

Omit.initial

Source

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


required?

optional required: boolean

Inherited from

Omit.required

Source

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


stdin?

optional stdin: ReadStream

Inherited from

Omit.stdin

Source

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


stdout?

optional stdout: WriteStream

Inherited from

Omit.stdout

Source

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


optional header: string

Inherited from

Omit.header

Source

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


optional footer: string

Inherited from

Omit.footer

Source

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


skip()?

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

Parameters

value: any

Returns

boolean | Promise<boolean>

Inherited from

Omit.skip

Source

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


format()?

optional format: (value) => any

Parameters

value: any

Returns

any

Inherited from

Omit.format

Source

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


result()?

optional result: (value) => any

Parameters

value: any

Returns

any

Inherited from

Omit.result

Source

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


validate()?

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

Parameters

value: any

state: any

Returns

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

Inherited from

Omit.validate

Source

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


submit()

submit: () => void

Returns

void

Source

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


cancel()

cancel: (err?) => void

Parameters

err?: string

Returns

void

Source

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