Interface SearchOptions

The query options.

interface SearchOptions {
    node?: NodeIdentifier;
    params?: Record<string, string>;
    query: string;
    requester?: unknown;
    source?: SearchSource | SourceName;
}

Hierarchy (View Summary)

SearchQuery
- SearchOptions

Index

Properties

node? params? query requester? source?

Properties

`Optional`node

node?: NodeIdentifier

The node or the node id to make the query.

`Optional`params

params?: Record<string, string>

The search params to use.

query

query: string

The query to search for.

`Optional`requester

requester?: unknown

The requester of the query.

`Optional`source

source?: SearchSource | SourceName

The search source to use.