Interface RenderTextPromptOptions

interface RenderTextPromptOptions {
    abortSignal?: AbortSignal;
    allowEmpty?: boolean;
    defaultValue?: string;
    emptyDisplayedValue?: string;
    initialAnswer?: string;
    message: TokenItem;
    password?: boolean;
    preview?: (value: string) => TokenItem<InlineToken>;
    renderOptions?: RenderOptions;
    validate?: (value: string) => undefined | string;
}

Hierarchy

Omit<TextPromptProps, "onSubmit">
- RenderTextPromptOptions

Index

Properties

abortSignal? allowEmpty? defaultValue? emptyDisplayedValue? initialAnswer? message password? preview? renderOptions? validate?

Properties

`Optional`abortSignal

abortSignal?: AbortSignal

`Optional`allowEmpty

allowEmpty?: boolean

`Optional`defaultValue

defaultValue?: string

`Optional`emptyDisplayedValue

emptyDisplayedValue?: string

`Optional`initialAnswer

initialAnswer?: string

message

message: TokenItem

`Optional`password

password?: boolean

`Optional`preview

preview?: (value: string) => TokenItem<InlineToken>

`Optional`renderOptions

renderOptions?: RenderOptions

`Optional`validate

validate?: (value: string) => undefined | string