Interface PromptOptions

packages/core/src/prompts/prompt.ts:19–33

import { runValidation } from '../utils/validation.js';

export interface PromptOptions<TValue, Self extends Prompt<TValue>> {
	render(this: Omit<Self, 'prompt'>): string | undefined;
	initialValue?: any;
	initialUserInput?: 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<TValue> | undefined;
	input?: Readable;
	output?: Writable;
	signal?: AbortSignal;
}

export default class Prompt<TValue> {
	protected input: Readable;