Interface ReadOptions<T>

interface ReadOptions<T> {
    completer?: Completer | AsyncCompleter;
    default?: T;
    edit?: boolean;
    input?: ReadableStream & {
        isTTY?: boolean;
    };
    output?: WritableStream & {
        isTTY?: boolean;
    };
    prompt?: string;
    replace?: string;
    silent?: boolean;
    terminal?: boolean;
    timeout?: number;
}

Type Parameters

  • T extends string | number = string

Properties

completer? default? edit? input? output? prompt? replace? silent? terminal? timeout?

Properties

Optionalcompleter

completer?: Completer | AsyncCompleter

Optionaldefault

default?: T

Optionaledit

edit?: boolean

Optionalinput

input?: ReadableStream & {
    isTTY?: boolean;
}

Optionaloutput

output?: WritableStream & {
    isTTY?: boolean;
}

Optionalprompt

prompt?: string

Optionalreplace

replace?: string

Optionalsilent

silent?: boolean

Optionalterminal

terminal?: boolean

Optionaltimeout

timeout?: number

Settings

Member Visibility

On This Page

Properties