Interface RenderAutocompleteOptions<T>

interface RenderAutocompleteOptions<T> {
    abortSignal?: AbortSignal;
    choices: Item<T>[];
    hasMorePages?: boolean;
    infoMessage?: {
        body: TokenItem;
        title: {
            color?: LiteralUnion<(keyof ForegroundColor), string>;
            text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
        };
    };
    infoTable?: {
        [header: string]: Items;
    } | InfoTableSection[];
    message: Message;
    renderOptions?: RenderOptions;
    search?: ((term) => Promise<SearchResults<T>>);
}

Type Parameters

  • T

Hierarchy

  • PartialBy<Omit<AutocompletePromptProps<T>, "onSubmit">, "search">
    • RenderAutocompleteOptions

Properties

abortSignal? choices hasMorePages? infoMessage? infoTable? message renderOptions? search?

Properties

Optional abortSignal

abortSignal?: AbortSignal

choices

choices: Item<T>[]

Optional hasMorePages

hasMorePages?: boolean

Optional infoMessage

infoMessage?: {
    body: TokenItem;
    title: {
        color?: LiteralUnion<(keyof ForegroundColor), string>;
        text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
    };
}

Type declaration

  • body: TokenItem
  • title: {
        color?: LiteralUnion<(keyof ForegroundColor), string>;
        text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>;
    }
    • Optional color?: LiteralUnion<(keyof ForegroundColor), string>
    • text: TokenItem<string | CommandToken | CharToken | SubduedToken | FilePathToken | BoldToken | InfoToken | WarnToken | ErrorToken>

Optional infoTable

infoTable?: {
    [header: string]: Items;
} | InfoTableSection[]

Type declaration

  • [header: string]: Items

message

message: Message

Optional renderOptions

renderOptions?: RenderOptions

Optional search

search?: ((term) => Promise<SearchResults<T>>)

Type declaration

    • (term): Promise<SearchResults<T>>

    • Parameters

      • term: string

      Returns Promise<SearchResults<T>>

Settings

Member Visibility

Theme

On This Page

abortSignalchoiceshasMorePagesinfoMessageinfoTablemessagerenderOptionssearch