EditorOpts
Defined in: packages/prompt/dist/index.d.mts:125
Options for opening the system editor.
Extends
Section titled “Extends”CoreOpts<string>
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.
Inherited from
Section titled “Inherited from”default?
Section titled “default?”
optionaldefault?:string
Defined in: packages/prompt/dist/core/index.d.mts:68
The default value.
Inherited from
Section titled “Inherited from”inline?
Section titled “inline?”
optionalinline?:boolean
Defined in: packages/prompt/dist/index.d.mts:133
If editing should be inline. Omit or set to false to open the default editor.
input?
Section titled “input?”
optionalinput?:ReadStream
Defined in: packages/prompt/dist/core/index.d.mts:72
The standard input. Defaults to process.stdin.
Inherited from
Section titled “Inherited from”message
Section titled “message”message:
string
Defined in: packages/prompt/dist/core/index.d.mts:56
The message of the prompt.
Inherited from
Section titled “Inherited from”output?
Section titled “output?”
optionaloutput?:WriteStream
Defined in: packages/prompt/dist/core/index.d.mts:76
The standard output. Defaults to process.stdout.
Inherited from
Section titled “Inherited from”required?
Section titled “required?”
optionalrequired?:boolean
Defined in: packages/prompt/dist/index.d.mts:129
If the input is required for continuing or not.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/prompt/dist/core/index.d.mts:84
An AbortSignal to cancel the prompt.
Inherited from
Section titled “Inherited from”theme?
Section titled “theme?”
optionaltheme?:Theme
Defined in: packages/prompt/dist/core/index.d.mts:64
The theme of the prompt.
Inherited from
Section titled “Inherited from”validate?
Section titled “validate?”
optionalvalidate?:StandardSchemaV1<any,string> | ((value) =>string|boolean)
Defined in: packages/prompt/dist/core/index.d.mts:60
A validator function, or a Standard Schema validator.