TextOpts
Defined in: packages/prompt/src/prompts/text.ts:7
Options for text input.
Extends
Section titled “Extends”CoreOpts<string>
Extended by
Section titled “Extended by”Properties
Section titled “Properties”clearPromptOnDone?
Section titled “clearPromptOnDone?”
optionalclearPromptOnDone?:boolean
Defined in: packages/prompt/src/core/index.ts:37
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/src/core/index.ts:24
The default value.
Inherited from
Section titled “Inherited from”input?
Section titled “input?”
optionalinput?:ReadStream
Defined in: packages/prompt/src/core/index.ts:29
The standard input. Defaults to process.stdin.
Inherited from
Section titled “Inherited from”maxLength?
Section titled “maxLength?”
optionalmaxLength?:number
Defined in: packages/prompt/src/prompts/text.ts:10
message
Section titled “message”message:
string
Defined in: packages/prompt/src/core/index.ts:12
The message of the prompt.
Inherited from
Section titled “Inherited from”minLength?
Section titled “minLength?”
optionalminLength?:number
Defined in: packages/prompt/src/prompts/text.ts:9
output?
Section titled “output?”
optionaloutput?:WriteStream
Defined in: packages/prompt/src/core/index.ts:33
The standard output. Defaults to process.stdout.
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: packages/prompt/src/prompts/text.ts:8
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/prompt/src/core/index.ts:41
An AbortSignal to cancel the prompt.
Inherited from
Section titled “Inherited from”theme?
Section titled “theme?”
optionaltheme?:Theme
Defined in: packages/prompt/src/core/index.ts:20
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/src/core/index.ts:16
A validator function, or a Standard Schema validator.