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

v7.1.0-alpha.1

Published

Enhances Apollo Client for intuitive file uploads via GraphQL mutations.

Downloads

1

Readme

Apollo upload logo

apollo-upload-files

npm version Licence Github issues Github stars

Enhances Apollo for intuitive file uploads via GraphQL queries or mutations. Use with a GraphQL multipart request spec server implementation, Where multipart requests are supported and operationName, query and variables are expected as request body context at the backend.

Setup

Install with peer dependencies using npm:

npm install apollo-upload-files apollo-link

Initialize Apollo Client with this terminating link:

import { createUploadLink } from 'apollo-upload-files'

const link = createUploadLink(/* Options */)

Options

createUploadLink options match createHttpLink options:

  • includeExtensions (boolean): Toggles sending extensions fields to the GraphQL server. (default: false).
  • uri (string): GraphQL endpoint URI (default: /graphql).
  • credentials (string): Overrides fetchOptions.credentials.
  • headers (object): Merges with and overrides fetchOptions.headers.
  • fetchOptions (object): fetch init; overridden by upload requirements.
  • fetch (function): Fetch API to use (default: Global fetch).

Usage

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

Example

Consider a situation where you need to create a user and upload it's resume. following mutation is what you would give to the apollo instance.

mutation createUser ($username: String!, $password: String!)
{
  createUser(username: $username, password: $password)
  {
    user
    {
      id
    }
  }
}

And this is what you would give to mutate function as input.

apollo.mutate({
  mutation: CREATE_USER_MUTATION ,
  variables: {
    username: username,
    password: password,
    resume: userResumeFile
  }
})

As you can see it is only needed to provide the file (in this case our resume) to the 'variables' field of mutate input object, and not to the actual CREATE_USER_MUTATION constant itself.

It is possible to change the name of file/files in the request, you just need to replace 'resume' key in variables object in the mutate function (in the example given) with whatever you want.

the resume given to the mutate function can be an array of files, in this case for each file, an index is appended to the key of file (in this case 'resume') -> resume_1, resume_2, ... .

Support

  • Node.js v6.10+, see package.json engines.
  • Browsers >1% usage, see package.json browserslist.
  • Angular >= 2.
  • React Native.