Interface PasswordOptions

packages/prompts/src/password.ts:9–33

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

	/**
	 * Character to use for masking input.
	 * @default ▪/•
	 */
	mask?: 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>;

	/**
	 * When enabled it causes the input to be cleared if/when validation fails.
	 * @default false
	 */
	clearOnError?: boolean;
}

/**
 * The password prompt behaves like the {@link text} prompt, but the input is masked.