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

    Whether to exclude results with missing or undefined properties.

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

    Array of result parsers that determine which types of results to extract.

    Each parser processes the HTML response and extracts specific result types. Using fewer parsers can improve performance.

    [OrganicResult] - Only organic results are parsed if not specified
    query: string

    The search query string to send to Google.

    requestConfig?: RequestOptions

    Custom HTTP request configuration for the search request.

    Accepts all standard Fetch API options (headers, method, signal, etc.) plus additional google-sr specific properties.

    requestConfig: {
    	signal: abortController.signal,
    	queryParams: { tbm: 'nws' }, // this is provided by google-sr
    }

    Settings

    Member Visibility

    On This Page

    Properties