Class Multipart

A class containing all useful middlewares for multipart request handling. It also stores your global MultipartOptions.

Should be created with default

import multipart from "express-multipart";

const mp = multipart({});

Hierarchy

Multipart

Index

Methods

Methods

file

file(fieldName: string, options?: MultipartOptions): MultipartMiddleware

- Defined in multipart.ts:63
Middleware used for file and text-based multipart data. It parses a singular file field and multiple text fields.
```
app.post("upload", mp.file("myFile"), (req, res) => {
  const myFile: MultipartFile = req.file;
})
```
Parameters
- fieldName: string
  
  multipart/form-data field name that contains a file.
- Optional options: MultipartOptions
  
  Local multipart options merged with global options.
Returns MultipartMiddleware

Middleware for use in Express-style apps.

files

files(fieldName: string, maxFiles?: number, options?: MultipartOptions): MultipartMiddleware

- Defined in multipart.ts:81
Middleware used for file and text-based multipart data. It parses multiple file fields and multiple text fields.
```
app.post("upload", mp.files("myFiles", 3), (req, res) => {
  const myFiles: MultipartFile[] = req.files;
})
```
Parameters
- fieldName: string
  
  multipart/form-data field name that contains an array of files.
- maxFiles: number = 1
  
  Max amount of files in the array.
- Optional options: MultipartOptions
  
  Local multipart options merged with global options.
Returns MultipartMiddleware

Middleware for use in Express-style apps.

text

text(options?: MultipartOptions): MultipartMiddleware

- Defined in multipart.ts:46
Middleware used for text-based multipart data. It does not parse any files.
```
app.post("texts", mp.text(), (req, res) => {
  const myText: string = req.body.myText;
})
```
Parameters
- Optional options: MultipartOptions
  
  Local multipart options merged with global options.
Returns MultipartMiddleware

Middleware for use in Express-style apps.

Generated using TypeDoc