Batch Link

Purpose

An Apollo Link to allow batching of multiple operations into a single request. For example, the apollo-link-batch-http uses this link to batch operations into a single http request.

Installation

npm install apollo-link-batch --save

Usage

import { BatchLink } from "apollo-link-batch";

const link = new BatchLink({
  batchHandler: (operations: Operation[], forward: NextLink) => Observable<FetchResult[]> | null
});

Options

Batch Link takes an object with three options on it to customize the behavior of the link. The only required option is the batchHandler function

name	value	default	required
batchInterval	number	10	false
batchMax	number	0	false
batchHandler	(operations: Operation[], forward: NextLink) => Observable<FetchResult[]>	null	NA

Context

The Batch Link does not use the context for anything

Current Tags

2.0.0-beta.0 ... beta (6 years ago)
1.1.15 ... latest (6 years ago)