Interface SearchOptions<R>

Search options for single page search

interface SearchOptions<R extends ResultSelector = ResultSelector> {
    query: string;
    requestConfig?: AxiosRequestConfig<any>;
    resultTypes?: R[];
    strictSelector?: boolean;
}

Type Parameters

R extends ResultSelector = ResultSelector

Hierarchy (View Summary)

SearchOptions
- SearchOptionsWithPages

Index

Properties

query requestConfig? resultTypes? strictSelector?

Properties

query

query: string

Search query

`Optional`requestConfig

requestConfig?: AxiosRequestConfig<any>

Custom request configuration to be sent with the request

`Optional`resultTypes

resultTypes?: R[]

Control the type of results returned (can have a significant performance impact)

`Optional`strictSelector

strictSelector?: boolean

when true, will only return resultNodes that do not contain any undefined/empty properties