Back to Apollo Client

Api Report Link Batch.Api

.api-reports/api-report-link_batch.api.md

3.14.11.1 KB
Original Source

API Report File for "@apollo/client"

Do not edit this file. It is a report generated by API Extractor.

ts

import { ApolloLink } from '@apollo/client/link';
import type { Observable } from 'rxjs';

// @public (undocumented)
export namespace BatchLink {
    export type BatchHandler = (operations: ApolloLink.Operation[], forward: ApolloLink.ForwardFunction[]) => Observable<ApolloLink.Result[]>;
    export interface Options extends Shared.Options {
        batchHandler?: BatchLink.BatchHandler;
        batchMax?: number;
    }
    // (undocumented)
    export namespace Shared {
        export interface Options {
            batchDebounce?: boolean;
            batchInterval?: number;
            batchKey?: (operation: ApolloLink.Operation) => string;
            batchMax?: number;
        }
    }
}

// @public
export class BatchLink extends ApolloLink {
    constructor(options?: BatchLink.Options);
    // (undocumented)
    request(operation: ApolloLink.Operation, forward: ApolloLink.ForwardFunction): Observable<ApolloLink.Result>;
}

// (No @packageDocumentation comment for this package)