Interface: BooleanPromptOptions

Hierarchy#

• Optional default: WithPromptState<boolean>

Default value for the prompt

• Optional format: (value: string, state: PromptState) => Promise<string> | string

Function to format user input in the terminal.

• message: string

The message to display when the prompt is rendered in the terminal.

• name: string

Used as the key for the answer on the returned values (answers) object.

• Optional result: (value: string, state: PromptState) => any

Function to format the final submitted value before it's returned.

• Optional skip: (state: PromptState, value: any) => boolean

Skip the prompt when returns true

• Optional store: boolean

Store the prompt answer in order to reuse it as default value the next time Defaults to false

• type: confirm

• Optional validate: (value: string, state: PromptState) => boolean | string

Function to validate the submitted value before it's returned.

This function may return a boolean or a string. If a string is returned it will be used as the validation error message.