ConfirmOpts

Defined in: packages/prompt/src/prompts/confirm.ts:6

Options for confirm input.

Extends

• CoreOpts<boolean>

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?: boolean

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

The default value.

Inherited from

CoreOpts.default

---

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

---

noLabel?

optional noLabel?: string

Defined in: packages/prompt/src/prompts/confirm.ts:14

What gets displayed for the No option.

---

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, boolean> | ((value) => boolean)

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

A validator function, or a Standard Schema validator.

Inherited from

CoreOpts.validate

---

yesLabel?

optional yesLabel?: string

Defined in: packages/prompt/src/prompts/confirm.ts:10

What gets displayed for the Yes option.