gsr
    Preparing search index...

    Interface SearchOptions<R, N>

    Search options for single page search

    interface SearchOptions<
        R extends ResultParser = ResultParser,
        N extends boolean = false,
    > {
        noPartialResults?: N;
        parsers?: R[];
        query: string;
        requestConfig?: RequestOptions;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    noPartialResults? parsers? query requestConfig?

    Properties

    noPartialResults?: N

    When true, excludes results that have undefined or empty properties.

    false - Partial results are included.
    parsers?: R[]

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

    query: string

    Search query

    requestConfig?: RequestOptions

    Custom request configuration to be sent with the request

    Settings

    Member Visibility

    On This Page

    Properties