This plugin add a handy parser for multipart/form-data by using busboy and provide a better integration between multipart/form-data and fastify-swagger
You can checkout fastify-formidable if you prefer using formidable. Or @fastify/multipart if you prefer offcial plugin.
import FastifyBusboy, { kFileSavedPaths, kIsMultipart, kIsMultipartParsed } from 'fastify-busboy'fastify.register(FastifyBusboy)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() // 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 // access all the files path request[kFileSavedPaths] // check if it is multipart if( request[kIsMultipart] === true ) {} // check if it is already parsed if ( request[kIsMultipartParsed] === true ) {}
Options
options.busboy
The options which will be directly passed to busboy.
import FastifyBusboy from 'fastify-busboy'fastify.register(FastifyBusboy, { busboy: { limits: { fileSize: 1000 }, }, // this folder will be automatic created by this plugin uploadDir: '/'})
This options will not add any files fields to body when enabled.
import FastifyBusboy from 'fastify-busboy'fastify.register(FastifyBusboy, { removeFilesFromBody: true})
Error Handling
You can handle the error from either setErrorHandler or using try-catch with request.parseMultipart()
import FastifyBusboy from 'fastify-busboy'fastify.register(FastifyBusboy)fastify.post('/', async function(request, reply) { try { // you need to call the parser if you do not pass any option through plugin registration await request.parseMultipart() } catch (err) { switch(err.code) { case 'FST_BB_FIELD_SIZE_LIMIT': { // field size limit reached break } case 'FST_BB_FIELDS_LIMIT': { // fields limit reached break } case 'FST_BB_FILE_SIZE_LIMIT': { // file size limit reached break
Integration
It is a known limitation for fastify-multipart integrate with fastify-swagger and this plugin provide a relatively simple solution for the integration.
import Fastify from 'fastify'import FastifyBusboy, { ajvBinaryFormat } from 'fastify-busboy'import FastifySwagger from 'fastify-swagger'const fastify = Fastify({ ajv: { plugins: [ ajvBinaryFormat ] }})fastify.register(FastifyBusboy, { addContentTypeParser: true})fastify.register(FastifySwagger)