Skip to content
Convoker

search

search<T, M>(opts): Promise<M extends true ? T[] : T>

Defined in: packages/prompt/src/prompts/search.ts:43

Prompts the user to search through a list of options.

Type Parameters

Section titled “Type Parameters”

T

Section titled “T”

T

M

Section titled “M”

M extends boolean = false

Parameters

Section titled “Parameters”

opts

Section titled “opts”

SearchOpts<T, M>

Options for search input.

Returns

Section titled “Returns”

Promise<M extends true ? T[] : T>

The selected option.