h3-formidable

h3-formidable

File upload parsing utility for h3 and Nuxt using formidable.

Demo - https://stackblitz.com/edit/nuxt-starter-ykuwmn

Install

npm install h3-formidable

Usage with Nuxt

1. Create a server middleware

import { createFileParserMiddleware } from 'h3-formidable'

export default createFileParserMiddleware({})

1. Access files in your api route

export default eventHandler(async (event) => {
  const { files } = event.context
})

or you can ditch server middleware and parse files per api route...

import { readFiles } from 'h3-formidable'

export default eventHandler(async (event) => {
  // only files
  const files = await readFiles(event)

  // with fields
  const { fields, files } = await readFiles(event, {
    includeFields: true,
    // other formidable options here
  })
})

Usage with H3

import { createFileParserMiddleware } from 'h3-formidable'

const app = createApp()
app
  .use(createFileParserMiddleware({}))
  .use(eventHandler((event) => {
    // event.context.files contains parsed files
  }))

TypeScript Shim

declare module 'h3' {
  import type { FieldsAndFiles, Files } from 'h3-formidable'

  interface H3EventContext {
    files: FieldsAndFiles | Files
  }
}

License

MIT