apollo-upload-client

A terminating Apollo Link for Apollo Client that fetches a GraphQL multipart request if the GraphQL variables contain files (by default FileList, File, or Blob instances), or else fetches a regular GraphQL POST or GET request (depending on the config and GraphQL operation).

• Installation
• Examples
• Requirements
• Exports

Installation

To install with npm, run:

1npm install apollo-upload-client

Polyfill any required globals (see Requirements) that are missing in your server and client environments.

Remove any uri, credentials, or headers options from the ApolloClient constructor.

Apollo Client can only have 1 terminating Apollo Link that sends the GraphQL requests; if one such as HttpLink is already setup, remove it.

Initialize the client with a terminating Apollo Link using the function createUploadLink.

Also ensure the GraphQL server implements the GraphQL multipart request spec and that uploads are handled correctly in resolvers.

Examples

Use FileList, File, or Blob instances anywhere within query or mutation variables to send a GraphQL multipart request.

See also the example API and client.

FileList

1import { gql, useMutation } from "@apollo/client";
2
3const MUTATION = gql`
4  mutation ($files: [Upload!]!) {
5    uploadFiles(files: $files) {
6      success
7    }
8  }
9`;
10
11function UploadFiles() {
12  const [mutate] = useMutation(MUTATION);
13
14  return (
15    <input
16      type="file"
17      multiple
18      required
19      onChange={({ target: { validity, files } }) => {
20        if (validity.valid)
21          mutate({
22            variables: {
23              files,
24            },
25          });
26      }}
27    />
28  );
29}

File

1import { gql, useMutation } from "@apollo/client";
2
3const MUTATION = gql`
4  mutation ($file: Upload!) {
5    uploadFile(file: $file) {
6      success
7    }
8  }
9`;
10
11function UploadFile() {
12  const [mutate] = useMutation(MUTATION);
13
14  return (
15    <input
16      type="file"
17      required
18      onChange={({
19        target: {
20          validity,
21          files: [file],
22        },
23      }) => {
24        if (validity.valid)
25          mutate({
26            variables: {
27              file,
28            },
29          });
30      }}
31    />
32  );
33}

Blob

1import { gql, useMutation } from "@apollo/client";
2
3const MUTATION = gql`
4  mutation ($file: Upload!) {
5    uploadFile(file: $file) {
6      success
7    }
8  }
9`;
10
11function UploadFile() {
12  const [mutate] = useMutation(MUTATION);
13
14  return (
15    <input
16      type="text"
17      required
18      onChange={({ target: { validity, value } }) => {
19        if (validity.valid) {
20          const file = new Blob([value], { type: "text/plain" });
21
22          // Optional, defaults to `blob`.
23          file.name = "text.txt";
24
25          mutate({
26            variables: {
27              file,
28            },
29          });
30        }
31      }}
32    />
33  );
34}

Requirements

• Node.js versions ^18.15.0 || >=20.4.0.
• Browsers matching the Browserslist query > 0.5%, not OperaMini all, not dead.

Consider polyfilling:

• AbortController
• fetch
• FormData

Projects must configure TypeScript to use types from the ECMAScript modules that have a // @ts-check comment:

• compilerOptions.allowJs should be true.
• compilerOptions.maxNodeModuleJsDepth should be reasonably large, e.g. 10.
• compilerOptions.module should be "node16" or "nodenext".

Exports

The npm package apollo-upload-client features optimal JavaScript module design. It doesn’t have a main index module, so use deep imports from the ECMAScript modules that are exported via the package.json field exports:

• createUploadLink.mjs
• formDataAppendFile.mjs
• isExtractableFile.mjs