Interface DateOptions

packages/prompts/src/date.ts:11–57

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

	/**
	 * The date format for the input segments.
	 * @deafult based on locale
	 */
	format?: DateFormat;

	/**
	 * The BCP 47 language tag to use for formatting
	 * @see https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag
	 * @example "en-GB"
	 */
	locale?: string;

	/**
	 * The default value returned when the user doesn't select a date.
	 */
	defaultValue?: Date;

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

	/**
	 * The minimum allowed date for validation.
	 */
	minDate?: Date;

	/**
	 * The maximum allowed date for validation.
	 */
	maxDate?: Date;

	/**
	 * 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<Date>;
}

/**
 * The `date` prompt provides an interactive date picker, allowing users