Interface: ArrayPromptOptions

Hierarchy#

Properties#

align#

• Optional align: left | right

Defined in: src/utils/prompt.ts:80

choices#

• choices: WithPromptState<string[] | Choice[]>

Defined in: src/utils/prompt.ts:68

default#

• Optional default: WithPromptState<string>

Default value for the prompt

Defined in: src/utils/prompt.ts:74

delay#

• Optional delay: number

Defined in: src/utils/prompt.ts:75

edgeLength#

• Optional edgeLength: number

Defined in: src/utils/prompt.ts:79

format#

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

Function to format user input in the terminal.

Inherited from: BasePromptOptions.format

Defined in: src/utils/prompt.ts:40

linebreak#

• Optional linebreak: boolean

Defined in: src/utils/prompt.ts:78

maxChoices#

• Optional maxChoices: number

Maxium number of options to select

Defined in: src/utils/prompt.ts:70

message#

• message: string

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

Inherited from: BasePromptOptions.message

Defined in: src/utils/prompt.ts:24

muliple#

• Optional muliple: boolean

Allow to select multiple options

Defined in: src/utils/prompt.ts:72

name#

• name: string

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

Inherited from: BasePromptOptions.name

Defined in: src/utils/prompt.ts:20

result#

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

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

Inherited from: BasePromptOptions.result

Defined in: src/utils/prompt.ts:36

scroll#

• Optional scroll: boolean

Make the options scrollable via arrow keys

Defined in: src/utils/prompt.ts:82

separator#

• Optional separator: boolean

Defined in: src/utils/prompt.ts:76

skip#

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

Skip the prompt when returns true

Inherited from: BasePromptOptions.skip

Defined in: src/utils/prompt.ts:26

sort#

• Optional sort: boolean

Defined in: src/utils/prompt.ts:77

store#

• Optional store: boolean

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

Inherited from: BasePromptOptions.store

Defined in: src/utils/prompt.ts:45

type#

• type: autocomplete | editable | form | multiselect | select | survey | list | scale

Defined in: src/utils/prompt.ts:59

validate#

• 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.

Inherited from: BasePromptOptions.validate

Defined in: src/utils/prompt.ts:32

Edit this page