SelectOpts

Defined in: packages/prompt/src/prompts/select.ts:29

Options for select input.

Extends

• CoreOpts<T>

Extended by

• SearchOpts

Type Parameters

T

T

M

M extends boolean = false

Properties

clearPromptOnDone?

optional clearPromptOnDone?: boolean

Defined in: packages/prompt/src/core/index.ts:37

If the screen should be cleared when finishing a prompt.

Inherited from

CoreOpts.clearPromptOnDone

---

default?

optional default?: T

Defined in: packages/prompt/src/core/index.ts:24

The default value.

Inherited from

CoreOpts.default

---

initialIndex?

optional initialIndex?: number

Defined in: packages/prompt/src/prompts/select.ts:41

The initial option selected.

---

input?

optional input?: ReadStream

Defined in: packages/prompt/src/core/index.ts:29

The standard input. Defaults to process.stdin.

Inherited from

CoreOpts.input

---

message

message: string

Defined in: packages/prompt/src/core/index.ts:12

The message of the prompt.

Inherited from

CoreOpts.message

---

multiple?

optional multiple?: M

Defined in: packages/prompt/src/prompts/select.ts:37

If the user can select multiple options.

---

options

options: SelectOption<T>[]

Defined in: packages/prompt/src/prompts/select.ts:33

Every option the user can pick from.

---

output?

optional output?: WriteStream

Defined in: packages/prompt/src/core/index.ts:33

The standard output. Defaults to process.stdout.

Inherited from

CoreOpts.output

---

signal?

optional signal?: AbortSignal

Defined in: packages/prompt/src/core/index.ts:41

An AbortSignal to cancel the prompt.

Inherited from

CoreOpts.signal

---

theme?

optional theme?: Theme

Defined in: packages/prompt/src/core/index.ts:20

The theme of the prompt.

Inherited from

CoreOpts.theme

---

validate?

optional validate?: StandardSchemaV1<any, T> | ((value) => boolean | T)

Defined in: packages/prompt/src/core/index.ts:16

A validator function, or a Standard Schema validator.

Inherited from

CoreOpts.validate