https://github.com/huangang/fastify-file-upload

Fastify plugin for uploading files
https://github.com/huangang/fastify-file-upload

fastify fastify-plugin fastifyjs-plugin file-upload

Last synced: 3 days ago
JSON representation

Fastify plugin for uploading files

• Host: GitHub
• URL: https://github.com/huangang/fastify-file-upload
• Owner: huangang
• Created: 2018-03-02T09:25:55.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-22T20:12:12.000Z (about 1 year ago)
• Last Synced: 2024-10-16T11:02:28.621Z (2 months ago)
• Topics: fastify, fastify-plugin, fastifyjs-plugin, file-upload
• Language: JavaScript
• Homepage:
• Size: 21.5 KB
• Stars: 73
• Watchers: 1
• Forks: 11
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# fastify-file-upload

Fastify plugin to upload file.

[![Build Status](https://travis-ci.org/huangang/fastify-file-upload.svg?branch=master)](https://travis-ci.org/huangang/fastify-file-upload)

[![NPM version](https://img.shields.io/npm/v/fastify-file-upload.svg?style=flat)](https://www.npmjs.com/package/fastify-file-upload)

__Note: the v3.x series of this module covers Fastify v3. For Fastify v2 support refert to the v2.x series.__

## Install

```

npm i fastify-file-upload --save

```

## Usage

```js

'use strict'

const fastify = require('fastify')()

const fileUpload = require('fastify-file-upload')

fastify.register(fileUpload)

fastify.post('/upload', function (req, reply) {

  // some code to handle file

  const files = req.raw.files

  console.log(files)

  let fileArr = []

  for(let key in files){

    fileArr.push({

      name: files[key].name,

      mimetype: files[key].mimetype

    })

  }

  reply.send(fileArr)

})

fastify.listen(3000, err => {

  if (err) throw err

  console.log(`server listening on ${fastify.server.address().port}`)

})

```

## Use Schema Demo (fastify version >= 2)

``` js

fastify.post('/uploadSchema', {

  schema: {

    summary: 'upload file',

    body: {

      type: 'object',

      properties: {

        file: { type: 'object' }

      },

      required: ['file']

    }

  },

  handler: (request, reply) => {

    const file = request.body.file

    console.log(file)

    reply.send({ file })

  }

})

```

## Using Busboy Options

```js

fastify.register(fileUpload, {

  limits: { fileSize: 50 * 1024 * 1024 },

});

```

### [Available Options](https://github.com/richardgirges/express-fileupload#available-options)