Interface RenderTextPromptOptions

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

Type declaration

- (value): TokenItem<InlineToken>
- Parameters
  - value: string
  Returns TokenItem<InlineToken>

`Optional` renderOptions

renderOptions?: RenderOptions

`Optional` validate

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

Type declaration

- (value): undefined | string
- Parameters
  - value: string
  Returns undefined | string