Interface PathOptions

packages/prompts/src/path.ts:11–43

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

	/**
	 * The starting directory for path suggestions (defaults to current working directory).
	 */
	root?: string;

	/**
	 * When `true` only **directories** appear in suggestions while you navigate.
	 */
	directory?: boolean;

	/**
	 * The starting path shown when the prompt first renders, which users can edit
	 * before submitting. If not provided it will fall back to the given `root`,
	 * or the current working directory.
	 *
	 * In `directory` mode, if the initial value points to a directory that exists,
	 * pressing enter will submit the input instead of jumping to the first child.
	 */
	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 `path` prompt extends `autocomplete` to provide file and directory suggestions.