Interface TextOptions

packages/prompts/src/text.ts:9–37

 * Options for the {@link text} prompt
 */
export interface TextOptions extends CommonOptions {
	/**
	 * The prompt message or question shown to the user above the input.
	 */
	message: string;

	/**
	 * A visual hint shown when the field has no content.
	 */
	placeholder?: string;

	/**
	 * A fallback value returned when the user provides nothing (empty input).
	 */
	defaultValue?: string;

	/**
	 * The starting value shown when the prompt first renders.
	 * Users can edit this value before submitting.
	 */
	initialValue?: string;

	/**
	 * A function or a [Standard Schema](https://github.com/standard-schema/standard-schema)
	 * that validates user input. If a custom function is given, you should return a `string` or `Error`
	 * to show as a validation error, or `undefined` to accept the result.
	 */
	validate?: Validate<string>;
}

/**
 * The text prompt accepts a single line of text.