SearchOpts
Defined in: packages/prompt/src/prompts/search.ts:12
Options for search input.
Extends
Section titled “Extends”SelectOpts<T,M>
Type Parameters
Section titled “Type Parameters”T
M extends boolean = false
Q = string
Properties
Section titled “Properties”clearPromptOnDone?
Section titled “clearPromptOnDone?”
optionalclearPromptOnDone?:boolean
Defined in: packages/prompt/src/core/index.ts:37
If the screen should be cleared when finishing a prompt.
Inherited from
Section titled “Inherited from”default?
Section titled “default?”
optionaldefault?:T
Defined in: packages/prompt/src/core/index.ts:24
The default value.
Inherited from
Section titled “Inherited from”initialIndex?
Section titled “initialIndex?”
optionalinitialIndex?:number
Defined in: packages/prompt/src/prompts/select.ts:41
The initial option selected.
Inherited from
Section titled “Inherited from”input?
Section titled “input?”
optionalinput?:ReadStream
Defined in: packages/prompt/src/core/index.ts:29
The standard input. Defaults to process.stdin.
Inherited from
Section titled “Inherited from”message
Section titled “message”message:
string
Defined in: packages/prompt/src/core/index.ts:12
The message of the prompt.
Inherited from
Section titled “Inherited from”minQueryLength?
Section titled “minQueryLength?”
optionalminQueryLength?:number
Defined in: packages/prompt/src/prompts/search.ts:24
Minimum length for a query string.
multiple?
Section titled “multiple?”
optionalmultiple?:M
Defined in: packages/prompt/src/prompts/select.ts:37
If the user can select multiple options.
Inherited from
Section titled “Inherited from”options
Section titled “options”options:
SelectOption<T>[]
Defined in: packages/prompt/src/prompts/select.ts:33
Every option the user can pick from.
Inherited from
Section titled “Inherited from”output?
Section titled “output?”
optionaloutput?:WriteStream
Defined in: packages/prompt/src/core/index.ts:33
The standard output. Defaults to process.stdout.
Inherited from
Section titled “Inherited from”placeholder?
Section titled “placeholder?”
optionalplaceholder?:string
Defined in: packages/prompt/src/prompts/search.ts:20
Placeholder for the search input.
signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: packages/prompt/src/core/index.ts:41
An AbortSignal to cancel the prompt.
Inherited from
Section titled “Inherited from”theme?
Section titled “theme?”
optionaltheme?:Theme
Defined in: packages/prompt/src/core/index.ts:20
The theme of the prompt.
Inherited from
Section titled “Inherited from”validate?
Section titled “validate?”
optionalvalidate?:StandardSchemaV1<any,T> | ((value) =>boolean|T)
Defined in: packages/prompt/src/core/index.ts:16
A validator function, or a Standard Schema validator.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”filter()?
Section titled “filter()?”
optionalfilter(query,option):boolean
Defined in: packages/prompt/src/prompts/search.ts:35
Filters a single option.
Parameters
Section titled “Parameters”Q
The search query.
option
Section titled “option”SelectOption<T>
The option to filter.
Returns
Section titled “Returns”boolean
transformQuery()?
Section titled “transformQuery()?”
optionaltransformQuery(query):Q
Defined in: packages/prompt/src/prompts/search.ts:29
Transforms a query before running filter functions.
Parameters
Section titled “Parameters”string
The query.
Returns
Section titled “Returns”Q