graphql-fastify-upload

graphql-upload-ts implementation plugin for Fastify & mercurius.

Plugin made for Fastify v4^:

Install

1yarn add graphql-fastify-upload
2# or
3npm i graphql-fastify-upload
4# or
5pnpm add graphql-fastify-upload

Usage

Plugin options should conform to https://github.com/flash-oss/graphql-upload-minimal#type-processrequestoptions

1fastify.register(require('graphql-fastify-upload'), {
2  // options passed to processRequest from graphql-upload-minimal
3  // maxFileSize: 1024 * 1024 * 5,
4  // maxFiles: 1,
5})

or

1import MercuriusGQLUpload from 'graphql-fastify-upload'
2
3// ...
4
5fastify.register(MercuriusGQLUpload, {
6  // options passed to processRequest from graphql-upload-minimal
7})

Example

1const GQL = require('mercurius')
2const { GraphQLUpload } = require('graphql-upload-ts')
3const fs = require('fs')
4const util = require('util')
5const stream = require('stream')
6const path = require('path')
7
8const pipeline = util.promisify(stream.pipeline)
9const uploadsDir = path.resolve(__dirname, '../uploads')
10
11const schema = /* GraphQL */ `
12  scalar Upload
13
14  type Query {
15    add(x: Int, y: Int): Int
16  }
17
18  type Mutation {
19    uploadImage(image: Upload): Boolean
20  }
21`
22
23const resolvers = {
24  Upload: GraphQLUpload,
25  Query: {
26    add: async (_, { x, y }) => {
27      return x + y
28    },
29  },
30  Mutation: {
31    uploadImage: async (_, { image }) => {
32      const { filename, createReadStream } = await image
33      const rs = createReadStream()
34      const ws = fs.createWriteStream(path.join(uploadsDir, filename))
35      await pipeline(rs, ws)
36      return true
37    },
38  },
39}
40
41module.exports = function (fastify, options, done) {
42  fastify.register(require('mercurius-upload'))
43
44  fastify.register(GQL, {
45    schema,
46    resolvers,
47    graphiql: true,
48  })
49
50  done()
51}