gsr
    Preparing search index...

    Interface SearchOptionsWithPages<R, N>

    Configuration options for multi-page search.

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

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    delay? noPartialResults? pages parsers? query requestConfig?

    Properties

    delay?: number

    Delay between requests in milliseconds.

    Helps prevent rate limiting by spacing out requests. Set to 0 to disable delays (not recommended for production).

    1000 - 1 second delay between requests
    noPartialResults?: N

    Whether to exclude results with missing or undefined properties.

    false - Partial results are included.
    pages: number | number[]

    Specifies which pages to search.

    • Number: Total pages to search starting from page 1
    • Array: Specific page offsets to search (0 = page 1, 10 = page 2, etc.)

    Google uses cursor-based pagination with increments of 10.

    pages: 3        // Searches pages 1, 2, 3 (offsets: 0, 10, 20)
    pages: [0, 20]  // Searches pages 1 and 3 (offsets: 0, 20)
    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