npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

apollo-upload-client-robo

v14.1.5

Published

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.

Downloads

6

Readme

Apollo upload logo

apollo-upload-client

npm version CI status

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:

npm install apollo-upload-client

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 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.

FileList

import { gql, useMutation } from '@apollo/client';

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

function UploadFiles() {
  const [mutate] = useMutation(MUTATION);

  function onChange({ target: { validity, files } }) {
    if (validity.valid) mutate({ variables: { files } });
  }

  return <input type="file" multiple required onChange={onChange} />;
}

File

import { gql, useMutation } from '@apollo/client';

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

function UploadFile() {
  const [mutate] = useMutation(MUTATION);

  function onChange({
    target: {
      validity,
      files: [file],
    },
  }) {
    if (validity.valid) mutate({ variables: { file } });
  }

  return <input type="file" required onChange={onChange} />;
}

Blob

import { gql, useMutation } from '@apollo/client';

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

function UploadFile() {
  const [mutate] = useMutation(MUTATION);

  function onChange({ target: { validity, value } }) {
    if (validity.valid) {
      const file = new Blob([value], { type: 'text/plain' });

      // Optional, defaults to `blob`.
      file.name = 'text.txt';

      mutate({ variables: { file } });
    }
  }

  return <input type="text" required onChange={onChange} />;
}

Support

Consider polyfilling:

API

Table of contents

class ReactNativeFile

Used to mark React Native File substitutes as it’s too risky to assume all objects with uri, type and name properties are extractable files.

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

See

Examples

Ways to import.

import { ReactNativeFile } from 'apollo-upload-client';
import ReactNativeFile from 'apollo-upload-client/public/ReactNativeFile.js';

Ways to require.

const { ReactNativeFile } = require('apollo-upload-client');
const ReactNativeFile = require('apollo-upload-client/public/ReactNativeFile');

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

import { ReactNativeFile } from 'apollo-upload-client';

const file = new ReactNativeFile({
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg',
});

function createUploadLink

Creates a terminating Apollo Link capable of file uploads.

The link matches and extracts files in the GraphQL operation. If there are files it uses a FormData instance as the fetch options.body to make a GraphQL multipart request, otherwise it sends a regular POST request.

Some of the options are similar to the createHttpLink options.

| Parameter | Type | Description | | :-- | :-- | :-- | | options | object | Options. | | options.uri | string? = /graphql | GraphQL endpoint URI. | | options.useGETForQueries | boolean? | Should GET be used to fetch queries, if there are no files to upload. | | options.isExtractableFile | ExtractableFileMatcher? = isExtractableFile | Customizes how files are matched in the GraphQL operation for extraction. | | options.FormData | class? | FormData implementation to use, defaulting to the FormData global. | | options.formDataAppendFile | FormDataFileAppender? = formDataAppendFile | Customizes how extracted files are appended to the FormData instance. | | 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

Examples

Ways to import.

import { createUploadLink } from 'apollo-upload-client';
import createUploadLink from 'apollo-upload-client/public/createUploadLink.js';

Ways to require.

const { createUploadLink } = require('apollo-upload-client');
const createUploadLink = require('apollo-upload-client/public/createUploadLink');

A basic Apollo Client setup.

import { ApolloClient, InMemoryCache } from '@apollo/client';
import { createUploadLink } from 'apollo-upload-client';

const client = new ApolloClient({
  cache: new InMemoryCache(),
  link: createUploadLink(),
});

function formDataAppendFile

The default implementation for createUploadLink options.formDataAppendFile that uses the standard FormData.append method.

Type: FormDataFileAppender

| Parameter | Type | Description | | :-- | :-- | :-- | | formData | FormData | FormData instance to append the specified file to. | | fieldName | string | Field name for the file. | | file | * | File to append. |

Examples

Ways to import.

import { formDataAppendFile } from 'apollo-upload-client';
import formDataAppendFile from 'apollo-upload-client/public/formDataAppendFile.js';

Ways to require.

const { formDataAppendFile } = require('apollo-upload-client');
const formDataAppendFile = require('apollo-upload-client/public/formDataAppendFile');

function isExtractableFile

The default implementation for createUploadLink options.isExtractableFile.

Type: ExtractableFileMatcher

| Parameter | Type | Description | | :-------- | :--- | :-------------- | | value | * | Value to check. |

Returns: boolean — Is the value an extractable file.

See

Examples

Ways to import.

import { isExtractableFile } from 'apollo-upload-client';
import isExtractableFile from 'apollo-upload-client/public/isExtractableFile.js';

Ways to require.

const { isExtractableFile } = require('apollo-upload-client');
const isExtractableFile = require('apollo-upload-client/public/isExtractableFile');

type ExtractableFileMatcher

A function that checks if a value is an extractable file.

Type: Function

| Parameter | Type | Description | | :-------- | :--- | :-------------- | | value | * | Value to check. |

Returns: boolean — Is the value an extractable file.

See

Examples

How to check for the default exactable files, as well as a custom type of file.

import { isExtractableFile } from 'apollo-upload-client';

const isExtractableFileEnhanced = (value) =>
  isExtractableFile(value) ||
  (typeof CustomFile !== 'undefined' && value instanceof CustomFile);

type FetchOptions

GraphQL request fetch options.

Type: object

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

See


type FormDataFileAppender

Appends a file extracted from the GraphQL operation to the FormData instance used as the fetch options.body for the GraphQL multipart request.

| Parameter | Type | Description | | :-- | :-- | :-- | | formData | FormData | FormData instance to append the specified file to. | | fieldName | string | Field name for the file. | | file | * | File to append. The file type depends on what the ExtractableFileMatcher extracts. |

See


type ReactNativeFileSubstitute

A React Native File substitute.

Be aware that inspecting network traffic with buggy versions of dev tools such as Flipper can interfere with the React Native FormData implementation, causing multipart requests to have 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

Examples

A camera roll file.

const fileSubstitute = {
  uri: uriFromCameraRoll,
  name: 'a.jpg',
  type: 'image/jpeg',
};