CoreOpts
Defined in: packages/prompt/dist/core/index.d.mts:52
Base options for prompts.
Extended by
Section titled “Extended by”Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”clearPromptOnDone?
Section titled “clearPromptOnDone?”
optionalclearPromptOnDone?:boolean
Defined in: packages/prompt/dist/core/index.d.mts:80
If the screen should be cleared when finishing a prompt.
default?
Section titled “default?”
optionaldefault?:T
Defined in: packages/prompt/dist/core/index.d.mts:68
The default value.
input?
Section titled “input?”
optionalinput?:ReadStream
Defined in: packages/prompt/dist/core/index.d.mts:72
The standard input. Defaults to process.stdin.
message
Section titled “message”message:
string
Defined in: packages/prompt/dist/core/index.d.mts:56
The message of the prompt.
output?
Section titled “output?”
optionaloutput?:WriteStream
Defined in: packages/prompt/dist/core/index.d.mts:76
The standard output. Defaults to process.stdout.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/prompt/dist/core/index.d.mts:84
An AbortSignal to cancel the prompt.
theme?
Section titled “theme?”
optionaltheme?:Theme
Defined in: packages/prompt/dist/core/index.d.mts:64
The theme of the prompt.
validate?
Section titled “validate?”
optionalvalidate?:StandardSchemaV1<any,T> | ((value) =>boolean|T)
Defined in: packages/prompt/dist/core/index.d.mts:60
A validator function, or a Standard Schema validator.