@kakang/fastify-multipart
v2.0.0
Published
[![Continuous Integration](https://github.com/kaka-ng/fastify-plugins/actions/workflows/ci-multipart.yml/badge.svg)](https://github.com/kaka-ng/fastify-plugins/actions/workflows/ci-multipart.yml) [![NPM version](https://img.shields.io/npm/v/@kakang/fastif
Downloads
162
Readme
@kakang/fastify-multipart
This plugin is used to replace fastify-formidable
and fastify-busboy
.
It provides a generic API which allows users to not only using formidable
or busboy
for parsing multipart/form-data
, but provide custom adapter
for parsing and custom storage engine to handle file stream. You may
also try the async iterator same as @fastify/multipart
for advanced usage.
You can checkout @fastify/multipart
if you prefer offcial plugin.
Install
npm install @kakang/fastify-multipart --save
yarn add @kakang/fastify-multipart
// For BusboyAdapter
npm install busboy --save
yarn add busboy
// For FormidableAdapter
npm install formidable --save
yarn add formidable
Usage
import FastifyMultipart from '@kakang/fastify-multipart'
import { BusboyAdapter } from '@kakang/fastify-multipart/lib/adapter/busboy'
import { FileStorage } from '@kakang/fastify-multipart/lib/storage/file'
import { BufferStorage } from '@kakang/fastify-multipart/lib/storage/buffer'
fastify.register(FastifyMultipart, {
adapter: BusboyAdapter,
storage: FileStorage,
storageOption: {
uploadDir: '/'
}
})
fastify.post('/', async function(request, reply) {
// you need to call the parser if you do not pass any option through plugin registration
await request.parseMultipart()
// you can use async iterator for file handling
for await (const { type, name, value, info } of request.multipart()) {
switch(type) {
case 'field': {
console.log(name, value)
break
}
case 'file': {
console.log(name, value, info.filename)
// value is Readable
value.resume()
break
}
}
}
// you can use FormData if you familiar with Web API
for await (const [name, value] of await request.formData()) {
console.log(name, value)
}
// access files
request.files
// access body
// note that file fields will exist in body and it will becomes the file path saved on disk
request.body
// check if it is multipart
if(request[kIsMultipart] === true) {}
// check if it is already parsed
if (request[kIsMultipartParsed] === true) {}
})
// add content type parser which will automatic parse all `multipart/form-data` found
fastify.register(FastifyBusboy, {
addContentTypeParser: true,
adapter: BusboyAdapter,
storage: BufferStorage
})
// add `preValidation` hook which will automatic parse all `multipart/form-data` found
fastify.register(FastifyBusboy, {
addHooks: true,
adapter: BusboyAdapter,
storage: BufferStorage
})
Options
options.adapter
The option for content type parser adapter.
By default, we provide BusboyAdapter
and FormidableAdapter
.
You may also extends Adapter
and built your own one.
import FastifyMultipart from '@kakang/fastify-multipart'
import { Adapter } from '@kakang/fastify-multipart/lib/adapter/adapter'
import { BusboyAdapter } from '@kakang/fastify-multipart/lib/adapter/busboy'
import { FormidableAdapter } from '@kakang/fastify-multipart/lib/adapter/formidable'
import { BufferStorage } from '@kakang/fastify-multipart/lib/storage/buffer'
fastify.register(FastifyBusboy, {
adapter: BusboyAdapter,
storage: BufferStorage,
})
options.storage
The option for storage engine.
By default, we provide FileStorage
and BufferStorage
.
You may also extends Storage
and built your own one.
import FastifyMultipart from '@kakang/fastify-multipart'
import { BusboyAdapter } from '@kakang/fastify-multipart/lib/adapter/busboy'
import { Storage } from '@kakang/fastify-multipart/lib/storage/storage'
import { BufferStorage } from '@kakang/fastify-multipart/lib/storage/buffer'
import { FileStorage } from '@kakang/fastify-multipart/lib/storage/file'
fastify.register(FastifyBusboy, {
adapter: BusboyAdapter,
storage: MemoryStorage,
})
options.removeFilesFromBody
This options will not add any files fields to body when enabled.
import FastifyMultipart from '@kakang/fastify-multipart'
import { BusboyAdapter } from '@kakang/fastify-multipart/lib/adapter/busboy'
import { BufferStorage } from '@kakang/fastify-multipart/lib/storage/buffer'
fastify.register(FastifyBusboy, {
adapter: BusboyAdapter,
storage: BufferStorage,
removeFilesFromBody: true
})