!Apollo upload logo

apollo-upload-client

 

A terminating Apollo Link for Apollo Client that allows FileList, File, Blob or ReactNativeFile instances within query or mutation variables and sends GraphQL multipart requests.

Setup

Install with npm:

``shell
npm install apollo-upload-client
`

Apollo Boost doesn’t allow link customization; if you are using it migrate to a manual Apollo Client setup.

Apollo Client can only have 1 “terminating” Apollo Link that sends the GraphQL requests; if one such as apollo-link-http is already setup, remove it.

Initialize the client with a terminating link using createUploadLink.

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

Usage

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

See also the example API and client.

$3

`jsx
const { useMutation } = require('@apollo/react-hooks')
const gql = require('graphql-tag')

const MUTATION = gql
mutation($files: [Upload!]!) {
uploadFiles(files: $files) {
success
}
}

const UploadFile = () => {
const [mutate] = useMutation(MUTATION)
const onChange = ({ target: { validity, files } }) =>
validity.valid && mutate({ variables: { files } })

return
}
`

$3

`jsx
const { useMutation } = require('@apollo/react-hooks')
const gql = require('graphql-tag')

const MUTATION = gql
mutation($file: Upload!) {
uploadFile(file: $file) {
success
}
}

const UploadFile = () => {
const [mutate] = useMutation(MUTATION)
const onChange = ({
target: {
validity,
files: [file]
}
}) => validity.valid && mutate({ variables: { file } })

return
}
`

$3

`jsx
const gql = require('graphql-tag')

// Apollo Client instance.
const client = require('./client')

const file = new Blob(['Foo.'], { type: 'text/plain' })

// Optional, defaults to blob.
file.name = 'bar.txt'

client.mutate({
mutation: gql
mutation($file: Upload!) {
uploadFile(file: $file) {
success
}
}
,
variables: { file }
})
`

Support

- Node.js v8.10+
- Browsers > 0.5%, not OperaMini all, not dead
- React Native

Consider polyfilling:

- Promise
- fetch
- FormData

API

$3

- class ReactNativeFile
- function createUploadLink
- type FetchOptions
- type ReactNativeFileSubstitute

$3

Used to mark a React Native File substitute. It’s too risky to assume all objects with uri, type and name properties are files to extract. Re-exported from extract-files for convenience.

| Parameter | Type | Description |
| :-- | :-- | :-- |
| file | ReactNativeFileSubstitute | A React Native File substitute. |

#### Examples

_A React Native file that can be used in query or mutation variables._

> `js
> const { ReactNativeFile } = require('apollo-upload-client')
>
> const file = new ReactNativeFile({
> uri: uriFromCameraRoll,
> name: 'a.jpg',
> type: 'image/jpeg'
> })
> `

---

$3

Creates a terminating Apollo Link capable of file uploads. Options match createHttpLink.

| Parameter | Type | Description |
| :-- | :-- | :-- |
| options | object | Options. |
| options.uri | string? = /graphql | GraphQL endpoint URI. |
| options.fetch | Function? | fetch implementation to use, defaulting to the fetch global. |
| options.fetchOptions | FetchOptions? | fetch options; overridden by upload requirements. |
| options.credentials | string? | Overrides options.fetchOptions.credentials. |
| options.headers | object? | Merges with and overrides options.fetchOptions.headers. |
| options.includeExtensions | boolean? = false | Toggles sending extensions fields to the GraphQL server. |

Returns: ApolloLink — A terminating Apollo Link capable of file uploads.

#### See

- GraphQL multipart request spec.
- apollo-link on GitHub.

#### Examples

_A basic Apollo Client setup._

> `js
> const { ApolloClient, InMemoryCache } = require('@apollo/client)
> const { createUploadLink } = require('apollo-upload-client')
>
> const client = new ApolloClient({
> cache: new InMemoryCache(),
> link: createUploadLink()
> })
> `

---

$3

GraphQL request fetch options.

Type: object

| Property | Type | Description |
| :------------ | :------ | :------------------------------- |
| headers | object | HTTP request headers. |
| credentials | string? | Authentication credentials mode. |

#### See

- Polyfillable fetch options.

---

$3

A React Native File substitute.

Be aware that inspecting network requests with Chrome dev tools interferes with the React Native FormData implementation, causing network errors.

Type: object

| Property | Type | Description |
| :-- | :-- | :-- |
| uri | string | Filesystem path. |
| name | string? | File name. |
| type | string? | File content type. Some environments (particularly Android) require a valid MIME type; Expo ImageResult.type is unreliable as it can be just image. |

#### See

- extract-files docs.
- React Native FormData polyfill source.

#### Examples

_A camera roll file._

> `js
> {
> uri: uriFromCameraRoll,
> name: 'a.jpg',
> type: 'image/jpeg'
> }
> ``