تعتبر Multer وسيط node.js لمعالجة `multipart/form-data`, والتي تُستخدم أساسًا لتحميل الملفات. تم بناء هذا الوسيط بالإعتماد على [busboy](https://github.com/mscdex/busboy) لأجل الحصول على أقصى قدر من الكفاءة.
**ملاحظة**: لن يقوم Multer بمعالجة أي شكل غير متعدد الأجزاء (`multipart/form-data`).
## الترجمات
هذا الملف متاح أيضًا بلغات أخرى:
- [English](https://github.com/expressjs/multer/blob/main/README.md) (الإنجليزية)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (الإسبانية)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (الصينية)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (الكورية)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (الروسية)
- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (الفتنامية)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (البرتغالية)
## التنصيب
```sh
$ npm install --save multer
```
## الاستعمال
يضيف Multer كائن `body` وكائن `file` أو `files` إلى كائن `request`. يحتوي الكائن `body` على قيم مدخلات النص في الإستمارة ، بينما يحتوي الكائن `file` أو `files` على الملفات التي تم تحميلها عبر الإستمارة.
مثال على الاستخدام الأساسي:
لا تنسَ
`enctype="multipart/form-data"` في الإستمارة الخاص بك.
```html
```
```javascript
var express = require('express')
var multer = require('multer')
var upload = multer({ dest: 'uploads/' })
var app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file is the `avatar` file
// req.body will hold the text fields, if there were any
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files is array of `photos` files
// req.body will contain the text fields, if there were any
})
var uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files is an object (String -> Array) where fieldname is the key, and the value is array of files
//
// e.g.
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body will contain the text fields, if there were any
})
```
إذا احتجت لمعالجة إستمارة متعددة الأجزاء للنص فقط ، فيجب عليك استخدام الدالة `.none ()`:
```javascript
var express = require('express')
var app = express()
var multer = require('multer')
var upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body contains the text fields
})
```
## واجهة برمجة التطبيقات (API)
### معلومات الملف
كل ملف يحتوي على المعلومات التالية:
مفتاح | وصف | ملاحظة
--- | --- | ---
`fieldname` | اسم المُدخَل المحدد في الإستمارة |
`originalname` | اسم الملف على كمبيوتر المستخدم |
`encoding` | نوع تشفير الملف |
`mimetype` | نوع ملف ملحقات بريد إنترنت متعددة الأغراض ( MIME ) |
`size` | حجم الملف بالبايت |
`destination` | المجلد الذي تم حفظ الملف إليه | `تخزين على الاسطوانة` (`DiskStorage`)
`filename` | اسم الملف داخل "الوجهة" ( `destination` ) | `تخزين على الاسطوانة` (`DiskStorage`)
`path` | المسار الكامل للملف الذي تم تحميله | `تخزين على الاسطوانة` (`DiskStorage`)
`buffer` | "ذاكرة" (`Buffer`) للملف بأكمله | `تخزين على الذاكرة ` (`MemoryStorage`)
### `multer(opts)`
يقبل Multer كائن الخيارات ، وأهمها خاصية `dest`، والتي تحدد مكان تحميل الملفات. في حال حذفت كائن الخيارات ، سيتم الاحتفاظ بالملفات في الذاكرة ولن تتم كتابتها مطلقًا على القرص.
بشكل افتراضي ، سيقوم Multer بإعادة تسمية الملفات لتجنب تعارض الأسماء. يمكن تخصيص وظيفة إعادة التسمية وفقا لاحتياجاتك.
فيما يلي الخيارات التي يمكن تمريرها إلى Multer:
مفتاح | وصف
--- | ---
`dest` أو `storage` | مكان لتخزين الملفات
`fileFilter` | دالة للسيطرة على الملفات التي يتم قبولها
`limits` | حدود البيانات التي تم تحميلها
`preservePath` | الاحتفظ بالمسار الكامل للملفات بدلاً من الاسم الأساسي
`defParamCharset` | مجموعة الأحرف الافتراضية لاستخدامها لقيم معاملات رأس الجزء (مثل اسم الملف) التي ليست معاملات موسعة (لا تحتوي على مجموعة أحرف صريحة). الافتراضي: `'latin1'`
في تطبيق ويب متوسط ، قد تكون هناك حاجة فقط إلى `dest`، وتكوينها كما هو موضح في
المثال التالي :
```javascript
var upload = multer({ dest: 'uploads/' })
```
إذا كنت تريد مزيدًا من التحكم في عمليات التحميل ، فستحتاج إلى استخدام خيار `storage` بدلاً من `dest`. يأتي Multer مع محركات التخزين `DiskStorage` و` MemoryStorage` ؛ كما تتوفر المزيد من المحركات من أطراف ثالثة.
#### `.single(fieldname)`
قبول ملف واحد باسم `اسم-المُدخَل`. سيتم تخزين الملف في `req.file`.
#### `.array(fieldname[, maxCount])`
قبول مصفوفة من الملفات ، وكلها تحمل اسم `اسم-المُدخَل`. يظهر خطأ اختياريً إذا تم تحميل ملفات أكثر من `maxCount`. سيتم تخزين مصفوفة الملفات في `req.files`.
#### `.fields(fields)`
قبول مزيج من الملفات ، المحدد بواسطة `المدخلات`. سيتم تخزين كائن مع مصفوفات من الملفات في `req.files`.
يجب أن تكون `المدخلات` عبارة عن مصفوفة من الكائنات التي توفر بشكل اساسي `name` واختيارياً `maxCount`.
مثال:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
قبول المدخلات النصية فقط. في حالة رفع أي ملف ، سيتم إصدار خطأ بشيفرة "LIMIT \_UNEXPECTED \_FILE".
#### `.any()`
قبول جميع الملفات التي تأتي عبر السلك. سيتم تخزين مصفوفة من الملفات في `req.files`.
**تحذير:** تأكد من أنك تعالج دائمًا الملفات التي يقوم المستخدم بتحميلها. لا تقم أبداً بإضافة multer باعتبارها أداة وسيطة عامة ، حيث يمكن للمستخدم الضار تحميل الملفات إلى مسار غير متتوقع. استخدم هذه الدالة فقط على المسارات التي تتعامل فيها مع الملفات التي تم تحميلها.
### `storage`
#### `DiskStorage`
يمنحك محرك تخزين القرص التحكم الكامل في تخزين الملفات على القرص.
```javascript
var storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
var upload = multer({ storage: storage })
```
هناك خياران متاحان ، `destination` و `filename`. كلاهما يعملان على تحديد مكان تخزين الملف.
يتم استخدام `destination` لتحديد أي مجلد يجب تخزين الملفات المحملة. يمكن أيضًا إعطاء هذا كـ`سلسلة` (مثل `'/tmp/uploads'`). إذا لم يتم إعطاء `destination` ، فسيتم استخدام الدليل الافتراضي لنظام التشغيل للملفات المؤقتة.
**ملاحظة:** أنت مسؤول عن إنشاء الدليل عند توفر `destination` كدالة. عند المرور بسلسلة ، سوف يتأكد multer من إنشاء الدليل من أجلك.
يتم استخدام `اسم الملف` لتحديد ما يجب تسمية الملف داخل المجلد. إذا لم يتم تقديم `اسم الملف`، فسيتم إعطاء كل ملف اسمًا عشوائيًا لا يتضمن أي امتداد للملف.
**ملاحظة:** لن يقوم multer بإلحاق اي ملحق ملف لك، الدالة الخاص بك يجب أن تقوم بإرجاع اسم ملف كامل بملحق الملف.
يتم تمرير كل دالة من خلال الطلب (req`) وبعض المعلومات حول الملف (`file`) للمساعدة في اتخاذ القرار.
لاحظ أن `req.body` ربما لم يتم ملؤها بالكامل بعد. يعتمد ذلك على الترتيب الذي يقوم به العميل من خلال نقل المدخلات والملفات إلى الخادم.
#### `MemoryStorage`
يخزن محرك تخزين الذاكرة الملفات الموجودة في الذاكرة ككائنات `ذاكرة` (`Buffer`). ليس لديها أي خيارات.
```javascript
var storage = multer.memoryStorage()
var upload = multer({ storage: storage })
```
عند استخدام ذاكرة التخزين ، ستحتوي معلومات الملف على مُدخَل يسمى `buffer` الذي يحتوي على الملف بأكمله.
**تحذير**: يمكن أن يؤدي تحميل ملفات كبيرة جدًا أو ملفات صغيرة نسبيًا بأعداد كبيرة و بسرعة كبيرة إلى نفاد ذاكرة التطبيق عند استخدام ذاكرة التخزين.
### `limits`
كائن يحدد حدود حجم الخصائص الاختيارية التالية. يقوم Multer بتمرير هذا الكائن إلى busboy مباشرة ، ويمكن العثور على تفاصيل الخصائص من خلال [صفحة busboy's](https://github.com/mscdex/busboy#busboy-methods).
تتوفر القيم الصحيحة التالية:
مفتاح | وصف | افتراضي
--- | --- | ---
`fieldNameSize` | الحد الأقصى لحجم اسم المُدخَل | 100 بايت
`fieldSize` | الحد الأقصى لحجم قيمة المُدخَل (بالبايت) | 1 ميغابايت
`fields` | الحد الأقصى لعدد المدخلات التى لا تعتبر من الملفات | ما لا نهاية
`fileSize` | حجم الملف الأقصى بالنسبة لإستمارة متعددة الأجزاء (بالبايت) | ما لا نهاية
`files` | الحد الأقصى لعدد المدخلات من نوع الملفات بالنسبة لإستمارة متعددة الأجزاء | ما لا نهاية
`parts` | الحد الأقصى لعدد الأجزاء (مدخلات + ملفات) بالنسبة لإستمارة متعددة الأجزاء | ما لا نهاية
`headerPairs` | الحد الأقصى لعدد أزواج الرأس (المفتاح => القيمة) المطلوب تحليلها بالنسبة لإستمارة متعددة الأجزاء | 2000
يمكن أن يساعد تحديد الحدود في حماية موقعك من هجمات حجب الخدمة (DoS).
### `fileFilter`
اضبط هذا على دالة للتحكم في الملفات التي ينبغي تحميلها وأي الملفات يجب تخطيها. يجب أن تبدو دالة كما يلي:
```javascript
function fileFilter (req, file, cb) {
// The function should call `cb` with a boolean
// to indicate if the file should be accepted
// To reject this file pass `false`, like so:
cb(null, false)
// To accept the file pass `true`, like so:
cb(null, true)
// You can always pass an error if something goes wrong:
cb(new Error('I don\'t have a clue!'))
}
```
## معالجة الأخطاء
عند مواجهة خطأ ، سيقوم Multer بتفويض الخطأ إلى Express. يمكنك
عرض صفحة خطأ لطيفة باستخدام [طريقة Express القياسية](http://expressjs.com/guide/error-handling.html).
إذا كنت تريد إنتقاء الأخطاء والحصول على [أخطاء Multer فقط](https://github.com/expressjs/multer/blob/main/lib/multer-error.js)، فيمكنك نداء بدالة الوسيطة من قبل نفسك. أيضًا ، إذا كنت تريد التقاط أخطاء Multer فقط ، فيمكنك استخدام صنف `MulterError` المتصل بالكائن` multer` نفسه (على سبيل المثال `err instanceof multer.MulterError`).
```javascript
var multer = require('multer')
var upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// A Multer error occurred when uploading.
} else if (err) {
// An unknown error occurred when uploading.
}
// Everything went fine.
})
})
```
## محرك التخزين الخاص بك
للحصول على معلومات حول كيفية إنشاء محرك التخزين الخاص بك ، راجع [محرك تخزين Multer](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## الترخيص
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-es.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer es un "*middleware*" de node.js para el manejo de `multipart/form-data`, el cuál es usado sobre todo para la subida de archivos. Está escrito sobre [busboy](https://github.com/mscdex/busboy) para maximizar su eficiencia.
**NOTA**: Multer no procesará ningún formulario que no sea multiparte (`multipart/form-data`).
## Traducciones
Éste archivo README también está disponible en otros lenguajes:
- [English](https://github.com/expressjs/multer/blob/main/README.md) (Inglés)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chino)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coreano)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Ruso)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Portugués Brasileño)
## Instalación
```sh
$ npm install --save multer
```
## Uso
Multer añade un objeto `body` y un objeto `file` o `files` al objeto `request`. El objeto `body` contiene los valores correspondientes a los campos de texto del formulario, los objetos `file` o `files` contienen los archivos que serán subidos mediante el formulario.
Ejemplo básico de cómo usarlo:
No te olvides de `enctype="multipart/form-data"` en tu formulario.
```html
```
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file es el archivo del `avatar`
// req.body contendrá los campos de texto, si los hubiera.
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files es el arreglo (array) de archivos `photos`
// req.body contendrá los campos de texto, si los hubiera.
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files es un objeto (String -> Array) donde el nombre del campo es la clave (key) y el valor es el arreglo (array) de archivos
//
// Ejemplo
// req.files['avatar'][0] -> Archivo
// req.files['gallery'] -> Array
//
// req.body contendrá los campos de texto, si los hubiera.
})
```
En caso de que necesites manejar un formulario multiparte (multipart form) que sólo contiene campos de texto, deberias usar el método `.none()`:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body contiene los campos textuales
})
```
Este es un ejemplo de cómo se utiliza multer en un formulario HTML. Presta especial atención en los campos `enctype="multipart/form-data"` y `name="uploaded_file"`:
```html
```
Luego en tu archivo javascript agrega estas líneas para acceder tanto al archivo (file) como al body.Es importante que uses el valor del campo `name` del formulario, en tu función de subida. Esto le indica a multer en qué campo de la petición debe buscar los archivos. Si estos campos no son los mismos en el formulario HTML y en tu servidor, la subida fallará:
```javascript
const multer = require('multer')
const upload = multer({ dest: './public/data/uploads/' })
app.post('/stats', upload.single('uploaded_file'), function (req, res) {
// req.file es el nombre de tu archivo en el formulario anterior, en este caso 'uploaded_file'
// req.body contendrá los campos de texto, si los hubiera.
console.log(req.file, req.body)
});
```
## API
### Información del archivo
Cada archivo contiene la siguiente información:
Clave (Key) | Descripción | Nota
--- | --- | ---
`fieldname` | Nombre del campo especificado en el formulario |
`originalname` | Nombre del archivo en la computadora del usuario |
`encoding` | Tipo de codificación del archivo |
`mimetype` | Mime type del archivo |
`size` | Tamaño del archivo en Bytes |
`destination` | La carpeta donde se guardó el archivo | `DiskStorage`
`filename` | El nombre del archivo en `destination` | `DiskStorage`
`path` | La ruta completa al archivo subido | `DiskStorage`
`buffer` | Un `Buffer` del archivo completo | `MemoryStorage`
### `multer(opts)`
Multer acepta un objeto para configurar sus opciones, la más básica de ellas es la propiedad `dest`, la cual informa a Multer dónde debe subir los archivos. En caso de que omitas el objeto con las opciones, los archivos serán guardados en la memoria y nunca serán escritos en el disco.
Por defecto, Multer renombrará los archivos para evitar conflictos de nombres. La función usada para renombrarlos puede ser modificada acorde a tus necesidades.
Las siguientes son las opciones que pueden ser utilizadas con Multer.
Clave (key) | Descripción
--- | ---
`dest` o `storage` | Donde se guardarán los archivos
`fileFilter` | Función para controlar qué archivos son aceptados
`limits` | Límites de los datos subidos
`preservePath` | Mantiene la ruta completa de la ubicación de los archivos, en vez de sólo sus nombres
`defParamCharset` | Conjunto de caracteres por defecto para usar en valores de parámetros de encabezados de partes (ej. nombre de archivo) que no son parámetros extendidos (que contienen un conjunto de caracteres explícito). Por defecto: `'latin1'`
En la aplicación web promedio es probable que sólo se requiera `dest`, siendo configurado como en el siguiente ejemplo:
```javascript
const upload = multer({ dest: 'uploads/' })
```
Si quieres más control sobre tus subidas, tendrás que usar la opción `storage` en vez de `dest`. Multer incorpora los mecanismos de almacenamiento `DiskStorage` y `MemoryStorage`; existen otros medios provistos por terceros.
#### `.single(fieldname)`
Acepta un único archivo con el nombre `fieldname`. Dicho archivo será guardado en `req.file`.
#### `.array(fieldname[, maxCount])`
Acepta un arreglo (array), de archivos, todos con el nombre `fieldname`. Opcionalmente puede generarse un error si se intentan subir una cantidad de archivos superior a `maxCount`. El arreglo (array) de archivos será guardado en `req.files`.
#### `.fields(fields)`
Acepta una mezcla de archivos, especificados por `field`. Un objeto con arreglos (arrays) de archivos será guardado en `req.files`
`fields` debería ser un arreglo (array) de objetos con `name` y opcionalmente `maxCount`.
Ejemplo:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
Acepta sólo campos de texto. En caso de intentar subir un archivo, se generará un error con el siguiente código
"LIMIT\_UNEXPECTED\_FILE".
#### `.any()`
Acepta todos los archivos que han sido enviados. Un arreglo (array) conteniendo los archivos, será guardado en `req.files`.
**ADVERTENCIA:** Asegúrate de siempre manejar los archivos que los usuarios intenten subir. Nunca uses Multer como una función middleware de manera global dado que, de esta forma, un usuario malicioso podría subir archivos por medio de rutas que no has anticipado. Usa sólo esta función en rutas en las que estás esperando archivos.
### `storage`
#### `DiskStorage`
El motor de almacenamiento en disco te ofrece un control total sobre el almacenamiento de archivos en tu disco.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
Hay dos opciones disponibles, `destination` y `filename`. Ambas son funciones que determinan dónde debería almacenarse el archivo.
`destination` se utiliza para determinar en qué carpeta se almacenarán los archivos subidos. Tambien se puede proporcionar como un `string` (por ejemplo: `'/tmp/uploads'`). Si no se proporciona `destination`, se utilizara el directorio predeterminado del sistema operativo para archivos temporales.
**Nota:** Al pasar `destination` como una función, tú eres el responsable de crear los directorios donde los archivos serán almacenados. Cuando asignas un `string` a `destination`, Multer se asegurará de que el directorio sea creado en caso de no encontrarlo.
`filename` es usado para determinar cómo debería ser nombrado el archivo dentro de la carpeta. Si `filename` no es provisto, a cada archivo se le asignará un nombre aleatorio que no incluirá ninguna extensión.
**Nota:** Multer no añadirá ningúna extensión de archivos por ti, es tu función la que debería retornar un nombre completo, que incluya también la extensión del archivo.
El objeto petición (`req`) y parte de la información del archivo (`file`) son pasadas a tu función para ayudar con la decisión en la nomenclatura.
Nota que `req.body` puede que no haya sido totalmente poblado todavía. Esto depende del orden en el que el cliente transmita sus campos y archivos hacia el servidor.
Para comprender la convención de llamada utilizada en el callback (necesitas pasar null como primer parametro), consulta en
[Node.js manejo de errores](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors)
#### `MemoryStorage`
El motor de almacenamiento en memoria almacena los archivos en memoria como objetos `Buffer`. Para esto no se proveen opciones.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
Al usar el almacenamiento en memoria, la información del archivo contendrá un campo llamado `buffer` que contiene el archivo entero.
**ADVERTENCIA**: Subir archivos grandes, o relativamente pequeños pero en gran cantidad y muy rápido, puede provocar que tu aplicación se quede sin memoria cuando es usado el almacenamiento en memoria.
### `limits`
Un objeto especifica los límites correpondientes a los tamaños de las siguientes propiedades opcionales. Multer pasa este objeto directamente a *busboy*, los detalles de las propiedades pueden encontrarse en [la página de busboy](https://github.com/mscdex/busboy#busboy-methods).
Los siguientes valores en números enteros están disponibles:
Clave (Key) | Descripción | Por defecto
--- | --- | ---
`fieldNameSize` | Tamaño máximo del nombre del campo | 100 bytes
`fieldSize` | Tamaño máximo de los valores para cada campo (en bytes) | 1MB
`fields` | Número máximo de campos que no son archivos | Infinito
`fileSize` | Para formularios multiparte, el tamaño máximo de los archivos (en bytes) | Infinito
`files` | Para los formularios multiparte, el número máximo de campos para archivos | Infinito
`parts` | Para los formularios multiparte, el número máximo de partes (campos + archivos) | Infinito
`headerPairs` | Para los formularios multiparte, el número máximo de cabeceras de pares clave=>valor para analizar | 2000
Especificar los límites puede ayudarte a proteger tu sitio contra ataques de denegación del servicio (DoS).
### `fileFilter`
Asigna ésto a una función para controlar cuáles archivos deben ser subidos y cuáles deben ser omitidos. La función debería verse como ésta:
```javascript
function fileFilter (req, file, cb) {
// La función debe llamar a `cb` usando una variable del tipo boolean
// para indicar si el archivo debería ser aceptado o no
// Para rechazar el archivo es necesario pasar `false`, de la siguiente forma:
cb(null, false)
// Para aceptar el archivo es necesario pasar `true`, de la siguiente forma:
cb(null, true)
// Siempre puedes pasar un error en caso de que algo salga mal:
cb(new Error('No tengo la menor idea!'))
}
```
## Manejo de errores
Al encontrarse con un error, Multer delegará ese error a Express. Puedes mostrar una linda página de error usando [la manera standard de Express](http://expressjs.com/guide/error-handling.html).
Si quieres capturar los errores específicamente desde Multer, puedes llamar la función middleware tú mismo. También, si quieres capturar sólo [los errores de Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), puedes usar la clase `MulterError` que está adherida al mismo objeto `multer` (por ejemplo: `err instanceof multer.MulterError`).
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Un error de Multer ocurrió durante la subida.
} else if (err) {
// Un error desconocido ocurrió durante la subida.
}
// Todo salió bien.
})
})
```
## Mecanismos de almacenamiento personalizados
Para más información acerca de cómo construir tu propio mecanismo de almacenamiento, recomendamos leer [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## Licencia
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-fr.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer est un middleware node.js pour la gestion des données `multipart/form-data` qui est principalement utilisé pour télécharger des fichiers.
Il est écrit au-dessus de [busboy](https://github.com/mscdex/busboy) pour une efficacité maximale.
**NOTE**: Multer ne traitera aucun formulaire qui ne soit pas un multipart (`multipart/form-data`).
## Translations
This README is also available in other languages:
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (Arabe)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Espagnol)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinois)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coréen)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russe)
- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (Vietnamien)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Portugais du Brésil)
- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (Français)
## Installation
```sh
$ npm install --save multer
```
## Usage
Multer ajoute un objet `body` et un objet `file` ou `files` à l'objet `request`. L'objet `body` contient les valeurs des champs texte du formulaire, l'objet `file` ou `files` contient les fichiers téléchargés via le formulaire.
Exemple d'utilisation de base :
N'oubliez pas le `enctype="multipart/form-data"` dans votre formulaire.
```html
```
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file est le fichier `avatar`
// req.body contiendra les champs de texte, s'il y en avait
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files est un tableau de fichiers "photos"
// req.body contiendra les champs de texte, s'il y en avait
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files est un objet (String -> Array) où fieldname est la clé et la valeur est un tableau de fichiers
//
// e.g.
// req.files['avatar'][0] -> Fichier
// req.files['gallery'] -> Tableau
//
// req.body contiendra les champs de texte, s'il y en avait
})
```
Dans le cas où vous auriez besoin de gérer un formulaire en plusieurs parties texte uniquement, vous devez utiliser la méthode `.none()`:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body contiens les champs de text
})
```
Voici un exemple d'utilisation de multer dans un formulaire HTML. Faites particulièrement attention aux champs `enctype="multipart/form-data"` et `name="uploaded_file"`:
```html
```
Ensuite, dans votre fichier javascript, vous ajouterez ces lignes pour accéder à la fois au fichier et au corps. Il est important que vous utilisiez la valeur du champ `name` du formulaire dans votre fonction de téléchargement. Cela indique à Multer dans quel champ de la requête il doit rechercher les fichiers. Si ces champs ne sont pas les mêmes dans le formulaire HTML et sur votre serveur, votre téléchargement échouera:
```javascript
const multer = require('multer')
const upload = multer({ dest: './public/data/uploads/' })
app.post('/stats', upload.single('uploaded_file'), function (req, res) {
// req.file est le nom de votre fichier dans le formulaire ci-dessus, ici 'uploaded_file'
// req.body contiendra les champs de texte, s'il y en avait
console.log(req.file, req.body)
});
```
## API
### Informations sur les fichiers
Chaque fichier contient les informations suivantes:
Clé | Description | Notes
--- |------------------------------------------------| ---
`fieldname` | Nom du champ spécifié dans le formulaire |
`originalname` | Nom du fichier sur l'ordinateur de l'utilisateur |
`encoding` | Type d'encodage du fichier |
`mimetype` | Type Mime du fichier |
`size` | Taille du fichier en octets |
`destination` | TLe dossier dans lequel le fichier a été enregistré | `DiskStorage`
`filename` | Le nom du fichier dans la `destination` | `DiskStorage`
`path` | Le chemin d'accès complet au fichier téléchargé | `DiskStorage`
`buffer` | Un `Buffer` du fichier entier | `MemoryStorage`
### `multer(opts)`
Multer accepte un objet d'options, dont le plus basique est le `dest`
propriété, qui indique à Multer où télécharger les fichiers. Au cas où vous omettez l'objet
options, les fichiers seront conservés en mémoire et ne seront jamais écrits sur le disque.
Par défaut, Multer renommera les fichiers afin d'éviter les conflits de nommage. Les
la fonction de renommage peut être personnalisée en fonction de vos besoins.
Voici les options qui peuvent être transmises à Multer.
Clé | Description
--- | ---
`dest` ou `storage` | Où stocker les fichiers
`fileFilter` | Fonction pour contrôler quels fichiers sont acceptés
`limits` | Limites des données téléchargées
`preservePath` | Conservez le chemin complet des fichiers au lieu du nom de base uniquement
`defParamCharset` | Jeu de caractères par défaut à utiliser pour les valeurs des paramètres d'en-tête de partie (par exemple, nom de fichier) qui ne sont pas des paramètres étendus (qui contiennent un jeu de caractères explicite). Par défaut : `'latin1'`
Dans une application Web moyenne, seul `dest` peut être requis et configuré comme indiqué dans
l'exemple suivant.
```javascript
const upload = multer({ dest: 'uploads/' })
```
Si vous voulez plus de contrôle sur vos téléchargements, vous voudrez utiliser le `storage`
option au lieu de `dest`. Multer est livré avec des moteurs de stockage `DiskStorage`
et `MemoryStorage`; D'autres moteurs sont disponibles auprès de tiers.
#### `.single(fieldname)`
Acceptez un seul fichier avec le nom `fieldname`. Le fichier unique sera stocké
dans `req.file`.
#### `.array(fieldname[, maxCount])`
Acceptez un tableau de fichiers, tous avec le nom `fieldname`. Eventuellement erreur si
plus de `maxCount` fichiers sont téléchargés. Le tableau de fichiers sera stocké dans
`req.files`.
#### `.fields(fields)`
Accepte un mélange de fichiers, spécifié par `fields`. Un objet avec des tableaux de fichiers
seront stockés dans `req.files`.
`fields` doit être un tableau d'objets avec `name` et éventuellement un `maxCount`.
Exemple:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
N'acceptez que les champs de texte. Si un téléchargement de fichier est effectué, une erreur avec le code
"LIMIT\_UNEXPECTED\_FILE" sera émis.
#### `.any()`
Accepte tous les fichiers qui arrivent sur le fil. Un tableau de fichiers sera stocké dans
`req.files`.
**ATTENTION:** Assurez-vous de toujours gérer les fichiers qu'un utilisateur télécharge.
N'ajoutez jamais multer en tant que middleware global car un utilisateur malveillant pourrait télécharger des
fichiers vers un itinéraire que vous n'aviez pas prévu. N'utilisez cette fonction que sur les itinéraires
où vous gérez les fichiers téléchargés.
### `storage`
#### `DiskStorage`
Le moteur de stockage sur disque vous donne un contrôle total sur le stockage des fichiers sur le disque.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
const uniqueSuffix = Date.now() + '-' + Math.round(Math.random() * 1E9)
cb(null, file.fieldname + '-' + uniqueSuffix)
}
})
const upload = multer({ storage: storage })
```
Il y a deux options disponibles, `destination` et `filename`. Elles sont toutes les deux
des fonctions qui déterminent où le fichier doit être stocké.
`destination` est utilisé pour déterminer dans quel dossier les fichiers téléchargés doivent
être stocké. Cela peut également être donné sous forme de `string` (par exemple `'/tmp/uploads'`). Sinon
`destination` est donné, le répertoire par défaut du système d'exploitation est utilisé pour les
fichiers temporaires.
**Remarque:** Vous êtes responsable de la création du répertoire lorsque vous fournissez
`destination` en tant que fonction. Lors du passage d'une chaîne, multer s'assurera que
le répertoire est créé pour vous.
`filename` est utilisé pour déterminer le nom du fichier dans le dossier.
Si aucun "nom de fichier" n'est donné, chaque fichier recevra un nom aléatoire qui n'inclut
pas d'extension de fichier.
**Remarque:** Multer n'ajoutera aucune extension de fichier pour vous, votre fonction
doit renvoyer un nom de fichier complet avec une extension de fichier.
Chaque fonction reçoit à la fois la requête (`req`) et des informations sur
le dossier (`file`) pour aider à la décision.
Notez que `req.body` n'a peut-être pas encore été entièrement rempli. Cela dépend de l'ordre
où le client transmet les champs et les fichiers au serveur.
Pour comprendre la convention d'appel utilisée dans le rappel (nécessité de passer
null comme premier paramètre), reportez-vous à
[Node.js error handling](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors)
#### `MemoryStorage`
Le moteur de stockage en mémoire stocke les fichiers en mémoire en tant qu'objets `Buffer`. Il
n'a pas d'options.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
Lors de l'utilisation du stockage en mémoire, les informations sur le fichier contiendront un champ appelé
`buffer` qui contient le fichier entier.
**ATTENTION**: Le téléchargement de fichiers très volumineux ou de fichiers relativement petits en grand
nombres très rapidement, peut entraîner un manque de mémoire de votre application lorsque
le stockage en mémoire est utilisé.
### `limits`
Un objet spécifiant les limites de taille des propriétés facultatives suivantes. Multer passe directement cet objet dans busboy, et les détails des propriétés peuvent être trouvés sur [la page de busboy](https://github.com/mscdex/busboy#busboy-methods).
Les valeurs entières suivantes sont disponibles :
Clé | Description | Default
--- |---------------------------------------------------------------------------| ---
`fieldNameSize` | Taille maximale du nom de champ | 100 bytes
`fieldSize` | Max field value size (in bytes) | 1MB
`fields` | Taille maximale de la valeur du champ (en octets) | Infinity
`fileSize` | Pour les formulaires multipart, la taille maximale du fichier (en octets) | Infinity
`files` | Pour les formulaires multipart, le nombre maximal de champs de fichier | Infinity
`parts` | Pour les formulaires multipart, le nombre max de parties (champs + fichiers) | Infinity
`headerPairs` | Pour les formulaires multipart, le nombre maximum de paires clé=>valeur d'en-tête à analyser | 2000
Spécifier les limites peut aider à protéger votre site contre les attaques par déni de service (DoS).
### `fileFilter`
Définissez ceci sur une fonction pour contrôler quels fichiers doivent être téléchargés et lesquels
devrait être ignoré. La fonction devrait ressembler à ceci:
```javascript
function fileFilter (req, file, cb) {
// La fonction doit appeler `cb` avec un booléen
// pour indiquer si le fichier doit être accepté
// Pour rejeter ce fichier, passez `false`, comme ceci:
cb(null, false)
// Pour accepter le fichier, passez `true`, comme ceci:
cb(null, true)
// Vous pouvez toujours passer une erreur si quelque chose ne va pas:
cb(new Error('I don\'t have a clue!'))
}
```
## Gestion des Erreurs
En cas d'erreur, Multer déléguera l'erreur à Express. Vous pouvez
afficher une belle page d'erreur en utilisant [la voie express standard](http://expressjs.com/guide/error-handling.html).
Si vous souhaitez détecter les erreurs spécifiquement de Multer, vous pouvez appeler la
fonction middleware par vous-même. Aussi, si vous voulez attraper seulement [les erreurs Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), vous pouvez utiliser la classe `MulterError` qui est jointe à l'objet `multer` lui-même (par exemple `err instanceof multer.MulterError`).
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Une erreur Multer s'est produite lors du téléchargement.
} else if (err) {
// Une erreur inconnue s'est produite lors du téléchargement.
}
// Tout s'est bien passé.
})
})
```
## Moteur de stockage personnalisé
Pour plus d'informations sur la création de votre propre moteur de stockage, consultez [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## License
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-ko.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer는 파일 업로드를 위해 사용되는 `multipart/form-data` 를 다루기 위한 node.js 의 미들웨어 입니다. 효율성을 최대화 하기 위해 [busboy](https://github.com/mscdex/busboy) 를 기반으로 하고 있습니다.
**주**: Multer는 multipart (`multipart/form-data`)가 아닌 폼에서는 동작하지 않습니다.
## 번역
이 문서는 아래의 언어로도 제공됩니다:
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (아라비아 말)
- [English](https://github.com/expressjs/multer/blob/main/README.md) (영어)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (스페인어)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (중국어)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (러시아)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (포르투갈어 BR)
## 설치
```sh
$ npm install --save multer
```
## 사용법
Multer는 `body` 객체와 한 개의 `file` 혹은 여러개의 `files` 객체를 `request` 객체에 추가합니다. `body` 객체는 폼 텍스트 필드의 값을 포함하고, 한 개 혹은 여러개의 파일 객체는 폼을 통해 업로드된 파일들을 포함하고 있습니다.
기본 사용 예제:
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file 은 `avatar` 라는 필드의 파일 정보입니다.
// 텍스트 필드가 있는 경우, req.body가 이를 포함할 것입니다.
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files 는 `photos` 라는 파일정보를 배열로 가지고 있습니다.
// 텍스트 필드가 있는 경우, req.body가 이를 포함할 것입니다.
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files는 (String -> Array) 형태의 객체 입니다.
// 필드명은 객체의 key에, 파일 정보는 배열로 value에 저장됩니다.
//
// e.g.
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// 텍스트 필드가 있는 경우, req.body가 이를 포함할 것입니다.
})
```
텍스트 전용 multipart 폼을 처리해야 하는 경우, 어떠한 multer 메소드 (`.single()`, `.array()`, `fields()`) 도 사용할 수 있습니다. 아래는 `.array()` 를 사용한 예제 입니다 :
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.array(), function (req, res, next) {
// req.body는 텍스트 필드를 포함합니다.
})
```
## API
### 파일 정보
각각의 파일은 아래의 정보를 포함하고 있습니다:
Key | Description | Note
--- | --- | ---
`fieldname` | 폼에 정의된 필드 명 |
`originalname` | 사용자가 업로드한 파일 명 |
`encoding` | 파일의 엔코딩 타입 |
`mimetype` | 파일의 Mime 타입 |
`size` | 파일의 바이트(byte) 사이즈 |
`destination` | 파일이 저장된 폴더 | `DiskStorage`
`filename` | `destination` 에 저장된 파일 명 | `DiskStorage`
`path` | 업로드된 파일의 전체 경로 | `DiskStorage`
`buffer` | 전체 파일의 `Buffer` | `MemoryStorage`
### `multer(opts)`
Multer는 옵션 객체를 허용합니다. 그 중 가장 기본 옵션인 `dest` 요소는 Multer에게 파일을 어디로 업로드 할 지를 알려줍니다. 만일 옵션 객체를 생략했다면, 파일은 디스크가 아니라 메모리에 저장될 것 입니다.
기본적으로 Multer는 이름이 중복되는 것을 방지하기 위해서 파일의 이름을 재작성 합니다. 필요에 따라 해당 함수는 커스터마이징이 가능합니다.
Multer로 전달 가능한 옵션들은 다음과 같습니다.
Key | Description
--- | ---
`dest` or `storage` | 파일이 저장될 위치
`fileFilter` | 어떤 파일을 허용할지 제어하는 함수
`limits` | 업로드 된 데이터의 한도
`preservePath` | 파일의 base name 대신 보존할 파일의 전체 경로
`defParamCharset` | 확장 매개변수가 아닌 부분 헤더 매개변수 값(예: 파일명)에 사용할 기본 문자 집합(명시적 문자 집합을 포함하지 않음). 기본값: `'latin1'`
보통의 웹 앱에서는 `dest` 옵션 정도만 필요할지도 모릅니다. 설정 방법은 아래의 예제에 나와있습니다.
```javascript
const upload = multer({ dest: 'uploads/' })
```
만일 업로드를 더 제어하고 싶다면, `dest` 옵션 대신 `storage` 옵션을 사용할 수 있습니다. Multer는 스토리지 엔진인 `DiskStorage` 와 `MemoryStorage` 를 탑재하고 있습니다. 써드파티로부터 더 많은 엔진들을 사용할 수 있습니다.
#### `.single(fieldname)`
`fieldname` 인자에 명시된 이름의 단수 파일을 전달 받습니다. 이 파일은 `req.file` 에 저장될 것 입니다.
#### `.array(fieldname[, maxCount])`
`fieldname` 인자에 명시된 이름의 파일 전부를 배열 형태로 전달 받습니다. 선택적으로 `maxCount` 에 명시된 값 이상의 파일이 업로드 될 경우 에러를 출력할 수 있습니다. 전달 된 배열 형태의 파일은 `req.files` 에 저장될 것입니다.
#### `.fields(fields)`
`fields` 인자에 명시된 여러 파일을 전달 받습니다. 파일 객체는 배열 형태로 `req.files` 에 저장될 것입니다.
`fields` 는 `name` 과 `maxCount` (선택사항) 을 포함하는 객체의 배열이어야 합니다.
예제:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
오직 텍스트 필드만 허용합니다. 만일 파일이 업로드 되었을 경우, "LIMIT\_UNEXPECTED\_FILE" 와 같은 에러 코드가 발생할 것입니다. 이는 `upload.fields([])` 와 같은 동작을 합니다.
#### `.any()`
전달된 모든 파일을 허용합니다. 파일 배열은 `req.files` 에 저장될 것입니다.
**주의:** 항상 사용자가 업로드한 파일을 다룬다는 점을 명심하세요. 악의적인 사용자가 여러분이 예측하지 못한 곳으로 파일을 업로드 할 수 있으므로 절대 multer를 글로벌 미들웨어로 사용하지 마세요.
### `storage`
#### `DiskStorage`
디스크 스토리지 엔진은 파일을 디스크에 저장하기 위한 모든 제어 기능을 제공합니다.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
`destination` 과 `filename` 의 두가지 옵션이 가능합니다. 두 옵션 모두 파일을 어디에 저장할 지를 정하는 함수입니다.
`destination` 옵션은 어느 폴더안에 업로드 한 파일을 저장할 지를 결정합니다. 이는 `string` 형태로 주어질 수 있습니다 (예. `'/tmp/uploads'`). 만일 `destination` 옵션이 주어지지 않으면, 운영체제 시스템에서 임시 파일을 저장하는 기본 디렉토리를 사용합니다.
**주:** `destination` 을 함수로 사용할 경우, 디렉토리를 생성해야 할 책임이 있습니다. 문자열이 전달될 때, multer는 해당 디렉토리가 생성되었는지 확인합니다.
`filename` 은 폴더안에 저장되는 파일 명을 결정하는데 사용됩니다.
만일 `filename` 이 주어지지 않는다면, 각각의 파일은 파일 확장자를 제외한 랜덤한 이름으로 지어질 것입니다.
**주:** Multer는 어떠한 파일 확장자도 추가하지 않습니다. 사용자 함수는 파일 확장자를 온전히 포함한 파일명을 반환해야 합니다.
결정을 돕기 위해 각각의 함수는 요청 정보 (`req`) 와 파일 (`file`) 에 대한 정보를 모두 전달 받습니다.
`req.body` 는 완전히 채워지지 않았을 수도 있습니다. 이는 클라이언트가 필드와 파일을 서버로 전송하는 순서에 따라 다릅니다.
#### `MemoryStorage`
메모리 스토리지 엔진은 파일을 메모리에 `Buffer` 객체로 저장합니다. 이에 대해서는 어떤 옵션도 없습니다.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
메모리 스토리지 사용시, 파일 정보는 파일 전체를 포함하는 `buffer` 라고 불리는 필드를 포함할 것입니다.
**주의**: 메모리 스토리지를 사용시, 매우 큰 사이즈의 파일을 업로드 하거나 많은 양의 비교적 작은 파일들을 매우 빠르게 업로드 하는 경우 응용 프로그램의 메모리 부족이 발생 할 수 있습니다.
### `limits`
다음의 선택적 속성의 크기 제한을 지정하는 객체입니다. Multer 는 이 객체를 busboy로 직접 전달합니다. 속성들에 대한 자세한 내용은 [busboy's page](https://github.com/mscdex/busboy#busboy-methods) 에서 확인 하실 수 있습니다.
다음과 같은 정수 값들이 가능합니다:
속성 | 설명 | 기본값
--- | --- | ---
`fieldNameSize` | 필드명 사이즈 최대값 | 100 bytes
`fieldSize` | 필드값 사이즈 최대값 | 1MB
`fields` | 파일형식이 아닌 필드의 최대 개수 | 무제한
`fileSize` | multipart 형식 폼에서 최대 파일 사이즈(bytes) | 무제한
`files` | multipart 형식 폼에서 파일 필드의 최대 개수 | 무제한
`parts` | For multipart forms, the max number of parts (fields + files) | 무제한
`headerPairs` | multipart 형식 폼에서 파싱할 헤더의 key=>value 쌍의 최대 개수| 2000
사이즈 제한을 지정하면 서비스 거부 (DoS) 공격으로부터 사이트를 보호하는데 도움이 됩니다.
### `fileFilter`
어느 파일을 업로드 할지, 혹은 건너뛸지 제어할 수 있게 함수에 설정합니다. 해당 함수는 아래와 같을 것입니다 :
```javascript
function fileFilter (req, file, cb) {
// 이 함수는 boolean 값과 함께 `cb`를 호출함으로써 해당 파일을 업로드 할지 여부를 나타낼 수 있습니다.
// 이 파일을 거부하려면 다음과 같이 `false` 를 전달합니다:
cb(null, false)
// 이 파일을 허용하려면 다음과 같이 `true` 를 전달합니다:
cb(null, true)
// 무언가 문제가 생겼다면 언제나 에러를 전달할 수 있습니다:
cb(new Error('I don\'t have a clue!'))
}
```
## 에러 핸들링
에러가 발생할 때, multer는 에러를 express에 위임할 것입니다. 여러분은 [the standard express way](http://expressjs.com/guide/error-handling.html) 를 이용해서 멋진 오류 페이지를 보여줄 수 있습니다.
만일 multer 로부터 특별히 에러를 캐치하고 싶다면, 직접 미들웨어 함수를 호출하세요.
```javascript
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err) {
// 업로드할때 오류가 발생함
return
}
// 정상적으로 완료됨
})
})
```
## 커스텀 스토리지 엔진
자신만의 고유한 스토리지 엔진을 구축하기 위한 정보를 얻기 위해서는 [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md) 문서를 참고하세요.
## 라이센스
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-pt-br.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer é um middleware node.js para manipulação `multipart/form-data`, que é usado principalmente para fazer upload de arquivos. Foi escrito em cima do [busboy](https://github.com/mscdex/busboy) para máxima eficiência.
**NOTA**: Multer não processará nenhum formulário que não seja multipart (`multipart/form-data`).
## Traduções
Este README também está disponível em outros idiomas:
- [English](https://github.com/expressjs/multer/blob/main/README.md) (Inglês)
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (Árabe)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Espanhol)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinês)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Coreano)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russo)
- [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) (Vietnã)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (Português Brasil)
- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (Francês)
- [O'zbek tili](https://github.com/expressjs/multer/blob/main/doc/README-uz.md) (Uzbequistão)
## Instalação
```sh
$ npm install --save multer
```
## Uso
Multer adiciona um objeto `body` e um `file` ou objeto `files` para objeto `request`. O objeto `body` contém os valores dos campos de texto do formulário, o objeto `file` ou `files` contém os arquivos enviados por meio do formulário.
Exemplo de uso básico:
Não esqueça o `enctype="multipart/form-data"` em seu formulário.
```html
```
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file é um arquivo `avatar`
// req.body conterá os campos de texto, se houver
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files é um array de arquivos `photos`
// req.body conterá os campos de texto, se houver
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files é um objeto (String -> Array) onde fieldname é a chave e o valor é array de arquivos
//
// e.g.
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body conterá os campos de texto, se houver
})
```
Caso você precise lidar com formulário text-only multipart, você deve usar o método `.none()`:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body contém os campos de texto
})
```
Aqui está um exemplo de como o multer é usado em um formulário HTML. Onde adicionamos `enctype="multipart/form-data"` no form e no input `name="uploaded_file"`:
```html
```
Então, em seu arquivo javascript, você adicionaria essas linhas para acessar o arquivo e o corpo. É importante que você use o valor do campo `name` do formulário em sua função de upload. Isso informa ao multer em qual campo da solicitação ele deve procurar os arquivos. Se esses campos não forem iguais no formulário HTML e no seu servidor, seu upload falhará:
```javascript
const multer = require('multer')
const upload = multer({ dest: './public/data/uploads/' })
app.post('/stats', upload.single('uploaded_file'), function (req, res) {
// req.fileé o nome do seu arquivo no formato acima, aqui 'uploaded_file'
// req.body irá conter os campos de texto, se houver algum
console.log(req.file, req.body)
});
```
## API
### Informação de arquivo
Cada arquivo contém as seguintes informações:
Key | Descrição | Nota
--- | --- | ---
`fieldname` | Nome do campo especificado no formulário |
`originalname` | Nome do arquivo no computador do usuário |
`encoding` | Tipo de codificação do arquivo |
`mimetype` | Tipo Mime do arquivo |
`size` | Tamanho do arquivo em bytes |
`destination` | A pasta na qual o arquivo foi salvo | `DiskStorage`
`filename` | O nome do arquivo dentro do `destination` | `DiskStorage`
`path` | O caminho completo para o arquivo enviado | `DiskStorage`
`buffer` | O `Buffer` do arquivo inteiro | `MemoryStorage`
### `multer(opts)`
Multer aceita um objeto de opções, a propriedade mais básica é o `dest`, que diz ao Multer onde fazer o upload dos arquivos. No caso de você omitir o objeto de opções, os arquivos serão mantidos na memória e nunca gravados no disco.
Por padrão, Multer irá renomear os arquivos para evitar conflitos de nomes. A função de renomeação pode ser personalizada de acordo com suas necessidades.
A seguir estão as opções que podem ser passadas para o Multer.
Key | Descrição
--- | ---
`dest` ou `storage` | Onde armazenar os arquivos
`fileFilter` | Função para controlar quais arquivos são aceitos
`limits` | Limites dos dados enviados
`preservePath` | Mantenha o caminho completo dos arquivos em vez de apenas o nome base
`defParamCharset` | Conjunto de caracteres padrão para usar em valores de parâmetros de cabeçalho de parte (por exemplo, nome do arquivo) que não são parâmetros estendidos (que contêm um conjunto de caracteres explícito). Padrão: `'latin1'`
Em um web app básico, somente o `dest` pode ser necessário, e configurado como mostrado no exemplo a seguir:
```javascript
const upload = multer({ dest: 'uploads/' })
```
Se você quiser mais controle sobre seus envios, você ter que usar a opção `storage` em vez de `dest`. Multer vem com motores de armazenamento `DiskStorage` e `MemoryStorage`; Mais mecanismos estão disponíveis de terceiros.
#### `.single(fieldname)`
Aceite um único arquivo com o nome `fieldname`. O arquivo único será armazenado em `req.file`.
#### `.array(fieldname[, maxCount])`
Aceite múltiplos arquivos, todos com o nome `fieldname`. Opcional, gera um erro se forem enviados mais de `maxCount`. O array de arquivos serão armazenados em
`req.files`.
#### `.fields(fields)`
Aceita uma mistura de arquivos, especificada por `fields`. Um objeto com um array de arquivos será armazenado em `req.files`.
`fields` deve ser uma matriz de objetos com `name` e opcionalmente com `maxCount`.
Exemplo:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
Aceite apenas campo de texto. Se algum upload de arquivo for feito, um erro com código "LIMIT\_UNEXPECTED\_FILE" será emitido.
#### `.any()`
Aceita todos os arquivos que são enviados. Uma matriz de arquivos será armazenada em
`req.files`.
**AVISO:** Certifique-se de sempre manipular os arquivos que um usuário envia.
Nunca adicione o Multer como global no middleware, já que um usuário mal-intencionado poderia fazer upload de arquivos para uma rota que você não previu. Use esta função apenas nas rotas onde você está lidando com os arquivos enviados.
### `storage`
#### `DiskStorage`
O mecanismo de armazenamento em disco oferece controle total sobre o armazenamento de arquivos em disco.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
Existem duas opções disponíveis, `destination` e `filename`. Ambas são funções que determinam onde o arquivo deve ser armazenado.
`destination` é usado para determinar em qual pasta os arquivos enviados devem ser armazenados. Isso também pode ser dado como uma `string` (e.g. `'/tmp/uploads'`). Se não é dada `destination`, o diretório padrão do sistema operacional para arquivos temporários é usado.
**Nota:** Você é responsável por criar o diretório ao fornecer o "destino" com uma função. Ao passar uma string, o Multer se certificará de que o diretório foi criado para você.
`filename` é usado para determinar qual arquivo deve ser nomeado dentro da pasta.
Se não for passado `filename`, cada arquivo receberá um nome aleatório que não inclui nenhuma extensão de arquivo.
**Nota:** Multer não adicionará nenhuma extensão de arquivo para você, sua função é retornar um nome para o arquivo completo com a extensão de arquivo.
Cada função é passada pelo request (`req`) e algumas informações sobre o arquivo (`file`) para ajudar com a decisão.
Observe que `req.body` pode não ter sido totalmente preenchido ainda. Isso depende da ordem na qual o cliente transmite campos e arquivos para o servidor.
Para entender a convenção de chamada usada no callback (precisando passar
null como o primeiro parâmetro), consulte em
[Manipulação de erros no Node.js](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors)
#### `MemoryStorage`
O mecanismo de armazenamento na memória, armazena os arquivos na memória como um objeto `Buffer`. Não tendo opções.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
Ao usar o armazenamento de memória, as informações do arquivo conterão um campo chamado `buffer` que contém o arquivo inteiro.
**AVISO**: Fazer upload de arquivos muito grandes ou arquivos relativamente pequenos em grande número muito rapidamente pode fazer com que o aplicativo fique sem memória quando o armazenamento de memória é usado.
### `limits`
Um objeto que especifica os limites de tamanho das seguintes propriedades opcionais. O Multer passa diretamente o objeto para o busboy, e os detalhes das propriedades podem ser encontrados em [busboy's page](https://github.com/mscdex/busboy#busboy-methods).
Os seguintes valores inteiros estão disponíveis:
Key | Descrição | Padrão
--- | --- | ---
`fieldNameSize` | Tamanho máximo do nome de campo| 100 bytes
`fieldSize` | Tamanho máximo do valor do campo (in bytes) | 1MB
`fields` | Max number of non-file fields | Infinity
`fileSize` | Para formulários multipart, o tamanho máximo do arquivo (in bytes) | Infinity
`files` | Para formulários multipart, o número máximo de campos de arquivos | Infinity
`parts` | Para formulários multipart, o número máximo de parts (fields + files) | Infinity
`headerPairs` | Para formulários multipart, o número máximo do header key=>value, para analisar | 2000
A especificação dos limites pode ajudar a proteger seu site contra ataques de negação de serviço (DoS).
### `fileFilter`
Defina isso para uma função para controlar quais arquivos devem ser enviados e quais devem ser ignorados.
A função deve ficar assim:
```javascript
function fileFilter (req, file, cb) {
// A função deve chamar `cb` com um booleano
// para indicar se o arquivo deve ser aceito
// Para rejeitar este arquivo passe `false`, assim:
cb(null, false)
// Para aceitar o arquivo passe `true`, assim:
cb(null, true)
// Você sempre pode passar um erro se algo der errado:
cb(new Error('I don\'t have a clue!'))
}
```
## Error handling
Quando encontrar um erro, Multer delegará o erro para Express. Você pode exibir uma boa página de erro usando [the standard express way](http://expressjs.com/guide/error-handling.html).
Se você quer pegar erros especificamente do Multer, você pode enviar para o função de middleware. Além disso, se você quiser pegar apenas [os erros do Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), você pode usar a classe `MulterError` que está ligado ao objeto `multer` (e.g. `err instanceof multer.MulterError`).
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Ocorreu um erro durante o upload.
} else if (err) {
// Ocorreu um erro durante o upload.
}
// Tudo correu bem.
})
})
```
## Mecanismo de armazenamento personalizado
Para obter informações sobre como criar seu próprio mecanismo de armazenamento, veja [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## Licença
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-ru.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer — это middleware для фреймворка express для обработки `multipart/form-data`, нужная в первую очередь при загрузке файлов. Написана как обертка над [busboy](https://github.com/mscdex/busboy) для ее максимально эффективного использования.
**ВАЖНО**: Multer не обрабатывает никакой другой тип форм, кроме `multipart/form-data`.
## Переводы
Это README также доступно на других языках:
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (арабский)
- [English](https://github.com/expressjs/multer/blob/main/README.md) (Английский)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (Испанский)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Китайский)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Корейский)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (бр Португальский)
## Установка
```sh
$ npm install --save multer
```
## Использование
Multer добавляет объект `body` и объект `file` (или `files`) внутрь объекта `request`. Объект `body` содержит значения текстовых полей формы, объект `file` (`files`) содержит файл или файлы, загружаемые через форму.
Простой пример использования:
Не забывайте про `enctype="multipart/form-data"` в вашей форме.
```html
```
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file - файл `avatar`
// req.body сохранит текстовые поля, если они будут
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files - массив файлов `photos`
// req.body сохранит текстовые поля, если они будут
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files - объект (String -> Array), где fieldname - ключ, и значение - массив файлов
//
// например:
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body сохранит текстовые поля, если они будут
})
```
Если вам нужно обработать multipart-форму, содержащую только текст, используйте метод `.none()`:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body содержит текстовые поля
})
```
## API
### Информация о файлах
Каждый файл содержит следующую информацию:
Ключ | Описание | Замечания
--- | --- | ---
`fieldname` | Имя поля, заданное в форме |
`originalname` | Имя файла на компьютере пользователя |
`encoding` | Кодировка файла |
`mimetype` | Mime-тип файла |
`size` | Размер файла в байтах |
`destination` | Каталог, где будет сохранен файл | `DiskStorage`
`filename` | Имя файла без `destination` | `DiskStorage`
`path` | Полный путь к загружаемому файлу | `DiskStorage`
`buffer` | `Buffer` из всего файла | `MemoryStorage`
### `multer(opts)`
Multer принимает объект с опциями. Базовая опция `dest` указывает Multer, куда загружать файлы. Если вы не указываете объект с опциями, файлы будут находиться в памяти и не будут записаны на диск.
По умолчанию, Multer переименовывает файлы, чтобы избежать конфликтов. Это настраиваемо под ваши потребности.
Следующие опции могут быть переданы Multer.
Ключ | Описание
--- | ---
`dest` или `storage` | Где сохранять файлы
`fileFilter` | Функция для контроля принятия файлов
`limits` | Ограничения по загрузке
`preservePath` | Сохранять полный путь к файлам вместо только базового имени
`defParamCharset` | Кодировка по умолчанию для значений параметров заголовков частей (например, имя файла), которые не являются расширенными параметрами (не содержат явную кодировку). По умолчанию: `'latin1'`
Обычно для веб-приложения нужно обязательно переопределить `dest`, как показано в примере ниже.
```javascript
const upload = multer({ dest: 'uploads/' })
```
Если вам нужно больше возможностей для управления приложением, можно использовать `storage` вместо `dest`. Multer поставляется с двумя движками работы с памятью, `DiskStorage` и `MemoryStorage`, другие движки можно найти у сторонних разработчиков.
#### `.single(fieldname)`
Принимает один файл с именем `fieldname`. Файл будет сохранен в `req.file`.
#### `.array(fieldname[, maxCount])`
Принимает массив файлов с именем `fieldname`. Опционально можно задать ошибку при попытке загрузки более `maxCount` файлов. Массив файлов будет сохранен в `req.files`.
#### `.fields(fields)`
Принимает набор файлов, определенных в `fields`. Объект с массивом файлов будет сохранен в `req.files`.
`fields` должен быть массивом объектов с полями `name` и опциональным `maxCount`.
Например:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
Принимает только текстовые поля формы. При попытке загрузки файла падает с ошибкой "LIMIT\_UNEXPECTED\_FILE".
#### `.any()`
Принимает все переданные файлы. Массив файлов будет сохранен в `req.files`.
**ПРЕДУПРЕЖДЕНИЕ:** Убедитесь в корректной обработке загрузки файлов вашим приложением. Никогда не используйте Multer как middleware глобально, если пользователь может загрузить вредоносные файлы, и тем самым нарушить работу вашего приложения. Используйте этот метод, только если вы полностью управляете процессом загрузки файлов.
### `storage`
#### `DiskStorage`
Движок дискового пространства. Дает полный контроль над размещением файлов на диск.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
Доступно две опции, расположение `destination` и имя файла `filename`. Обе эти функции определяют, где будет находиться файл после загрузки.
`destination` используется, чтобы задать каталог, в котором будут размещены файлы. Может быть задан строкой (например, `'/tmp/uploads'`). Если не задано расположение `destination`, операционная система воспользуется для сохранения каталогом для временных файлов.
**Важно:** Вы должны создать каталог, когда используете `destination`. При передачи в качестве аргумента строки, Multer проверяет, что каталог создан.
`filename` используется, чтобы определить, как будет назван файл внутри каталога. Если
имя файла `filename` не задано, каждому файлу будет сконфигурировано случайное имя без расширения файла.
**Важно:** Multer не добавляет никакого файлового расширения, ваша функция должна возвращать имя файла с необходимым расширением.
В аргументах каждой функции прокидывается запрос (`req`) и набор информации о файле (`file`).
Обратите внимание, что `req.body` может быть не полностью заполнено. Это зависит от порядка отправки клиентом полей и файлов на сервер.
#### `MemoryStorage`
Движок оперативной памяти сохраняет файлы в памяти как объекты типа `Buffer`. В этом случае нет никаких дополнительных опций.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
Когда вы используете этот тип передачи, информация о файле будет содержать поле `buffer`, которое содержит весь файл.
**ПРЕДУПРЕЖДЕНИЕ**: Загрузка очень больших файлов, или относительно небольших файлов в большом количестве может вызвать переполнение памяти.
### `limits`
Объект, устанавливающий ограничения. Multer прокидывает этот объект напрямую в busboy, поэтому детали можно посмотреть
[на странице с методами busboy](https://github.com/mscdex/busboy#busboy-methods).
Доступны следующие целочисленные значения:
Ключ | Описание | Значение по умолчанию
--- | --- | ---
`fieldNameSize` | Максимальный размер имени файла | 100 bytes
`fieldSize` | Максимальный размер значения поля | 1MB
`fields` | Максимальное количество не-файловых полей | Не ограничено
`fileSize` | Максимальный размер файла в байтах для multipart-форм | Не ограничен
`files` | Максимальное количество полей с файлами для multipart-форм | Не ограничено
`parts` | Максимальное количество полей с файлами для multipart-форм (поля плюс файлы) | Не ограничено
`headerPairs` | Максимальное количество пар ключ-значение key=>value для multipart-форм, которое обрабатывается | 2000
Установка ограничений может помочь защитить ваш сайт от DoS-атак.
### `fileFilter`
Задают функцию для того, чтобы решать, какие файлы будут загружены, а какие — нет. Функция может выглядеть так:
```javascript
function fileFilter (req, file, cb) {
// Функция должна вызывать `cb` с булевым значением,
// которое показывает, следует ли принять файл
// Чтобы отклонить, прокиньте в аргументы `false` так:
cb(null, false)
// Чтобы принять файл, используется как аргумент `true` таким образом:
cb(null, true)
// Вы можете всегда вернуть ошибку, если что-то пошло не так:
cb(new Error('I don\'t have a clue!'))
}
```
## Обработка ошибок
Когда выбрасывается исключение, Multer делегирует его обработку Express. Вы можете выводить страницу ошибки [стандартными для express способами](http://expressjs.com/guide/error-handling.html).
Если вы хотите отлавливать ошибки конкретно от Multer, вам нужно вызывать собственную middleware для их обработки. Еще, если вы хотите отлавливать [исключительно ошибки Multer](https://github.com/expressjs/multer/blob/main/lib/make-error.js#L1-L9), вы можете использовать класс `MulterError`, который привязан к объекту `multer` (например, `err instanceof multer.MulterError`)
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Случилась ошибка Multer при загрузке.
} else {
// При загрузке произошла неизвестная ошибка.
}
// Все прекрасно загрузилось.
})
})
```
## Собственные движки для сохранения файлов
Чтобы получить информацию, как создать собственный движок для обработки загрузки файлов, смотрите страницу [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## Лицензия
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-tr.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer, `multipart/form-data` tipi formları işlemek için kullanılan bir Node.js middleware’idir ve genellikle dosya yükleme işlemlerinde kullanılır.
Maksimum verimlilik için [busboy](https://github.com/mscdex/busboy) üzerine yazılmıştır.
**NOT:** Multer, `multipart/form-data` olmayan formları işlemeyecektir.
## Çeviriler
Bu README dosyası ayrıca diğer dillerde de mevcuttur:
| | |
| ------------------------------------------------------------------------------ | --------------- |
| [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) | Arapça |
| [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) | Çince |
| [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) | Fransızca |
| [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) | Korece |
| [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) | Brezilya Portekizcesi |
| [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) | Rusça |
| [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) | İspanyolca |
| [O'zbek tili](https://github.com/expressjs/multer/blob/main/doc/README-uz.md) | Özbekçe |
| [Việt Nam](https://github.com/expressjs/multer/blob/main/doc/README-vi.md) | Vietnamca |
| [Türkçe](https://github.com/expressjs/multer/blob/main/doc/README-tr.md) | Türkçe |
## Kurulum
```sh
$ npm install multer
```
## Kullanım
Multer, `request` nesnesine bir `body` nesnesi ve bir `file` veya `files` nesnesi ekler. `body` nesnesi formdaki metin alanlarının değerlerini içerir; `file` veya `files` nesnesi ise form aracılığıyla yüklenen dosyaları içerir.
Temel kullanım örneği:
Formunuzda enctype="multipart/form-data" eklemeyi unutmayın.
```html
```
```javascript
const express = require("express");
const multer = require("multer");
const upload = multer({ dest: "uploads/" });
const app = express();
app.post("/profile", upload.single("avatar"), function (req, res, next) {
// req.file `avatar` dosyasıdır
// req.body varsa formdaki metin alanlarını tutar
});
app.post(
"/photos/upload",
upload.array("photos", 12),
function (req, res, next) {
// req.files `photos` dosyalarının dizisidir
// req.body varsa metin alanlarını içerir
}
);
const uploadMiddleware = upload.fields([
{ name: "avatar", maxCount: 1 },
{ name: "gallery", maxCount: 8 },
]);
app.post("/cool-profile", uploadMiddleware, function (req, res, next) {
// req.files bir nesnedir (String -> Array) ve burada fieldname (alan adı) anahtar, değer ise dosyaların bulunduğu bir dizidir.
// Örneğin:
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body varsa metin alanların içerir
});
```
Sadece metin verilerini içeren bir multipart formu işlemek için .none() metodunu kullanabilirsiniz:
```javascript
const express = require("express");
const app = express();
const multer = require("multer");
const upload = multer();
app.post("/profile", upload.none(), function (req, res, next) {
// req.body metin alanlarını içerir
});
```
İşte multer'ın HTML formunda nasıl kullanıldığına dair bir örnek. `Enctype="multipart/form-data"` ve `name="uploaded_file"` alanlarına özellikle dikkat edin:
```html
```
Ardından JavaScript dosyanızda, hem dosyaya hem de body’ye erişmek için bu satırları eklemeniz gerekir. Upload fonksiyonunuzda formdaki `name` alanı değerini kullanmanız önemlidir. Bu, multer’a request içindeki hangi alanda dosya araması gerektiğini söyler. Eğer bu alanlar HTML formunda ve sunucuda aynı değilse, yükleme başarısız olur.
```javascript
const multer = require("multer");
const upload = multer({ dest: "./public/data/uploads/" });
app.post("/stats", upload.single("uploaded_file"), function (req, res) {
// req.file formdaki dosya, burada 'uploaded_file'
// req.body metin alanlarını içerir
console.log(req.file, req.body);
});
```
## API
### Dosya bilgisi
Her dosya aşağıdaki bilgileri içerir:
| Anahtar | Açıklama | Not |
| -------------- | -------------------------------------- | --------------- |
| `fieldname` | Formdaki alan adı | |
| `originalname` | Kullanıcının bilgisayarındaki dosya adı | |
| `encoding` | Dosyanın kodlama tipi | |
| `mimetype` | Dosyanın MIME tipi | |
| `size` | Dosyanın boyutu (byte) | |
| `destination` | Dosyanın 'destination' içindeki adı | `DiskStorage` |
| `filename` | Dosyanın klasör içindeki adı | `DiskStorage` |
| `path` | Yüklenen dosyanın tam yolu | `DiskStorage` |
| `buffer` | Dosyanın tamamını içeren `Buffer` | `MemoryStorage` |
### `multer(opts)`
Multer bir options (ayarlar) nesnesi kabul eder. En temel seçenek `dest` olup, dosyaların nereye yükleneceğini belirtir. Eğer options nesnesi verilmezse dosyalar bellekte tutulur ve diske yazılmaz.
Varsayılan olarak, ad çakışmalarını önlemek için Multer dosyaları yeniden adlandırır. Yeniden adlandırma fonksiyonu ihtiyacınıza göre özelleştirilebilir.
Multer’a geçirilebilecek seçenekler:
| Anahtar | Açıklama |
| ----------------- | ------------------------------------------------------ |
| `dest` veya `storage` | Dosyaların nereye kaydedileceği |
| `fileFilter` | Hangi dosyaların kabul edileceğini kontrol eden fonksiyon |
| `limits` | Yüklenen veri sınırları |
| `preservePath` | Sadece dosya adı yerine tam yolu saklar |
Ortalama bir web uygulamasında genellikle sadece `dest` gerekir:
```javascript
const upload = multer({ dest: "uploads/" });
```
Daha fazla kontrol için `storage` seçeneğini kullanabilirsiniz. `Multer`, `DiskStorage` ve `MemoryStorage` depolama motorları ile gelir; üçüncü taraf motorlar da mevcuttur.
#### `.single(fieldname)`
Tek bir dosya kabul eder ve `fieldname` ile eşleşen dosyayı `req.file` içine koyar.
#### `.array(fieldname[, maxCount])`
Birden fazla dosya kabul eder ve `fieldname` ile eşleşenleri `req.files` dizisine koyar. Opsiyonel olarak `maxCount`'tan fazla dosya yüklenirse hata verir.
#### `.fields(fields)`
Belirtilen alanlardan dosya kabul eder. fields bir nesne dizisi olup `req.files` içine koyulur.
`fields`, `name` ve isteğe bağlı olarak `maxCount` içeren nesnelerden oluşan bir dizi olmalıdır.
Örnek:
```javascript
[
{ name: "avatar", maxCount: 1 },
{ name: "gallery", maxCount: 8 },
];
```
#### `.none()`
Yalnızca metin alanlarını kabul eder. Herhangi bir dosya yüklenirse,
“LIMIT_UNEXPECTED_FILE” kodlu bir hata verir
#### `.any()`
Ağ üzerinden gelen tüm dosyaları kabul eder. Bir dizi dosya
`req.files` içinde saklanacaktır.
**UYARI:** Kullanıcıların yüklediği dosyaları her zaman kendiniz işlediğinizden emin olun.
Kötü niyetli bir kullanıcı, sizin öngörmediğiniz bir rotaya dosya yükleyebileceğinden, multer'ı asla global bir orta katman yazılımı olarak eklemeyin.
Bu işlevi yalnızca, yüklenen dosyaları işlediğiniz rotalarda kullanın.
### `storage`
#### `DiskStorage`
Disk depolama motoru, dosyaları diske kaydetme konusunda size tam kontrol sağlar.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, "/tmp/my-uploads");
},
filename: function (req, file, cb) {
const uniqueSuffix = Date.now() + "-" + Math.round(Math.random() * 1e9);
cb(null, file.fieldname + "-" + uniqueSuffix);
},
});
const upload = multer({ storage: storage });
```
İki seçenek mevcuttur: `destination` ve `filename`. Her ikisi de
dosyanın nerede saklanacağını belirleyen işlevlerdir.
`destination`, yüklenen dosyaların hangi klasörde
saklanacağını belirlemek için kullanılır. Bu, `string` olarak da verilebilir (ör. `'/tmp/uploads'`). Eğer
`destination` verilmezse, işletim sisteminin geçici dosyalar için varsayılan
dizini kullanılır.
**Not:** `destination` işlevini kullanarak dizin oluşturmaktan siz
sorumlusunuz. Bir string aktardığınızda, multer dizin sizin için
oluşturulduğundan emin olacaktır.
`filename`, dosyanın klasör içinde nasıl adlandırılacağını belirlemek için kullanılır.
`filename` belirtilmezse, her dosyaya dosya uzantısı içermeyen rastgele bir ad verilir.
**Not:** Multer sizin için herhangi bir dosya uzantısı eklemez, işleviniz
dosya uzantısı ile birlikte tam bir dosya adı döndürmelidir.
Her fonksiyona, karar vermeyi kolaylaştırmak için hem istek (`req`) hem de dosya
hakkında bazı bilgiler (`file`) aktarılır.
`req.body`'nin henüz tam olarak doldurulmamış olabileceğini unutmayın. Bu,
istemcinin alanları ve dosyaları sunucuya aktarma sırasına bağlıdır.
Geri aramada kullanılan çağırma kuralını anlamak için (ilk parametre olarak null geçilmesi gerekir),
[Node.js hata işleme](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors)
#### `MemoryStorage`
Bellek depolama motoru, dosyaları bellekte `Buffer` nesneleri olarak depolar.
Herhangi bir seçeneği yoktur.
```javascript
const storage = multer.memoryStorage();
const upload = multer({ storage: storage });
```
Bellek depolama kullanıldığında, dosya bilgileri tüm dosyayı içeren
`buffer` adlı bir alan içerir.
**UYARI**: Çok büyük dosyaları veya nispeten küçük dosyaları çok hızlı bir şekilde
çok sayıda yüklemek, bellek depolama kullanıldığında uygulamanızın bellek yetersizliği
sorununa neden olabilir.
### `limits`
Aşağıdaki isteğe bağlı özelliklerin boyut sınırlarını belirten bir nesne. Multer bu nesneyi doğrudan busboy'a aktarır ve özelliklerin ayrıntıları [busboy'un sayfasında](https://github.com/mscdex/busboy#busboy-methods) bulunabilir.
Kullanılabilir tamsayı değerleri şöyledir:
| Anahtar | Açıklama | Varsayılan |
| ---------------- | ------------------------------------------------------------------------ | ------------ |
| `fieldNameSize` | Maksimum alan adı boyutu | 100 bayt |
| `fieldSize` | Maksimum alan değeri boyutu (byte cinsinden) | 1MB |
| `fields` | Dosya olmayan alanların maksimum sayısı | Sonsuz |
| `fileSize` | Çok parçalı (multipart) formlar için maksimum dosya boyutu (bayt cinsinden) | Sonsuz |
| `files` | Çok parçalı (multipart) formlar için maksimum dosya alanı sayısı | Sonsuz |
| `parts` | Çok parçalı (multipart) formlar için toplam parça sayısı (alan + dosya) | Sonsuz |
| `headerPairs` | Çok parçalı (multipart) formlar için ayrıştırılacak maksimum header anahtar-değer çifti sayısı | 2000 |
Sınırları belirlemek, sitenizi hizmet reddi (DoS) saldırılarına karşı korumaya yardımcı olabilir.
### `fileFilter`
Yüklenecek ve atlanacak dosyaları kontrol etmek için bunu bir işleve ayarlayın.
İşlev şu şekilde olmalıdır:
```javascript
function fileFilter(req, file, cb) {
// Fonksiyon, dosyanın kabul edilip edilmeyeceğini belirtmek için
// boolean bir değerle `cb` fonksiyonunu çağırmalıdır.
// Bu dosyayı reddetmek için false döndürün:
cb(null, false);
// Dosyayı kabul etmek için true döndürün:
cb(null, true);
// Bir hata oluşursa her zaman bir hata da döndürebilirsiniz:
cb(new Error("Ne olduğunu bilmiyorum!"));
}
```
## Hata Yönetimi
Bir hatayla karşılaşıldığında, Multer hatayı Express'e devreder.
[Standart Express yöntemi](http://expressjs.com/guide/error-handling.html) kullanarak güzel bir hata sayfası görüntüleyebilirsiniz.
Özellikle Multer'dan gelen hataları yakalamak istiyorsanız,
orta katman işlevini kendiniz çağırabilirsiniz. Ayrıca, yalnızca [Multer hatalarını](https://github.com/expressjs/multer/blob/main/lib/multer-error.js) yakalamak istiyorsanız, `multer` nesnesine eklenmiş olan `MulterError` sınıfını kullanabilirsiniz (ör. `err instanceof multer.MulterError`).
```javascript
const multer = require("multer");
const upload = multer().single("avatar");
app.post("/profile", function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Yükleme sırasında bir Multer hatası oluştu
} else if (err) {
// Yükleme sırasında bilinmeyen bir hata oluştu
}
// Her şey sorunsuz geçti.
});
});
```
## Özel depolama motoru
Kendi depolama motorunuzu nasıl oluşturacağınız hakkında bilgi için [Multer Depolama Motoru](https://github.com/expressjs/multer/blob/main/StorageEngine.md) bölümüne bakın.
## Lisans
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-uz.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer - bu nodejs middleware bo'lib, asosan `multipart/form-data` shaklda yuborilgan fayllarni yuklashda ishlatiladi. Yuqori samaradorlikka erishish uchun [busboy](https://github.com/mscdex/busboy)ning ustiga yozilgan.
**Muhim**: Multer `multipart` bo'lmagan har qanday formani qayta ishlamaydi.
## Tarjimalar
Bu README boshqa tillarda ham mavjud:
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (arabcha)
- [English](https://github.com/expressjs/multer/blob/main/README.md) (inglizcha)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (ispancha)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (xitoycha)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (korescha)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (portugalcha)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (ruscha)
- [Français](https://github.com/expressjs/multer/blob/main/doc/README-fr.md) (fransuzcha)
## O'rnatish
```sh
$ npm install --save multer
```
## Foydalanish
Multer - `request` ob'ektiga `body` va `file` yoki `files` ob'ektini qo'shadi. `body` ob'ekti formaning matn maydonlarining (fields) qiymatlarini o'z ichiga oladi, `file` yoki `files` ob'ekti forma orqali yuklangan fayllarni o'z ichiga oladi.
Sodda ishlatish uchun namuna:
Formada `enctype="multipart/form-data"` qo'shish esdan chiqmasin
```html
```
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file - fayl `avatar`
// req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files - fayllar massivi `photos`
// req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files - bu ob'ekt (String -> Array), matn maydoni(fieldname) - bu key, va qiymat - fayllar massivi
//
// misol:
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body agar matnli maydonlar (fields) bo'lsa, ularni saqlanadi
})
```
Agarda siz faqat matndan iborat multipart form bilan ishlashingiz kerak bo'lsa, `.none()` ishlating:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body matnli maydonlar (fields)ni o'zida saqlaydi
})
```
## API
### Fayl haqida ma'lumot
Har bir fayl quyidagi ma'lumotlarni o'zida saqlaydi:
Kalit(key) | Ta'rif | Eslatma
--- |----------------------------------------| ---
`fieldname` | Formada berilgan maxsus nom |
`originalname` | Foydalanuvchi kompyuteridagi fayl nomi |
`encoding` | Faylning kodlash turi |
`mimetype` | Faylning `mime` turi |
`size` | Fayl hajmi - baytda |
`destination` | Fayl saqlangan papka | `DiskStorage`
`filename` | `destination`ni ichidagi fayl nomi | `DiskStorage`
`path` | Yuklangan faylning to'liq yo'li | `DiskStorage`
`buffer` | Butun boshli fayl `Buffer` tipda | `MemoryStorage`
### `multer(opts)`
Multer qo'shimcha ob'ekt qabul qiladi, ulardan eng asosiysi - `dest`,
Multerga fayllarni qayerga yuklash kerakligini aytadigan xususiyat. Agarda siz qo'shimcha(`options`) ob'ektni tashlab ketsangiz, fayllar xotirada saqlanadi va hech qachon diskka yozilmaydi.
Standart holatda - Multer nomlashda kelib chiqishi mumkin bo'lgan muammolarni oldini olish uchun fayllar nomini o'zgartiradi. O'z talablaringizga mos ravishda nomlash funksiyasini sozlay olashingiz mumkin.
Quyidagilar Multerga qo'shimcha qiymat sifati berilishi mumkin:
Kalit(key) | Ta'rif
--- | ---
`dest` yoki `storage` | Faylni qayerda saqlash
`fileFilter` | Qaysi fayllar qabul qilinishini boshqarish funksiyasi
`limits` | Yuklash chegarasi
`preservePath` | Asosiy nom o'rniga fayllarning to'liq yo'lini saqlash
`defParamCharset` | Kengaytirilgan parametrlar bo'lmagan qism sarlavha parametrlari qiymatlari (masalan, fayl nomi) uchun ishlatish uchun standart belgilar to'plami (aniq belgilar to'plamini o'z ichiga olmaydi). Standart: `'latin1'`
O'rtacha veb-ilovada faqat `dest` kerak bo'lishi mumkin va quyidagicha sozlanishi mumkin
```javascript
const upload = multer({ dest: 'uploads/' })
```
Yuklamalaringizni boshqarishda ko'proq nazoratni xohlasangiz, `dest` o'rniga `storage` tanlovini ishlatishingiz kerak. Multer `DiskStorage` va `MemoryStorage` saqlash motorlari(engines) bilan keladi. Boshqa motorlar(engines) uchun uchinchi tomondan(third parties) ko'proq tanlovlar keladi.
#### `.single(fieldname)`
`fieldname` nomi bilan yagona faylni qabul qiladi. Yagona fayl `req.file` da saqlanadi.
#### `.array(fieldname[, maxCount])`
`fieldname` nomi bilan fayllar massivini qabul qiladi. Agar `maxCount` dan ko'p fayl yuklash urinishi bo'lsa, hatolikni aniqlash imkoniyatini berish mumkin. Fayllar massivi `req.files` da saqlanadi.
#### `.fields(fields)`
`fields`da aniqlangan fayllarni qabul qiladi. Fayllar massivini saqlash uchun `req.files` ichidagi massivda saqlanadi.
`fields` ob'ektida `name` va `maxCount` kalitlar(keys)ni o'z ichiga olishi kerak. Misol:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
Faqatgina matnli maydonlar(fields)ni oladi. Agarda biror fayl yuklansa, "LIMIT\_UNEXPECTED\_FILE" xatoligi yuboriladi.
#### `.any()`
Ushbu so'rov barcha fayllarni qabul qiladi, fayllar `req.files` ichida saqlanadi.
**OGOHLANTIRISH:** Foydalanuvchi yuklagan fayllarni doimo boshqarib turishni unutmang. Ularni boshqa yo'l(route)ni kutmagan holda fayllarini yuklash imkonini beradigan global middleware sifatida multerni sozlamang. Faqatgina yuklangan fayllarni boshqarish kerak bo'lgan yo'l(route)larda ushbu funksiyani ishlating.
### `storage`
#### `DiskStorage`
Diskka saqlash motori(engine) sizga fayllarni saqlashda to'liq nazorat qilish imkonini beradi.
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
`destination` va `filename` qo'shimcha tanlovlari mavjud, ular ikkala ham qaysi papkada faylni saqlash kerakligini aniqlab turadigan funksiyalardir.
`destination` yuklangan fayllarni qaysi papkada saqlash kerakligini aniqlab turadi. Bu, `string` sifatida berilishi mumkin (masalan, `'/tmp/uploads'`). Agar `destination` berilmagan bo'lsa, operatsion tizimning vaqtinchalik fayllar uchun ishlatiladigan papkasini ishlatadi.
**Diqqat:** `destination` ni funksiya sifatida berib bo'lganda papka ochilganligiga o'zingiz javobgar bo'lasiz. Agar `string` sifatida bersangiz, multer papkani o'zi uchun yaratishni ta'minlaydi.
`filename` faylni papka ichida qanday nomlanganligini aniqlaydi. Agar `filename` berilmagan bo'lsa, har bir faylga fayl kengaytmasini o'z ichiga olmagan tasodifiy nom beriladi.
**Diqqat:** Multer siz uchun fayl kengaytmasini qo'shmaydi, sizning funksiyangiz kengaytma bilan to'liq nomni qaytarishi kerak.
Har bir funksiya `req` so'rovini va fayl haqida ma'lumotlarni (`file`) olish uchun o'tkaziladi.
Diqqat qiling, `req.body` hali to'liq to'ldirilmagan bo'lishi mumkin. Bu mijozning maydon(field)larni va fayllarni serverga qanday yuborishiga bog'liq bo'ladi.
Callback funktsiyasida ishlatiladigan chaqirish tartibini tushunish uchun (birinchi parametr sifatida null o‘tkazish talab etilishi) ko‘rish uchun quyidagi manzilga murojaat qiling:
[Node.js da xatoliklarni ushlash](https://web.archive.org/web/20220417042018/https://www.joyent.com/node-js/production/design/errors)
#### `MemoryStorage`
Xotira saqlash motori fayllarni xotirada `Buffer` ob'ektlar sifatida saqlaydi. Uning qo'shimcha qiymatlari yo‘q.
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
Xotirada saqlash paytida, fayl ma'lumotlari `buffer` deb nomlanadigan maydonni o‘z ichiga oladi.
**DIQQAT:** Juda katta fayllarni yuklash, yoki kichik fayllarni tez-tez yuklash, xotirada saqlash ishlatilganda, sizning ilovangizning xotirasini to'ldirib qo'yishi mumkin.
### `limits`
Quyidagi xususiyatlar o'lchov(limit)larni aniqlaydigan obyekt. Multer ushbu obyektni to'g'ridan-to'g'ri busboy ga o'tkazadi va xususiyatlar tafsilotlari [busboy sahifasida](https://github.com/mscdex/busboy#busboy-methods)dan topishingiz mumkin.
Quyidagi butun qiymatlar mavjud:
Kalit(key) | Ta'rif | Odatiy qiymat
--- |---------------------------------------------------------------------------------------------| ---
`fieldNameSize` | Maksimal maydon nomi o'lchami | 100 bayt
`fieldSize` | Maksimal maydon qiymati o'lchami (baytlarda) | 1MB
`fields` | Fayl bo'lmagan maydonlarning maksimal soni | Cheklanmagan
`fileSize` | Multipart form uchun faylning maksimal o'lchami (baytda) | Cheklanmagan
`files` | Multipart form uchun fayllar sonining maksimal chegarasi | Cheklanmagan
`parts` | Multipart form uchun fayllar sonining maksimal chegarasi (fieldlar va fayllar) | Cheklanmagan
`headerPairs` | Multipart form uchun ma'lumotlar (kalit va qiymat juftliklari) sonining maksimal chegarasi | 2000
Chegaralarni sozlash, DoS-hujumlariga qarshi saytingizni himoya qilishga yordam bera olishi mumkin
### `fileFilter`
Bu, qaysi fayllarni yuklashi, qaysilarini o'tkazib yuborish kerakligini boshqarish uchun funksiya sifatida sozlasa bo'ladi. Funksiya quyidagi ko'rinishda bo'lishi kerak:"
```javascript
function fileFilter (req, file, cb) {
// Bu funksiya, faylni qabul qilish kerakligini anglatish uchun `cb` ni
// boolean qiymat bilan chaqirish kerak.
// Faylni qabul qilishni rad etish uchun false quyudagicha berilishi kerak:
cb(null, false)
// Faylni qabul qiilishni tasdiqlash uchun true quyudagicha berilishi kerak:
cb(null, true)
// Nimadir xato ketsa, siz har doim Error berishingiz mumkin:
cb(new Error('I don\'t have a clue!'))
}
```
## Xatolar bilan ishlash
Xatoga duch kelganda, Multer xatoni Expressga yuboradi. [standart express usuli](http://expressjs.com/guide/error-handling.html)dan foydalanib xatoni tartibliroq chiqarishingiz mumkin.
Agar siz Multerdan chiqqan xatolarni aniqlamoqchi bo'lsangiz o'zingiz `middleware` funksiya yozishingiz mumkin. Shuningdek, agar siz faqat [Multer xatolarini](https://github.com/expressjs/multer/blob/main/lib/multer-error.js) ushlamoqchi bo'lsangiz, siz `multer` ob'ektiga yozilgan `MulterError` class ni ishlatishingiz mumkin (masalan, `err instanceof multer.MulterError`).
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// Yuklanishda Multerdan xatolik yuz berganda.
} else {
// Yuklanishda noma'lum xatolik yuz berganda.
}
// Hammasi muvaffaqqiyatli bo'lganda.
})
})
```
## Maxsus saqlash mexanizmi
O'zingizning saqlash dvigatelingizni qanday yaratish haqida ma'lumot olish: [Maxsus saqlash mexanizmi](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## Litsenziya
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-vi.md
================================================
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer là thư viện trung gian hỗ trợ việc xử lý `multipart/form-data`, mục đích chính cho việc upload file. Thư viện này dựa trên [busboy](https://github.com/mscdex/busboy) để hiệu quả hơn.
**CHÚ Ý**: Multer sẽ không xử lý bất kỳ form nào ngoài multipart (`multipart/form-data`).
## Dịch:
Các bạn có thể đọc ở các bản dịch ngôn ngữ khác:
- [English](https://github.com/expressjs/multer/blob/main/README.md) (Tiếng Anh)
- [简体中文](https://github.com/expressjs/multer/blob/main/doc/README-zh-cn.md) (Chinese)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (Korean)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (Russian)
## Cài đặt
```sh
$ npm install --save multer
```
## Sử dụng
Multer gắn thêm một object `body` và một object `file` (hoặc `files` trường hợp upload nhiều file) vào object `request`. Object `body` này sẽ chứa các biến text của form, còn object `file` (hoặc `files`) sẽ chứa các file được upload qua form.
Cách sử sụng:
Phải thêm `enctype="multipart/form-data"` vào form của bạn.
```html
```
```javascript
var express = require('express');
var multer = require('multer');
var upload = multer({ dest: 'uploads/' });
var app = express();
app.post('/profile', upload.single('avatar'), function(req, res, next) {
// req.file là 1 file `avatar` được upload
// req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có
});
app.post('/photos/upload', upload.array('photos', 12), function(
req,
res,
next
) {
// req.files là một mảng của các file `photos`
// req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có
});
var uploadMiddleware = upload.fields([
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 },
]);
app.post('/cool-profile', uploadMiddleware, function(req, res, next) {
// req.files là một object kiểu (String -> Array) mà fieldname là key, và value là mảng các files
//
// vd:
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body sẽ giữ thông tin gắn kèm (vd: text fields), nếu có
});
```
Trong trường hợp bạn cần xử lý một multipart form chỉ chứa text, bạn nên sử dụng hàm `.none()`:
```javascript
var express = require('express');
var app = express();
var multer = require('multer');
var upload = multer();
app.post('/profile', upload.none(), function(req, res, next) {
// req.body sẽ giữ thông tin gắn kèm (vd: text fields)
});
```
## API
### Thông tin File được upload
Mỗi file sẽ chứa các thông tin sau:
| Thuộc tính | Mô tả | Ghi chú |
| -------------- | --------------------------------------------------------------- | ------------------------- |
| `fieldname` | tên mỗi thuộc tính ở trong form |
| `originalname` | Tên của file nằm trên máy của người dùng, trước khi được upload |
| `encoding` | Kiểu Encoding của file |
| `mimetype` | Mime type của file | `image/jpeg`, `image/png` |
| `size` | Kích thước của file (theo bytes) |
| `destination` | Đường dẫn tới thư mục file được lưu | `DiskStorage` |
| `filename` | Tên của file (ở trong `destination`) | `DiskStorage` |
| `path` | Đường dẫn đầy đủ tới file đã upload | `DiskStorage` |
| `buffer` | Một `Buffer` của toàn bộ file | `MemoryStorage` |
### Tham số `multer(opts)`
Multer chấp nhận một biến options. Cơ bản là thuộc tính `dest`, là nơi sẽ lưu
file được upload. Trong trường hợp bỏ qua options này, file sẽ được giữ trong
RAM và không được lưu trên ổ cứng.
Mặc định, Multer sẽ đổi tên các file, vì vậy để tránh bị trùng lặp, bạn có thể
tùy biến hàm đổi tên này.
Dưới đây là các tùy chọn mà bạn có thể sử dụng:
| Thuộc tính | Mô tả |
| --------------------- | -------------------------------------------------- |
| `dest` hoặc `storage` | Nơi lưu trữ file |
| `fileFilter` | Hàm để xử lý chỉ những file nào mới được chấp nhận |
| `limits` | Giới hạn dung lượng file được upload |
| `preservePath` | Giữ đầy đủ đường dẫn tới file thay vì chỉ tên file |
| `defParamCharset` | Bộ ký tự mặc định để sử dụng cho các giá trị tham số tiêu đề phần (ví dụ: tên tệp) không phải là tham số mở rộng (không chứa bộ ký tự rõ ràng). Mặc định: `'latin1'` |
Nói chung với web app, chỉ `dest` mới cần khai báo, như bên dưới:
```javascript
var upload = multer({ dest: 'uploads/' });
```
Nếu bạn muốn tùy biến việc upload, bạn sẽ muốn dùng tùy chọn `storage` thay vì `dest`.
Multer sẽ sử dụng 1 trong 2 cách `DiskStorage` và `MemoryStorage`; Hoặc các cách khác (với các thư viện ngoài).
#### `.single(fieldname)`
Chấp nhận chỉ một file với tên thuộc tính `fieldname`. File này truy cập qua `req.file`.
#### `.array(fieldname[, maxCount])`
Chấp nhận mảng các file, tất cả đều với tên `fieldname`. Một lỗi sẽ bắn ra nếu có
nhiều hơn `maxCount` file được upload. Các file này được lưu ở `req.files`.
#### `.fields(fields)`
Chấp nhận nhiều file với thuộc tính `fields`. Một object với mảng các file được lưu ở `req.files`.
`fields` là một mảng các object với thuộc tính `name` và có thể có thuộc tính `maxCount` hoặc không.
Ví dụ:
```javascript
[{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }];
```
#### `.none()`
Chỉ chấp nhận các giá trị text trong form. Nếu bất kỳ file được đính
kèm, một lỗi với mã "LIMIT_UNEXPECTED_FILE" sẽ bắn ra.
#### `.any()`
Chấp nhận tất cả file đến từ bất kỳ nguồn nào. Một mảng các file sẽ được lưu
ở `req.files`.
**CHÚ Ý:** Hãy chắc chắn bạn không bỏ qua bất kỳ file nào mà người dùng upload.
Đừng bao giờ khai báo Multer như một middleware toàn cục, vì người dùng có thể upload
các file tới một api nào đó mà bạn không biết. Chỉ sử dụng hàm này ở trên api mà bạn
muốn xử lý việc upload file.
### `storage`
#### `DiskStorage`
Cơ chế lưu trữ trên ổ đĩa cho phép bạn có đầy đủ quyền để thao tác với file.
```javascript
var storage = multer.diskStorage({
destination: function(req, file, cb) {
cb(null, '/tmp/my-uploads');
},
filename: function(req, file, cb) {
cb(null, file.fieldname + '-' + Date.now());
},
});
var upload = multer({ storage: storage });
```
Có 2 tùy chọn, `destination` và `filename`. Chúng đều dùng để xác định nơi nào
file sẽ được lưu trữ.
`destination` được dùng để xác định thư mục nào file được upload. Có thể là một
`string` (vd: `'/tmp/uploads'`). Nếu không khai báo `destination`, thư mục tạm
(của hệ điều hành) sẽ được dùng để chứa các file đó.
**Ghi chú:** Nếu bạn khai báo `destination` là một hàm, bạn phải tự tạo đường
dẫn. Còn nếu truyền vào một string, multer sẽ đảm bảo việc tạo đường dẫn đó cho bạn.
`filename` được dùng để xác định file nào sẽ được lưu trong thư mục. Nếu không
có `filename` nào, mỗi file sẽ nhận tên ngẫu nhiên mà không bao gồm đuôi của file.
**Ghi chú:** Multer sẽ không thêm bất kỳ đuôi file nào cho bạn, hàm của bạn nên
trả về một file với đuôi của nó.
Mỗi hàm được truyền cả ở request (`req`) và thông tin về file (`file`) để xử lý.
Chú ý `req.body` có thể không chứa đầy đủ thông tin, phụ thuộc việc thứ tự các
trường dữ liệu và file được gửi tới server lúc nào.
#### `MemoryStorage`
Memory storage lưu các file ở bộ nhớ máy dưới dạng một object `Buffer`. Nó không
có bất kỳ tùy chọn nào.
```javascript
var storage = multer.memoryStorage();
var upload = multer({ storage: storage });
```
Khi sử dụng memory storage, thông tin file sẽ chứa một trường `buffer`, trường
này chứa toàn bộ file.
**CHÚ Ý**: Việc upload file rất lớn, hoặc tương tự việc nhiều file nhỏ, có thể
gây ra tràn bộ nhớ khi memory storage được sử dụng.
### `limits`
Một object mô tả giới hạn kích thước trong thuộc tính nên được sử dụng. Multer truyền object này trực tiếp vào busboy, và chi tiết của busboy có thể xem thêm ở [busboy's page](https://github.com/mscdex/busboy#busboy-methods).
Các số dưới dây cũng có thể được dùng:
| Thuộc tính | Mô tả | Giá trị mặc định |
| --------------- | -------------------------------------------------------------------- | ---------------- |
| `fieldNameSize` | Độ dài tối đa của tên field | 100 bytes |
| `fieldSize` | Kích thước tối đa của mỗi field (theo bytes) | 1MB |
| `fields` | Số lượng tối đa của các fields không phải là file | Infinity |
| `fileSize` | Cho multipart forms, kích thước tối đa của file (theo bytes) | Infinity |
| `files` | Cho multipart forms, số lượng file tối đa | Infinity |
| `parts` | Cho multipart forms, số lượng tối đa của parts (gồm fields + files) | Infinity |
| `headerPairs` | Cho multipart forms, số tối đa trong header cặp key=>value để truyền | 2000 |
Khai báo các giới hạn này giúp cho site của bạn chống lại các tấn công nguy hiểm (DoS).
### `fileFilter`
Dùng hàm này để xử lý các file nào cho phép và bị bỏ qua. Xem ví dụ dưới dây:
```javascript
function fileFilter(req, file, cb) {
// hàm này sẽ gọi callback `cb` với 1 biến boolean
// để chỉ ra rằng file có được chấp nhận hay không
// Để chặn file này, truyền `false` như sau:
cb(null, false);
// Để chấp nhận file này, truỳen `true`, như sau:
cb(null, true);
// Hoặc bạn có thể truyền vào 1 lỗi nếu có vấn đề xảy ra:
cb(new Error("I don't have a clue!"));
}
```
## Error handling
Khi một lỗi xảy ra, Multer sẽ gửi lỗi đó cho Express. Bạn có thể hiển thị
đẹp hơn sử dụng [cách bắt lỗi chuẩn của Express](http://expressjs.com/guide/error-handling.html).
Nếu bạn muốn bắt các lỗi cụ thể từ Multer, bạn có thể tự gọi hàm trung gian (middleware) này. Ngoài ra, nếu bạn chỉ muốn bắt [lỗi của Multer](https://github.com/expressjs/multer/blob/main/lib/multer-error.js), bạn có thể dùng class `MulterError` được đính kèm với chính object `multer` (vd: `err instanceof multer.MulterError`).
```javascript
var multer = require('multer');
var upload = multer().single('avatar');
app.post('/profile', function(req, res) {
upload(req, res, function(err) {
if (err instanceof multer.MulterError) {
// Một lỗi của Multer xảy ra khi upload.
} else if (err) {
// Một lỗi không xác định xảy ra khi upload.
}
// Mọi thứ khác chạy ok.
});
});
```
## Tùy chọn storage engine
Để làm sao tự xây dựng cơ chế lưu file riêng của mình, hãy xem [Multer Storage Engine](https://github.com/expressjs/multer/blob/main/StorageEngine.md).
## License
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: doc/README-zh-cn.md
================================================
**此文档于2016年10月3日翻译时multer的版本是1.2.0，它可能不是最新的！**
**甚至可能存在翻译错误！你可能需要阅读原版英语[README](../README.md)**
**此文档仅供参考！**
# Multer [![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][test-image]][test-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
Multer 是一个 node.js 中间件，用于处理 `multipart/form-data` 类型的表单数据，它主要用于上传文件。它是写在 [busboy](https://github.com/mscdex/busboy) 之上非常高效。
**注意**: Multer 不会处理任何非 `multipart/form-data` 类型的表单数据。
## 其它语言
- [العربية](https://github.com/expressjs/multer/blob/main/doc/README-ar.md) (阿拉伯语)
- [English](https://github.com/expressjs/multer/blob/main/README.md) (英语)
- [Español](https://github.com/expressjs/multer/blob/main/doc/README-es.md) (西班牙文)
- [한국어](https://github.com/expressjs/multer/blob/main/doc/README-ko.md) (朝鲜语)
- [Русский язык](https://github.com/expressjs/multer/blob/main/doc/README-ru.md) (俄語)
- [Português](https://github.com/expressjs/multer/blob/main/doc/README-pt-br.md) (巴西葡萄牙语)
## 安装
```sh
$ npm install --save multer
```
## 使用
Multer 会添加一个 `body` 对象 以及 `file` 或 `files` 对象 到 express 的 `request` 对象中。
`body` 对象包含表单的文本域信息，`file` 或 `files` 对象包含对象表单上传的文件信息。
基本使用方法:
```javascript
const express = require('express')
const multer = require('multer')
const upload = multer({ dest: 'uploads/' })
const app = express()
app.post('/profile', upload.single('avatar'), function (req, res, next) {
// req.file 是 `avatar` 文件的信息
// req.body 将具有文本域数据，如果存在的话
})
app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
// req.files 是 `photos` 文件数组的信息
// req.body 将具有文本域数据，如果存在的话
})
const uploadMiddleware = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', uploadMiddleware, function (req, res, next) {
// req.files 是一个对象 (String -> Array) 键是文件名，值是文件数组
//
// 例如：
// req.files['avatar'][0] -> File
// req.files['gallery'] -> Array
//
// req.body 将具有文本域数据，如果存在的话
})
```
如果你需要处理一个只有文本域的表单，你应当使用 `.none()`:
```javascript
const express = require('express')
const app = express()
const multer = require('multer')
const upload = multer()
app.post('/profile', upload.none(), function (req, res, next) {
// req.body 包含文本域
})
```
## API
### 文件信息
每个文件具有下面的信息:
Key | Description | Note
--- | --- | ---
`fieldname` | Field name 由表单指定 |
`originalname` | 用户计算机上的文件的名称 |
`encoding` | 文件编码 |
`mimetype` | 文件的 MIME 类型 |
`size` | 文件大小（字节单位） |
`destination` | 保存路径 | `DiskStorage`
`filename` | 保存在 `destination` 中的文件名 | `DiskStorage`
`path` | 已上传文件的完整路径 | `DiskStorage`
`buffer` | 一个存放了整个文件的 `Buffer` | `MemoryStorage`
### `multer(opts)`
Multer 接受一个 options 对象，其中最基本的是 `dest` 属性，这将告诉 Multer 将上传文件保存在哪。如果你省略 options 对象，这些文件将保存在内存中，永远不会写入磁盘。
为了避免命名冲突，Multer 会修改上传的文件名。这个重命名功能可以根据您的需要定制。
以下是可以传递给 Multer 的选项。
Key | Description
--- | ---
`dest` or `storage` | 在哪里存储文件
`fileFilter` | 文件过滤器，控制哪些文件可以被接受
`limits` | 限制上传的数据
`preservePath` | 保存包含文件名的完整文件路径
`defParamCharset` | 用于部分标头参数值（例如文件名）的默认字符集，这些参数不是扩展参数（不包含显式字符集）。默认值：`'latin1'`
通常，一般的网页应用，只需要设置 `dest` 属性，像这样：
```javascript
const upload = multer({ dest: 'uploads/' })
```
如果你想在上传时进行更多的控制，你可以使用 `storage` 选项替代 `dest`。Multer 具有 `DiskStorage` 和 `MemoryStorage` 两个存储引擎；另外还可以从第三方获得更多可用的引擎。
#### `.single(fieldname)`
接受一个以 `fieldname` 命名的文件。这个文件的信息保存在 `req.file`。
#### `.array(fieldname[, maxCount])`
接受一个以 `fieldname` 命名的文件数组。可以配置 `maxCount` 来限制上传的最大数量。这些文件的信息保存在 `req.files`。
#### `.fields(fields)`
接受指定 `fields` 的混合文件。这些文件的信息保存在 `req.files`。
`fields` 应该是一个对象数组，应该具有 `name` 和可选的 `maxCount` 属性。
Example:
```javascript
[
{ name: 'avatar', maxCount: 1 },
{ name: 'gallery', maxCount: 8 }
]
```
#### `.none()`
只接受文本域。如果任何文件上传到这个模式，将发生 "LIMIT\_UNEXPECTED\_FILE" 错误。这和 `upload.fields([])` 的效果一样。
#### `.any()`
接受一切上传的文件。文件数组将保存在 `req.files`。
**警告:** 确保你总是处理了用户的文件上传。
永远不要将 multer 作为全局中间件使用，因为恶意用户可以上传文件到一个你没有预料到的路由，应该只在你需要处理上传文件的路由上使用。
### `storage`
#### 磁盘存储引擎 (`DiskStorage`)
磁盘存储引擎可以让你控制文件的存储。
```javascript
const storage = multer.diskStorage({
destination: function (req, file, cb) {
cb(null, '/tmp/my-uploads')
},
filename: function (req, file, cb) {
cb(null, file.fieldname + '-' + Date.now())
}
})
const upload = multer({ storage: storage })
```
有两个选项可用，`destination` 和 `filename`。他们都是用来确定文件存储位置的函数。
`destination` 是用来确定上传的文件应该存储在哪个文件夹中。也可以提供一个 `string` (例如 `'/tmp/uploads'`)。如果没有设置 `destination`，则使用操作系统默认的临时文件夹。
**注意:** 如果你提供的 `destination` 是一个函数，你需要负责创建文件夹。当提供一个字符串，multer 将确保这个文件夹是你创建的。
`filename` 用于确定文件夹中的文件名的确定。 如果没有设置 `filename`，每个文件将设置为一个随机文件名，并且是没有扩展名的。
**注意:** Multer 不会为你添加任何扩展名，你的程序应该返回一个完整的文件名。
每个函数都传递了请求对象 (`req`) 和一些关于这个文件的信息 (`file`)，有助于你的决定。
注意 `req.body` 可能还没有完全填充，这取决于向客户端发送字段和文件到服务器的顺序。
#### 内存存储引擎 (`MemoryStorage`)
内存存储引擎将文件存储在内存中的 `Buffer` 对象，它没有任何选项。
```javascript
const storage = multer.memoryStorage()
const upload = multer({ storage: storage })
```
当使用内存存储引擎，文件信息将包含一个 `buffer` 字段，里面包含了整个文件数据。
**警告**: 当你使用内存存储，上传非常大的文件，或者非常多的小文件，会导致你的应用程序内存溢出。
### `limits`
一个对象，指定一些数据大小的限制。Multer 通过这个对象使用 busboy，详细的特性可以在 [busboy's page](https://github.com/mscdex/busboy#busboy-methods) 找到。
可以使用下面这些:
Key | Description | Default
--- | --- | ---
`fieldNameSize` | field 名字最大长度 | 100 bytes
`fieldSize` | field 值的最大长度 | 1MB
`fields` | 非文件 field 的最大数量 | 无限
`fileSize` | 在 multipart 表单中，文件最大长度 (字节单位) | 无限
`files` | 在 multipart 表单中，文件最大数量 | 无限
`parts` | 在 multipart 表单中，part 传输的最大数量(fields + files) | 无限
`headerPairs` | 在 multipart 表单中，键值对最大组数 | 2000
设置 limits 可以帮助保护你的站点抵御拒绝服务 (DoS) 攻击。
### `fileFilter`
设置一个函数来控制什么文件可以上传以及什么文件应该跳过，这个函数应该看起来像这样：
```javascript
function fileFilter (req, file, cb) {
// 这个函数应该调用 `cb` 用boolean值来
// 指示是否应接受该文件
// 拒绝这个文件，使用`false`，像这样:
cb(null, false)
// 接受这个文件，使用`true`，像这样:
cb(null, true)
// 如果有问题，你可以总是这样发送一个错误:
cb(new Error('I don\'t have a clue!'))
}
```
## 错误处理机制
当遇到一个错误，multer 将会把错误发送给 express。你可以使用一个比较好的错误展示页 ([express标准方式](http://expressjs.com/guide/error-handling.html))。
如果你想捕捉 multer 发出的错误，你可以自己调用中间件程序。如果你想捕捉 [Multer 错误](https://github.com/expressjs/multer/blob/main/lib/multer-error.js)，你可以使用 `multer` 对象下的 `MulterError` 类 (即 `err instanceof multer.MulterError`)。
```javascript
const multer = require('multer')
const upload = multer().single('avatar')
app.post('/profile', function (req, res) {
upload(req, res, function (err) {
if (err instanceof multer.MulterError) {
// 发生错误
} else if (err) {
// 发生错误
}
// 一切都好
})
})
```
## 定制存储引擎
如果你想要构建自己的存储引擎，请看 [这里](/StorageEngine.md) 。
## License
[MIT](LICENSE)
[ci-image]: https://github.com/expressjs/multer/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/expressjs/multer/actions/workflows/ci.yml
[test-url]: https://coveralls.io/r/expressjs/multer?branch=main
[test-image]: https://badgen.net/coveralls/c/github/expressjs/multer/main
[npm-downloads-image]: https://badgen.net/npm/dm/multer
[npm-url]: https://npmjs.org/package/multer
[npm-version-image]: https://badgen.net/npm/v/multer
[ossf-scorecard-badge]: https://api.scorecard.dev/projects/github.com/expressjs/multer/badge
[ossf-scorecard-visualizer]: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/expressjs/multer
================================================
FILE: index.js
================================================
var makeMiddleware = require('./lib/make-middleware')
var diskStorage = require('./storage/disk')
var memoryStorage = require('./storage/memory')
var MulterError = require('./lib/multer-error')
function allowAll (req, file, cb) {
cb(null, true)
}
function Multer (options) {
if (options.storage) {
this.storage = options.storage
} else if (options.dest) {
this.storage = diskStorage({ destination: options.dest })
} else {
this.storage = memoryStorage()
}
this.limits = options.limits
this.preservePath = options.preservePath
this.defParamCharset = options.defParamCharset || 'latin1'
this.fileFilter = options.fileFilter || allowAll
}
Multer.prototype._makeMiddleware = function (fields, fileStrategy) {
function setup () {
var fileFilter = this.fileFilter
var filesLeft = Object.create(null)
fields.forEach(function (field) {
if (typeof field.maxCount === 'number') {
filesLeft[field.name] = field.maxCount
} else {
filesLeft[field.name] = Infinity
}
})
function wrappedFileFilter (req, file, cb) {
if ((filesLeft[file.fieldname] || 0) <= 0) {
return cb(new MulterError('LIMIT_UNEXPECTED_FILE', file.fieldname))
}
filesLeft[file.fieldname] -= 1
fileFilter(req, file, cb)
}
return {
limits: this.limits,
preservePath: this.preservePath,
defParamCharset: this.defParamCharset,
storage: this.storage,
fileFilter: wrappedFileFilter,
fileStrategy: fileStrategy
}
}
return makeMiddleware(setup.bind(this))
}
Multer.prototype.single = function (name) {
return this._makeMiddleware([{ name: name, maxCount: 1 }], 'VALUE')
}
Multer.prototype.array = function (name, maxCount) {
return this._makeMiddleware([{ name: name, maxCount: maxCount }], 'ARRAY')
}
Multer.prototype.fields = function (fields) {
return this._makeMiddleware(fields, 'OBJECT')
}
Multer.prototype.none = function () {
return this._makeMiddleware([], 'NONE')
}
Multer.prototype.any = function () {
function setup () {
return {
limits: this.limits,
preservePath: this.preservePath,
defParamCharset: this.defParamCharset,
storage: this.storage,
fileFilter: this.fileFilter,
fileStrategy: 'ARRAY'
}
}
return makeMiddleware(setup.bind(this))
}
function multer (options) {
if (options === undefined) {
return new Multer({})
}
if (typeof options === 'object' && options !== null) {
return new Multer(options)
}
throw new TypeError('Expected object for argument options')
}
module.exports = multer
module.exports.diskStorage = diskStorage
module.exports.memoryStorage = memoryStorage
module.exports.MulterError = MulterError
================================================
FILE: lib/counter.js
================================================
var EventEmitter = require('events').EventEmitter
function Counter () {
EventEmitter.call(this)
this.value = 0
}
Counter.prototype = Object.create(EventEmitter.prototype)
Counter.prototype.increment = function increment () {
this.value++
}
Counter.prototype.decrement = function decrement () {
if (--this.value === 0) this.emit('zero')
}
Counter.prototype.isZero = function isZero () {
return (this.value === 0)
}
Counter.prototype.onceZero = function onceZero (fn) {
if (this.isZero()) return fn()
this.once('zero', fn)
}
module.exports = Counter
================================================
FILE: lib/file-appender.js
================================================
function arrayRemove (arr, item) {
var idx = arr.indexOf(item)
if (~idx) arr.splice(idx, 1)
}
function FileAppender (strategy, req) {
this.strategy = strategy
this.req = req
switch (strategy) {
case 'NONE': break
case 'VALUE': break
case 'ARRAY': req.files = []; break
case 'OBJECT': req.files = Object.create(null); break
default: throw new Error('Unknown file strategy: ' + strategy)
}
}
FileAppender.prototype.insertPlaceholder = function (file) {
var placeholder = {
fieldname: file.fieldname
}
switch (this.strategy) {
case 'NONE': break
case 'VALUE': break
case 'ARRAY': this.req.files.push(placeholder); break
case 'OBJECT':
if (this.req.files[file.fieldname]) {
this.req.files[file.fieldname].push(placeholder)
} else {
this.req.files[file.fieldname] = [placeholder]
}
break
}
return placeholder
}
FileAppender.prototype.removePlaceholder = function (placeholder) {
switch (this.strategy) {
case 'NONE': break
case 'VALUE': break
case 'ARRAY': arrayRemove(this.req.files, placeholder); break
case 'OBJECT':
if (this.req.files[placeholder.fieldname].length === 1) {
delete this.req.files[placeholder.fieldname]
} else {
arrayRemove(this.req.files[placeholder.fieldname], placeholder)
}
break
}
}
FileAppender.prototype.replacePlaceholder = function (placeholder, file) {
if (this.strategy === 'VALUE') {
this.req.file = file
return
}
delete placeholder.fieldname
Object.assign(placeholder, file)
}
module.exports = FileAppender
================================================
FILE: lib/make-middleware.js
================================================
var is = require('type-is')
var Busboy = require('busboy')
var appendField = require('append-field')
var Counter = require('./counter')
var MulterError = require('./multer-error')
var FileAppender = require('./file-appender')
var removeUploadedFiles = require('./remove-uploaded-files')
function drainStream (stream) {
stream.on('readable', () => {
while (stream.read() !== null) {}
})
}
function makeMiddleware (setup) {
return function multerMiddleware (req, res, next) {
if (!is(req, ['multipart'])) return next()
var options = setup()
var limits = options.limits
var storage = options.storage
var fileFilter = options.fileFilter
var fileStrategy = options.fileStrategy
var preservePath = options.preservePath
var defParamCharset = options.defParamCharset
req.body = Object.create(null)
var busboy
var appender = null
var isDone = false
var readFinished = false
var errorOccured = false
var pendingWrites = new Counter()
var uploadedFiles = []
function done (err) {
var called = false
function onFinished () {
if (called) return
called = true
next(err)
}
if (isDone) return
isDone = true
if (busboy) {
req.unpipe(busboy)
setImmediate(() => {
busboy.removeAllListeners()
})
}
drainStream(req)
req.resume()
// - if responding with an error, drain request body before calling
// next(err) -- avoids EPIPE on the client (server closing connection
// while the client is still sending the request body)
// - also listen for 'close' so we don't hang when the client aborts (stream may never 'end')
// - skip waiting if the stream is already destroyed (e.g. client aborted)
if (err && req.readable && !req.destroyed) {
req.once('end', onFinished)
req.once('error', onFinished)
req.once('close', onFinished)
return
}
next(err)
}
function indicateDone () {
if (readFinished && pendingWrites.isZero() && !errorOccured) done()
}
function abortWithError (uploadError, skipPendingWait) {
if (errorOccured) return
errorOccured = true
function finishAbort () {
function remove (file, cb) {
storage._removeFile(req, file, cb)
}
removeUploadedFiles(uploadedFiles, remove, function (err, storageErrors) {
if (err) return done(err)
uploadError.storageErrors = storageErrors
done(uploadError)
})
}
if (skipPendingWait) {
finishAbort()
} else {
pendingWrites.onceZero(finishAbort)
}
}
function abortWithCode (code, optionalField) {
abortWithError(new MulterError(code, optionalField))
}
function handleRequestFailure (err) {
if (isDone) return
if (busboy) {
req.unpipe(busboy)
busboy.destroy(err)
}
abortWithError(err, true)
}
req.on('error', function (err) {
handleRequestFailure(err || new Error('Request error'))
})
req.on('aborted', function () {
handleRequestFailure(new Error('Request aborted'))
})
req.on('close', function () {
if (req.readableEnded) return
handleRequestFailure(new Error('Request closed'))
})
try {
busboy = Busboy({
headers: req.headers,
limits: limits,
preservePath: preservePath,
defParamCharset: defParamCharset
})
} catch (err) {
return next(err)
}
appender = new FileAppender(fileStrategy, req)
// handle text field data
busboy.on('field', function (fieldname, value, { nameTruncated, valueTruncated }) {
if (fieldname == null) return abortWithCode('MISSING_FIELD_NAME')
if (nameTruncated) return abortWithCode('LIMIT_FIELD_KEY')
if (valueTruncated) return abortWithCode('LIMIT_FIELD_VALUE', fieldname)
// Work around bug in Busboy (https://github.com/mscdex/busboy/issues/6)
if (limits && Object.prototype.hasOwnProperty.call(limits, 'fieldNameSize')) {
if (fieldname.length > limits.fieldNameSize) return abortWithCode('LIMIT_FIELD_KEY')
}
appendField(req.body, fieldname, value)
})
// handle files
busboy.on('file', function (fieldname, fileStream, { filename, encoding, mimeType }) {
var pendingWritesIncremented = false
fileStream.on('error', function (err) {
if (pendingWritesIncremented) {
pendingWrites.decrement()
}
abortWithError(err)
})
if (fieldname == null) return abortWithCode('MISSING_FIELD_NAME')
// don't attach to the files object, if there is no file
if (!filename) return fileStream.resume()
// Work around bug in Busboy (https://github.com/mscdex/busboy/issues/6)
if (limits && Object.prototype.hasOwnProperty.call(limits, 'fieldNameSize')) {
if (fieldname.length > limits.fieldNameSize) return abortWithCode('LIMIT_FIELD_KEY')
}
var file = {
fieldname: fieldname,
originalname: filename,
encoding: encoding,
mimetype: mimeType
}
var placeholder = appender.insertPlaceholder(file)
fileFilter(req, file, function (err, includeFile) {
if (errorOccured) {
appender.removePlaceholder(placeholder)
return fileStream.resume()
}
if (err) {
appender.removePlaceholder(placeholder)
return abortWithError(err)
}
if (!includeFile) {
appender.removePlaceholder(placeholder)
return fileStream.resume()
}
var aborting = false
pendingWritesIncremented = true
pendingWrites.increment()
Object.defineProperty(file, 'stream', {
configurable: true,
enumerable: false,
value: fileStream
})
fileStream.on('limit', function () {
aborting = true
abortWithCode('LIMIT_FILE_SIZE', fieldname)
})
storage._handleFile(req, file, function (err, info) {
if (aborting) {
appender.removePlaceholder(placeholder)
uploadedFiles.push({ ...file, ...info })
return pendingWrites.decrement()
}
if (err) {
appender.removePlaceholder(placeholder)
pendingWrites.decrement()
return abortWithError(err)
}
var fileInfo = { ...file, ...info }
appender.replacePlaceholder(placeholder, fileInfo)
uploadedFiles.push(fileInfo)
pendingWrites.decrement()
indicateDone()
})
})
})
busboy.on('error', function (err) { abortWithError(err) })
busboy.on('partsLimit', function () { abortWithCode('LIMIT_PART_COUNT') })
busboy.on('filesLimit', function () { abortWithCode('LIMIT_FILE_COUNT') })
busboy.on('fieldsLimit', function () { abortWithCode('LIMIT_FIELD_COUNT') })
busboy.on('close', function () {
readFinished = true
indicateDone()
})
req.pipe(busboy)
}
}
module.exports = makeMiddleware
================================================
FILE: lib/multer-error.js
================================================
var util = require('util')
var errorMessages = {
LIMIT_PART_COUNT: 'Too many parts',
LIMIT_FILE_SIZE: 'File too large',
LIMIT_FILE_COUNT: 'Too many files',
LIMIT_FIELD_KEY: 'Field name too long',
LIMIT_FIELD_VALUE: 'Field value too long',
LIMIT_FIELD_COUNT: 'Too many fields',
LIMIT_UNEXPECTED_FILE: 'Unexpected field',
MISSING_FIELD_NAME: 'Field name missing'
}
function MulterError (code, field) {
Error.captureStackTrace(this, this.constructor)
this.name = this.constructor.name
this.message = errorMessages[code]
this.code = code
if (field) this.field = field
}
util.inherits(MulterError, Error)
module.exports = MulterError
================================================
FILE: lib/remove-uploaded-files.js
================================================
function removeUploadedFiles (uploadedFiles, remove, cb) {
var length = uploadedFiles.length
var errors = []
if (length === 0) return cb(null, errors)
function handleFile (idx) {
var file = uploadedFiles[idx]
remove(file, function (err) {
if (err) {
err.file = file
err.field = file.fieldname
errors.push(err)
}
if (idx < length - 1) {
setImmediate(function () { handleFile(idx + 1) })
} else {
cb(null, errors)
}
})
}
handleFile(0)
}
module.exports = removeUploadedFiles
================================================
FILE: package.json
================================================
{
"name": "multer",
"description": "Middleware for handling `multipart/form-data`.",
"version": "2.1.1",
"contributors": [
"Hage Yaapa
(http://www.hacksparrow.com)",
"Jaret Pfluger ",
"Linus Unnebäck "
],
"license": "MIT",
"repository": "expressjs/multer",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/express"
},
"keywords": [
"form",
"post",
"multipart",
"form-data",
"formdata",
"express",
"middleware"
],
"dependencies": {
"append-field": "^1.0.0",
"busboy": "^1.6.0",
"concat-stream": "^2.0.0",
"type-is": "^1.6.18"
},
"devDependencies": {
"deep-equal": "^2.0.3",
"express": "^4.21.2",
"form-data": "^4.0.2",
"fs-temp": "^1.2.1",
"mocha": "^11.5.0",
"nyc": "^15.1.0",
"rimraf": "^2.4.1",
"standard": "^14.3.3",
"testdata-w3c-json-form": "^1.0.0"
},
"engines": {
"node": ">= 10.16.0"
},
"files": [
"LICENSE",
"index.js",
"storage/",
"lib/"
],
"scripts": {
"lint": "standard",
"lint:fix": "standard --fix",
"test": "mocha --reporter spec --exit --check-leaks test/",
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
"test-cov": "nyc --reporter=html --reporter=text npm test"
}
}
================================================
FILE: storage/disk.js
================================================
var fs = require('fs')
var os = require('os')
var path = require('path')
var crypto = require('crypto')
function getFilename (req, file, cb) {
crypto.randomBytes(16, function (err, raw) {
cb(err, err ? undefined : raw.toString('hex'))
})
}
function getDestination (req, file, cb) {
cb(null, os.tmpdir())
}
function DiskStorage (opts) {
this.getFilename = (opts.filename || getFilename)
if (typeof opts.destination === 'string') {
fs.mkdirSync(opts.destination, { recursive: true })
this.getDestination = function ($0, $1, cb) { cb(null, opts.destination) }
} else {
this.getDestination = (opts.destination || getDestination)
}
}
DiskStorage.prototype._handleFile = function _handleFile (req, file, cb) {
var that = this
that.getDestination(req, file, function (err, destination) {
if (err) return cb(err)
that.getFilename(req, file, function (err, filename) {
if (err) return cb(err)
var finalPath = path.join(destination, filename)
var outStream = fs.createWriteStream(finalPath)
file.stream.pipe(outStream)
outStream.on('error', cb)
outStream.on('finish', function () {
cb(null, {
destination: destination,
filename: filename,
path: finalPath,
size: outStream.bytesWritten
})
})
})
})
}
DiskStorage.prototype._removeFile = function _removeFile (req, file, cb) {
var path = file.path
delete file.destination
delete file.filename
delete file.path
fs.unlink(path, cb)
}
module.exports = function (opts) {
return new DiskStorage(opts)
}
================================================
FILE: storage/memory.js
================================================
var concat = require('concat-stream')
function MemoryStorage (opts) {}
MemoryStorage.prototype._handleFile = function _handleFile (req, file, cb) {
file.stream.pipe(concat({ encoding: 'buffer' }, function (data) {
cb(null, {
buffer: data,
size: data.length
})
}))
}
MemoryStorage.prototype._removeFile = function _removeFile (req, file, cb) {
delete file.buffer
cb(null)
}
module.exports = function (opts) {
return new MemoryStorage(opts)
}
================================================
FILE: test/_util.js
================================================
var fs = require('fs')
var path = require('path')
var stream = require('stream')
exports.file = function file (name) {
return fs.createReadStream(path.join(__dirname, 'files', name))
}
exports.fileSize = function fileSize (path) {
return fs.statSync(path).size
}
exports.submitForm = function submitForm (multer, form, cb) {
form.getLength(function (err, length) {
if (err) return cb(err)
var req = new stream.PassThrough()
form.pipe(req)
req.headers = {
'content-type': 'multipart/form-data; boundary=' + form.getBoundary(),
'content-length': length
}
multer(req, null, function (err) {
cb(err, req)
})
})
}
================================================
FILE: test/async-file-filter-orphan.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var fs = require('fs')
var os = require('os')
var path = require('path')
var http = require('http')
var express = require('express')
var multer = require('../')
describe('async fileFilter cleanup', function () {
it('does not leave orphan files when request aborts with missing field name', function (done) {
var uploadDir = fs.mkdtempSync(path.join(os.tmpdir(), 'multer-orphan-'))
var app = express()
var upload = multer({
dest: uploadDir,
fileFilter: function (req, file, cb) {
setImmediate(function () { cb(null, true) })
}
})
app.post('/upload', upload.any(), function (req, res) {
res.json({ success: true })
})
app.use(function (err, req, res, next) {
res.status(400).json({ error: err.code })
})
var server = app.listen(0, function () {
var port = server.address().port
var boundary = 'TestBound'
var body =
'--' + boundary + '\r\n' +
'Content-Disposition: form-data; name="f"; filename="a.bin"\r\n' +
'Content-Type: application/octet-stream\r\n\r\nORPHAN FILE DATA\r\n' +
'--' + boundary + '\r\n' +
'Content-Disposition: form-data; filename="b.bin"\r\n' +
'Content-Type: application/octet-stream\r\n\r\nx\r\n' +
'--' + boundary + '--\r\n'
var req = http.request({
hostname: 'localhost',
port: port,
path: '/upload',
method: 'POST',
headers: {
'Content-Type': 'multipart/form-data; boundary=' + boundary,
'Content-Length': Buffer.byteLength(body)
}
}, function (res) {
res.resume()
res.on('end', function () {
setTimeout(function () {
var files = fs.readdirSync(uploadDir)
assert.strictEqual(res.statusCode, 400)
assert.strictEqual(files.length, 0)
server.close(done)
}, 500)
})
})
req.on('error', function (err) {
server.close(function () {
done(err)
})
})
req.write(body)
req.end()
})
})
}
)
================================================
FILE: test/def-param-charset.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var stream = require('stream')
var multer = require('../')
var temp = require('fs-temp')
var rimraf = require('rimraf')
describe('defParamCharset', function () {
var uploadDir, upload
beforeEach(function (done) {
temp.mkdir(function (err, path) {
if (err) return done(err)
var storage = multer.diskStorage({
destination: path,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
})
uploadDir = path
upload = multer({ storage: storage })
done()
})
})
afterEach(function (done) {
rimraf(uploadDir, done)
})
it('should use latin1 as default charset for non-extended parameters', function (done) {
var req = new stream.PassThrough()
var boundary = 'AaB03x'
// Create a filename with latin1 characters (e.g., café encoded as latin1)
// In latin1: é = 0xE9
var bodyParts = [
'--' + boundary,
'Content-Disposition: form-data; name="testfile"; filename="caf',
'.txt"',
'Content-Type: text/plain',
'',
'test file content',
'--' + boundary + '--'
]
// Create buffer with proper latin1 encoding
var bodyBuffer = Buffer.concat([
Buffer.from(bodyParts[0] + '\r\n', 'ascii'),
Buffer.from(bodyParts[1], 'ascii'),
Buffer.from([0xE9]), // é in latin1
Buffer.from(bodyParts[2] + '\r\n', 'ascii'),
Buffer.from(bodyParts[3] + '\r\n', 'ascii'),
Buffer.from(bodyParts[4] + '\r\n', 'ascii'),
Buffer.from(bodyParts[5] + '\r\n', 'ascii'),
Buffer.from(bodyParts[6], 'ascii')
])
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': bodyBuffer.length
}
req.end(bodyBuffer)
upload.single('testfile')(req, null, function (err) {
assert.ifError(err)
// With latin1 (default), the filename should be interpreted as latin1
assert.strictEqual(req.file.originalname, 'café.txt')
assert.strictEqual(req.file.fieldname, 'testfile')
done()
})
})
it('should use custom charset when defParamCharset is specified', function (done) {
var customUpload = multer({
storage: multer.diskStorage({
destination: uploadDir,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
}),
defParamCharset: 'utf8'
})
var req = new stream.PassThrough()
var boundary = 'AaB03x'
// Create a filename with UTF-8 characters (e.g., café encoded as UTF-8)
// In UTF-8: é = 0xC3 0xA9
var bodyParts = [
'--' + boundary,
'Content-Disposition: form-data; name="testfile"; filename="caf',
'.txt"',
'Content-Type: text/plain',
'',
'test file content',
'--' + boundary + '--'
]
// Create buffer with proper UTF-8 encoding
var bodyBuffer = Buffer.concat([
Buffer.from(bodyParts[0] + '\r\n', 'ascii'),
Buffer.from(bodyParts[1], 'ascii'),
Buffer.from([0xC3, 0xA9]), // é in UTF-8
Buffer.from(bodyParts[2] + '\r\n', 'ascii'),
Buffer.from(bodyParts[3] + '\r\n', 'ascii'),
Buffer.from(bodyParts[4] + '\r\n', 'ascii'),
Buffer.from(bodyParts[5] + '\r\n', 'ascii'),
Buffer.from(bodyParts[6], 'ascii')
])
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': bodyBuffer.length
}
req.end(bodyBuffer)
customUpload.single('testfile')(req, null, function (err) {
assert.ifError(err)
// With utf8, the filename should be interpreted as utf8
assert.strictEqual(req.file.originalname, 'café.txt')
assert.strictEqual(req.file.fieldname, 'testfile')
done()
})
})
it('should not affect extended parameters with explicit charset', function (done) {
var customUpload = multer({
storage: multer.diskStorage({
destination: uploadDir,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
}),
defParamCharset: 'ascii' // This should be ignored for extended parameters
})
var req = new stream.PassThrough()
var boundary = 'AaB03x'
var body = [
'--' + boundary,
// Extended parameter with explicit UTF-8 charset should override defParamCharset
'Content-Disposition: form-data; name="testfile"; filename*=utf-8\'\'caf%C3%A9.txt',
'Content-Type: text/plain',
'',
'test file content',
'--' + boundary + '--'
].join('\r\n')
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
req.end(body)
customUpload.single('testfile')(req, null, function (err) {
assert.ifError(err)
// Extended parameter should use its own charset (UTF-8), not defParamCharset
assert.strictEqual(req.file.originalname, 'café.txt')
assert.strictEqual(req.file.fieldname, 'testfile')
done()
})
})
it('should handle different charsets correctly', function (done) {
var customUpload = multer({
storage: multer.diskStorage({
destination: uploadDir,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
}),
defParamCharset: 'iso-8859-1' // Same as latin1
})
var req = new stream.PassThrough()
var boundary = 'AaB03x'
// Test with ISO-8859-1 encoded characters
var bodyParts = [
'--' + boundary,
'Content-Disposition: form-data; name="testfile"; filename="test',
'.txt"',
'Content-Type: text/plain',
'',
'test file content',
'--' + boundary + '--'
]
// Create buffer with proper ISO-8859-1 encoding
var bodyBuffer = Buffer.concat([
Buffer.from(bodyParts[0] + '\r\n', 'ascii'),
Buffer.from(bodyParts[1], 'ascii'),
Buffer.from([0xF1]), // ñ in ISO-8859-1
Buffer.from(bodyParts[2] + '\r\n', 'ascii'),
Buffer.from(bodyParts[3] + '\r\n', 'ascii'),
Buffer.from(bodyParts[4] + '\r\n', 'ascii'),
Buffer.from(bodyParts[5] + '\r\n', 'ascii'),
Buffer.from(bodyParts[6], 'ascii')
])
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': bodyBuffer.length
}
req.end(bodyBuffer)
customUpload.single('testfile')(req, null, function (err) {
assert.ifError(err)
// Should correctly decode the ñ character
assert.strictEqual(req.file.originalname, 'testñ.txt')
assert.strictEqual(req.file.fieldname, 'testfile')
done()
})
})
it('should work with memory storage', function (done) {
var memoryUpload = multer({
storage: multer.memoryStorage(),
defParamCharset: 'utf8'
})
var req = new stream.PassThrough()
var boundary = 'AaB03x'
var bodyParts = [
'--' + boundary,
'Content-Disposition: form-data; name="testfile"; filename="test',
'.txt"',
'Content-Type: text/plain',
'',
'test file content',
'--' + boundary + '--'
]
// Create buffer with proper UTF-8 encoding
var bodyBuffer = Buffer.concat([
Buffer.from(bodyParts[0] + '\r\n', 'ascii'),
Buffer.from(bodyParts[1], 'ascii'),
Buffer.from([0xC3, 0xA9]), // é in UTF-8
Buffer.from(bodyParts[2] + '\r\n', 'ascii'),
Buffer.from(bodyParts[3] + '\r\n', 'ascii'),
Buffer.from(bodyParts[4] + '\r\n', 'ascii'),
Buffer.from(bodyParts[5] + '\r\n', 'ascii'),
Buffer.from(bodyParts[6], 'ascii')
])
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': bodyBuffer.length
}
req.end(bodyBuffer)
memoryUpload.single('testfile')(req, null, function (err) {
assert.ifError(err)
assert.strictEqual(req.file.originalname, 'testé.txt')
assert.strictEqual(req.file.fieldname, 'testfile')
assert.ok(Buffer.isBuffer(req.file.buffer))
done()
})
})
it('should work with array uploads', function (done) {
var customUpload = multer({
storage: multer.diskStorage({
destination: uploadDir,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
}),
defParamCharset: 'utf8'
})
var req = new stream.PassThrough()
var boundary = 'AaB03x'
// Create buffer with proper UTF-8 encoding for both files
var bodyBuffer = Buffer.concat([
Buffer.from('--' + boundary + '\r\n', 'ascii'),
Buffer.from('Content-Disposition: form-data; name="testfiles"; filename="file1', 'ascii'),
Buffer.from([0xC3, 0xA9]), // é in UTF-8
Buffer.from('.txt"\r\n', 'ascii'),
Buffer.from('Content-Type: text/plain\r\n', 'ascii'),
Buffer.from('\r\n', 'ascii'),
Buffer.from('test file 1 content\r\n', 'ascii'),
Buffer.from('--' + boundary + '\r\n', 'ascii'),
Buffer.from('Content-Disposition: form-data; name="testfiles"; filename="file2', 'ascii'),
Buffer.from([0xC3, 0xB1]), // ñ in UTF-8
Buffer.from('.txt"\r\n', 'ascii'),
Buffer.from('Content-Type: text/plain\r\n', 'ascii'),
Buffer.from('\r\n', 'ascii'),
Buffer.from('test file 2 content\r\n', 'ascii'),
Buffer.from('--' + boundary + '--', 'ascii')
])
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': bodyBuffer.length
}
req.end(bodyBuffer)
customUpload.array('testfiles', 2)(req, null, function (err) {
assert.ifError(err)
assert.strictEqual(req.files.length, 2)
assert.strictEqual(req.files[0].originalname, 'file1é.txt')
assert.strictEqual(req.files[1].originalname, 'file2ñ.txt')
done()
})
})
})
================================================
FILE: test/disk-storage.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var deepEqual = require('deep-equal')
var fs = require('fs')
var path = require('path')
var util = require('./_util')
var multer = require('../')
var temp = require('fs-temp')
var rimraf = require('rimraf')
var FormData = require('form-data')
describe('Disk Storage', function () {
var uploadDir, upload
beforeEach(function (done) {
temp.mkdir(function (err, path) {
if (err) return done(err)
uploadDir = path
upload = multer({ dest: path })
done()
})
})
afterEach(function (done) {
rimraf(uploadDir, done)
})
it('should process parser/form-data POST request', function (done) {
var form = new FormData()
var parser = upload.single('small0')
form.append('name', 'Multer')
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.body.name, 'Multer')
assert.strictEqual(req.file.fieldname, 'small0')
assert.strictEqual(req.file.originalname, 'small0.dat')
assert.strictEqual(req.file.size, 1778)
assert.strictEqual(util.fileSize(req.file.path), 1778)
done()
})
})
it('should process empty fields and an empty file', function (done) {
var form = new FormData()
var parser = upload.single('empty')
form.append('empty', util.file('empty.dat'))
form.append('name', 'Multer')
form.append('version', '')
form.append('year', '')
form.append('checkboxfull', 'cb1')
form.append('checkboxfull', 'cb2')
form.append('checkboxhalfempty', 'cb1')
form.append('checkboxhalfempty', '')
form.append('checkboxempty', '')
form.append('checkboxempty', '')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.body.name, 'Multer')
assert.strictEqual(req.body.version, '')
assert.strictEqual(req.body.year, '')
assert(deepEqual(req.body.checkboxfull, ['cb1', 'cb2']))
assert(deepEqual(req.body.checkboxhalfempty, ['cb1', '']))
assert(deepEqual(req.body.checkboxempty, ['', '']))
assert.strictEqual(req.file.fieldname, 'empty')
assert.strictEqual(req.file.originalname, 'empty.dat')
assert.strictEqual(req.file.size, 0)
assert.strictEqual(util.fileSize(req.file.path), 0)
done()
})
})
it('should process multiple files', function (done) {
var form = new FormData()
var parser = upload.fields([
{ name: 'empty', maxCount: 1 },
{ name: 'tiny0', maxCount: 1 },
{ name: 'tiny1', maxCount: 1 },
{ name: 'small0', maxCount: 1 },
{ name: 'small1', maxCount: 1 },
{ name: 'medium', maxCount: 1 },
{ name: 'large', maxCount: 1 }
])
form.append('empty', util.file('empty.dat'))
form.append('tiny0', util.file('tiny0.dat'))
form.append('tiny1', util.file('tiny1.dat'))
form.append('small0', util.file('small0.dat'))
form.append('small1', util.file('small1.dat'))
form.append('medium', util.file('medium.dat'))
form.append('large', util.file('large.jpg'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, {}))
assert.strictEqual(req.files.empty[0].fieldname, 'empty')
assert.strictEqual(req.files.empty[0].originalname, 'empty.dat')
assert.strictEqual(req.files.empty[0].size, 0)
assert.strictEqual(util.fileSize(req.files.empty[0].path), 0)
assert.strictEqual(req.files.tiny0[0].fieldname, 'tiny0')
assert.strictEqual(req.files.tiny0[0].originalname, 'tiny0.dat')
assert.strictEqual(req.files.tiny0[0].size, 122)
assert.strictEqual(util.fileSize(req.files.tiny0[0].path), 122)
assert.strictEqual(req.files.tiny1[0].fieldname, 'tiny1')
assert.strictEqual(req.files.tiny1[0].originalname, 'tiny1.dat')
assert.strictEqual(req.files.tiny1[0].size, 7)
assert.strictEqual(util.fileSize(req.files.tiny1[0].path), 7)
assert.strictEqual(req.files.small0[0].fieldname, 'small0')
assert.strictEqual(req.files.small0[0].originalname, 'small0.dat')
assert.strictEqual(req.files.small0[0].size, 1778)
assert.strictEqual(util.fileSize(req.files.small0[0].path), 1778)
assert.strictEqual(req.files.small1[0].fieldname, 'small1')
assert.strictEqual(req.files.small1[0].originalname, 'small1.dat')
assert.strictEqual(req.files.small1[0].size, 315)
assert.strictEqual(util.fileSize(req.files.small1[0].path), 315)
assert.strictEqual(req.files.medium[0].fieldname, 'medium')
assert.strictEqual(req.files.medium[0].originalname, 'medium.dat')
assert.strictEqual(req.files.medium[0].size, 13196)
assert.strictEqual(util.fileSize(req.files.medium[0].path), 13196)
assert.strictEqual(req.files.large[0].fieldname, 'large')
assert.strictEqual(req.files.large[0].originalname, 'large.jpg')
assert.strictEqual(req.files.large[0].size, 2413677)
assert.strictEqual(util.fileSize(req.files.large[0].path), 2413677)
done()
})
})
it('should remove uploaded files on error', function (done) {
var form = new FormData()
var parser = upload.single('tiny0')
form.append('tiny0', util.file('tiny0.dat'))
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'small0')
assert(deepEqual(err.storageErrors, []))
var files = fs.readdirSync(uploadDir)
assert(deepEqual(files, []))
done()
})
})
it('should report error when directory doesn\'t exist', function (done) {
var directory = path.join(temp.mkdirSync(), 'ghost')
function dest ($0, $1, cb) { cb(null, directory) }
var storage = multer.diskStorage({ destination: dest })
var upload = multer({ storage: storage })
var parser = upload.single('tiny0')
var form = new FormData()
form.append('tiny0', util.file('tiny0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'ENOENT')
assert.strictEqual(path.dirname(err.path), directory)
done()
})
})
})
================================================
FILE: test/error-handling.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var os = require('os')
var util = require('./_util')
var multer = require('../')
var removeUploadedFiles = require('../lib/remove-uploaded-files')
var stream = require('stream')
var FormData = require('form-data')
var http = require('http')
var net = require('net')
function withLimits (limits, fields) {
var storage = multer.memoryStorage()
return multer({ storage: storage, limits: limits }).fields(fields)
}
describe('Error Handling', function () {
it('should be an instance of both `Error` and `MulterError` classes in case of the Multer\'s error', function (done) {
var form = new FormData()
var storage = multer.diskStorage({ destination: os.tmpdir() })
var upload = multer({ storage: storage }).fields([
{ name: 'small0', maxCount: 1 }
])
form.append('small0', util.file('small0.dat'))
form.append('small0', util.file('small0.dat'))
util.submitForm(upload, form, function (err, req) {
assert.strictEqual(err instanceof Error, true)
assert.strictEqual(err instanceof multer.MulterError, true)
done()
})
})
it('should respect parts limit', function (done) {
var form = new FormData()
var parser = withLimits({ parts: 1 }, [
{ name: 'small0', maxCount: 1 }
])
form.append('field0', 'BOOM!')
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_PART_COUNT')
done()
})
})
it('should respect file size limit', function (done) {
var form = new FormData()
var parser = withLimits({ fileSize: 1500 }, [
{ name: 'tiny0', maxCount: 1 },
{ name: 'small0', maxCount: 1 }
])
form.append('tiny0', util.file('tiny0.dat'))
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FILE_SIZE')
assert.strictEqual(err.field, 'small0')
done()
})
})
it('should respect file count limit', function (done) {
var form = new FormData()
var parser = withLimits({ files: 1 }, [
{ name: 'small0', maxCount: 1 },
{ name: 'small1', maxCount: 1 }
])
form.append('small0', util.file('small0.dat'))
form.append('small1', util.file('small1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FILE_COUNT')
done()
})
})
it('should respect file key limit', function (done) {
var form = new FormData()
var parser = withLimits({ fieldNameSize: 4 }, [
{ name: 'small0', maxCount: 1 }
])
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FIELD_KEY')
done()
})
})
it('should respect field key limit', function (done) {
var form = new FormData()
var parser = withLimits({ fieldNameSize: 4 }, [])
form.append('ok', 'SMILE')
form.append('blowup', 'BOOM!')
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FIELD_KEY')
done()
})
})
it('should respect field value limit', function (done) {
var form = new FormData()
var parser = withLimits({ fieldSize: 16 }, [])
form.append('field0', 'This is okay')
form.append('field1', 'This will make the parser explode')
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FIELD_VALUE')
assert.strictEqual(err.field, 'field1')
done()
})
})
it('should respect field count limit', function (done) {
var form = new FormData()
var parser = withLimits({ fields: 1 }, [])
form.append('field0', 'BOOM!')
form.append('field1', 'BOOM!')
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FIELD_COUNT')
done()
})
})
it('should respect fields given', function (done) {
var form = new FormData()
var parser = withLimits(undefined, [
{ name: 'wrongname', maxCount: 1 }
])
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'small0')
done()
})
})
it('should notify of missing field name', function (done) {
var req = new stream.PassThrough()
var storage = multer.memoryStorage()
var upload = multer({ storage: storage }).single('tiny0')
var boundary = 'AaB03x'
var body = [
'--' + boundary,
'Content-Disposition: form-data',
'',
'test content',
'--' + boundary,
''
].join('\r\n')
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
req.end(body)
upload(req, null, function (err) {
assert.strictEqual(err.code, 'MISSING_FIELD_NAME')
done()
})
})
it('should notify of missing field name', function (done) {
var form = new FormData()
var storage = multer.memoryStorage()
var parser = multer({ storage: storage }).single('small0')
form.append('', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'MISSING_FIELD_NAME')
done()
})
})
it('should report errors from storage engines', function (done) {
var storage = multer.memoryStorage()
storage._removeFile = function _removeFile (req, file, cb) {
var err = new Error('Test error')
err.code = 'TEST'
cb(err)
}
var form = new FormData()
var upload = multer({ storage: storage })
var parser = upload.single('tiny0')
form.append('tiny0', util.file('tiny0.dat'))
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'small0')
assert.strictEqual(err.storageErrors.length, 1)
assert.strictEqual(err.storageErrors[0].code, 'TEST')
assert.strictEqual(err.storageErrors[0].field, 'tiny0')
assert.strictEqual(err.storageErrors[0].file, req.file)
done()
})
})
it('should report errors from busboy constructor', function (done) {
var req = new stream.PassThrough()
var storage = multer.memoryStorage()
var upload = multer({ storage: storage }).single('tiny0')
var body = 'test'
req.headers = {
'content-type': 'multipart/form-data',
'content-length': body.length
}
req.end(body)
upload(req, null, function (err) {
assert.strictEqual(err.message, 'Multipart: Boundary not found')
done()
})
})
it('should report errors from busboy parsing', function (done) {
var req = new stream.PassThrough()
var storage = multer.memoryStorage()
var upload = multer({ storage: storage }).single('tiny0')
var boundary = 'AaB03x'
var body = [
'--' + boundary,
'Content-Disposition: form-data; name="tiny0"; filename="test.txt"',
'Content-Type: text/plain',
'',
'test without end boundary'
].join('\r\n')
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
req.end(body)
upload(req, null, function (err) {
assert.strictEqual(err.message, 'Unexpected end of form')
done()
})
})
it('should gracefully handle more than one error at a time', function (done) {
var form = new FormData()
var storage = multer.diskStorage({ destination: os.tmpdir() })
var upload = multer({ storage: storage, limits: { fileSize: 1, files: 1 } }).fields([
{ name: 'small0', maxCount: 1 }
])
form.append('small0', util.file('small0.dat'))
form.append('small0', util.file('small0.dat'))
util.submitForm(upload, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_FILE_SIZE')
done()
})
})
it('should allow client to finish sending body before error response', function (done) {
this.timeout(10000)
var upload = multer({ storage: multer.memoryStorage() }).single('expected')
var server = http.createServer(function (req, res) {
upload(req, res, function (err) {
res.statusCode = err ? 500 : 200
res.end(err ? err.code : 'OK')
})
})
server.listen(0, function () {
var port = server.address().port
var boundary = 'Drain' + Date.now()
var preamble = [
'--' + boundary,
'Content-Disposition: form-data; name="unexpected"; filename="test.bin"',
'Content-Type: application/octet-stream',
'',
''
].join('\r\n')
var footer = '\r\n--' + boundary + '--\r\n'
var chunk = Buffer.alloc(32 * 1024, 97)
var totalChunks = 24
var contentLength = Buffer.byteLength(preamble) +
(chunk.length * totalChunks) +
Buffer.byteLength(footer)
var sock = new net.Socket()
var socketError = null
var response = ''
var sentChunks = 0
var finished = false
var timeout = setTimeout(function () {
if (finished) return
finished = true
sock.destroy()
server.close(function () {
done(new Error('timed out while uploading request body'))
})
}, 8000)
function finish (err) {
if (finished) return
finished = true
clearTimeout(timeout)
server.close(function () {
done(err)
})
}
function writeChunk () {
if (sentChunks >= totalChunks) {
sock.write(footer)
return
}
sentChunks += 1
var canContinue = sock.write(chunk)
if (canContinue) {
setTimeout(writeChunk, 2)
} else {
sock.once('drain', function () {
setTimeout(writeChunk, 2)
})
}
}
sock.connect(port, '127.0.0.1', function () {
sock.write(
'POST / HTTP/1.1\r\n' +
'Host: localhost\r\n' +
'Connection: close\r\n' +
'Content-Type: multipart/form-data; boundary=' + boundary + '\r\n' +
'Content-Length: ' + contentLength + '\r\n\r\n'
)
sock.write(preamble)
writeChunk()
})
sock.on('data', function (buf) {
response += buf.toString('utf8')
})
sock.on('error', function (err) {
socketError = err
})
sock.on('close', function () {
if (socketError) return finish(socketError)
try {
assert.strictEqual(sentChunks, totalChunks)
assert.ok(/HTTP\/1\.1 500/.test(response))
finish()
} catch (err) {
finish(err)
}
})
})
})
it('should not hang when client aborts multipart upload', function (done) {
this.timeout(5000)
var upload = multer({ storage: multer.memoryStorage() }).any()
var server = http.createServer(function (req, res) {
var hung = false
var timer = setTimeout(function () {
hung = true
server.close()
done(new Error('Middleware hung when client aborted request'))
}, 1000)
upload(req, res, function (/* err */) {
if (hung) return
clearTimeout(timer)
server.close()
done()
})
})
server.listen(0, function () {
var port = server.address().port
var boundary = 'PoC' + Date.now()
var sock = new net.Socket()
sock.connect(port, '127.0.0.1', function () {
sock.write(
'POST / HTTP/1.1\r\n' +
'Host: localhost\r\n' +
'Content-Type: multipart/form-data; boundary=' + boundary + '\r\n' +
'Content-Length: 999999\r\n\r\n' +
'--' + boundary + '\r\n' +
'Content-Disposition: form-data; name="file"; filename="test.bin"\r\n' +
'Content-Type: application/octet-stream\r\n\r\n' +
'AAAAAAAAAAAAAAAA'
)
setTimeout(function () {
sock.destroy()
}, 50)
})
sock.on('error', function () {})
})
})
it('should not overflow call stack when cleaning up many files (memory storage sync remove)', function (done) {
// - without setImmediate in remove-uploaded-files, synchronous _removeFile (e.g. memory storage)
// causes handleFile(0) -> remove -> cb() -> handleFile(1) -> ... in one stack,
// leading to "Maximum call stack size exceeded"
// - use enough files to exceed typical node stack depth (~10k - 30k)
this.timeout(10 * 1000)
var fileCount = 25000
var uploadedFiles = []
for (var i = 0; i < fileCount; i++) {
uploadedFiles.push({ fieldname: 'file', originalname: 'f.dat', buffer: Buffer.alloc(0) })
}
function syncRemove (file, cb) {
delete file.buffer
cb(null)
}
removeUploadedFiles(uploadedFiles, syncRemove, function (err, errors) {
assert.ifError(err)
assert.strictEqual(errors.length, 0)
done()
})
})
})
================================================
FILE: test/expected-files.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
describe('Expected files', function () {
var upload
before(function (done) {
upload = multer()
done()
})
it('should reject single unexpected file', function (done) {
var form = new FormData()
var parser = upload.single('butme')
form.append('notme', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'notme')
done()
})
})
it('should reject array of multiple files', function (done) {
var form = new FormData()
var parser = upload.array('butme', 4)
form.append('notme', util.file('small0.dat'))
form.append('notme', util.file('small1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'notme')
done()
})
})
it('should reject overflowing arrays', function (done) {
var form = new FormData()
var parser = upload.array('butme', 1)
form.append('butme', util.file('small0.dat'))
form.append('butme', util.file('small1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'butme')
done()
})
})
it('should accept files with expected fieldname', function (done) {
var form = new FormData()
var parser = upload.fields([
{ name: 'butme', maxCount: 2 },
{ name: 'andme', maxCount: 2 }
])
form.append('butme', util.file('small0.dat'))
form.append('butme', util.file('small1.dat'))
form.append('andme', util.file('empty.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.butme.length, 2)
assert.strictEqual(req.files.andme.length, 1)
done()
})
})
it('should reject files with unexpected fieldname', function (done) {
var form = new FormData()
var parser = upload.fields([
{ name: 'butme', maxCount: 2 },
{ name: 'andme', maxCount: 2 }
])
form.append('butme', util.file('small0.dat'))
form.append('butme', util.file('small1.dat'))
form.append('andme', util.file('empty.dat'))
form.append('notme', util.file('empty.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(err.field, 'notme')
done()
})
})
it('should allow any file to come thru', function (done) {
var form = new FormData()
var parser = upload.any()
form.append('butme', util.file('small0.dat'))
form.append('butme', util.file('small1.dat'))
form.append('andme', util.file('empty.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.length, 3)
assert.strictEqual(req.files[0].fieldname, 'butme')
assert.strictEqual(req.files[1].fieldname, 'butme')
assert.strictEqual(req.files[2].fieldname, 'andme')
done()
})
})
})
================================================
FILE: test/express-integration.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var http = require('http')
var multer = require('../')
var util = require('./_util')
var express = require('express')
var FormData = require('form-data')
var concat = require('concat-stream')
var port = 34279
describe('Express Integration', function () {
var app
before(function (done) {
app = express()
app.listen(port, done)
})
function submitForm (form, path, cb) {
var req = form.submit('http://localhost:' + port + path)
req.on('error', cb)
req.on('response', function (res) {
res.on('error', cb)
res.pipe(concat({ encoding: 'buffer' }, function (body) {
cb(null, res, body)
}))
})
}
it('should work with express error handling', function (done) {
var limits = { fileSize: 200 }
var upload = multer({ limits: limits })
var router = new express.Router()
var form = new FormData()
var routeCalled = 0
var errorCalled = 0
form.append('avatar', util.file('large.jpg'))
router.post('/profile', upload.single('avatar'), function (req, res, next) {
routeCalled++
res.status(200).end('SUCCESS')
})
router.use(function (err, req, res, next) {
assert.strictEqual(err.code, 'LIMIT_FILE_SIZE')
errorCalled++
res.status(500).end('ERROR')
})
app.use('/t1', router)
submitForm(form, '/t1/profile', function (err, res, body) {
assert.ifError(err)
assert.strictEqual(routeCalled, 0)
assert.strictEqual(errorCalled, 1)
assert.strictEqual(body.toString(), 'ERROR')
assert.strictEqual(res.statusCode, 500)
done()
})
})
it('should work when receiving error from fileFilter', function (done) {
function fileFilter (req, file, cb) {
cb(new Error('TEST'))
}
var upload = multer({ fileFilter: fileFilter })
var router = new express.Router()
var form = new FormData()
var routeCalled = 0
var errorCalled = 0
form.append('avatar', util.file('large.jpg'))
router.post('/profile', upload.single('avatar'), function (req, res, next) {
routeCalled++
res.status(200).end('SUCCESS')
})
router.use(function (err, req, res, next) {
assert.strictEqual(err.message, 'TEST')
errorCalled++
res.status(500).end('ERROR')
})
app.use('/t2', router)
submitForm(form, '/t2/profile', function (err, res, body) {
assert.ifError(err)
assert.strictEqual(routeCalled, 0)
assert.strictEqual(errorCalled, 1)
assert.strictEqual(body.toString(), 'ERROR')
assert.strictEqual(res.statusCode, 500)
done()
})
})
it('should not crash on malformed request', function (done) {
var upload = multer()
app.post('/upload', upload.single('file'), function (req, res) {
res.status(500).end('Request should not be processed')
})
app.use(function (err, req, res, next) {
assert.strictEqual(err.message, 'Unexpected end of form')
res.status(200).end('Correct error')
})
var boundary = 'AaB03x'
var body = [
'--' + boundary,
'Content-Disposition: form-data; name="file"; filename="test.txt"',
'Content-Type: text/plain',
'',
'test without end boundary'
].join('\r\n')
var options = {
hostname: 'localhost',
port,
path: '/upload',
method: 'POST',
headers: {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
}
var req = http.request(options, (res) => {
assert.strictEqual(res.statusCode, 200)
done()
})
req.on('error', (err) => {
done(err)
})
req.write(body)
req.end()
})
it('should not crash on malformed request that causes two errors to be emitted by busboy', function (done) {
var upload = multer()
app.post('/upload2', upload.single('file'), function (req, res) {
res.status(500).end('Request should not be processed')
})
app.use(function (err, req, res, next) {
assert.strictEqual(err.message, 'Malformed part header')
res.status(200).end('Correct error')
})
var boundary = 'AaB03x'
// this payload causes two errors to be emitted by busboy: `Malformed part header` and `Unexpected end of form`
var body = [
'--' + boundary,
'Content-Disposition: form-data; name="file"; filename="test.txt"',
'Content-Type: text/plain',
'',
'--' + boundary + '--',
''
].join('\r\n')
var options = {
hostname: 'localhost',
port,
path: '/upload2',
method: 'POST',
headers: {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
}
var req = http.request(options, (res) => {
assert.strictEqual(res.statusCode, 200)
done()
})
req.on('error', (err) => {
done(err)
})
req.write(body)
req.end()
})
it('should not crash on malformed multipart body with bad boundary', function (done) {
var upload = multer()
app.post('/upload3', upload.single('image'), function (req, res) {
res.status(500).end('Request should not be processed')
})
app.use(function (err, req, res, next) {
assert.strictEqual(err.message, 'Unexpected end of form')
res.status(200).end('Correct error')
})
var boundary = '----FormBoundary'
var body = [
'------FormBoundary',
'Content-Disposition: form-data; name="image"; filename=""',
'Content-Type: application/octet-stream',
'',
'', // empty content
'------FormBoundar' // intentionally malformed final boundary (missing 'y')
].join('\r\n')
var options = {
hostname: 'localhost',
port,
path: '/upload3',
method: 'POST',
headers: {
'Content-Type': 'multipart/form-data; boundary=' + boundary,
'Content-Length': Buffer.byteLength(body)
}
}
var req = http.request(options, (res) => {
assert.strictEqual(res.statusCode, 200)
done()
})
req.write(body)
req.end()
})
})
================================================
FILE: test/fields.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var deepEqual = require('deep-equal')
var stream = require('stream')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
var testData = require('testdata-w3c-json-form')
describe('Fields', function () {
var parser
before(function () {
parser = multer().fields([])
})
it('should process multiple fields', function (done) {
var form = new FormData()
form.append('name', 'Multer')
form.append('key', 'value')
form.append('abc', 'xyz')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, {
name: 'Multer',
key: 'value',
abc: 'xyz'
}))
done()
})
})
it('should process empty fields', function (done) {
var form = new FormData()
form.append('name', 'Multer')
form.append('key', '')
form.append('abc', '')
form.append('checkboxfull', 'cb1')
form.append('checkboxfull', 'cb2')
form.append('checkboxhalfempty', 'cb1')
form.append('checkboxhalfempty', '')
form.append('checkboxempty', '')
form.append('checkboxempty', '')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, {
name: 'Multer',
key: '',
abc: '',
checkboxfull: ['cb1', 'cb2'],
checkboxhalfempty: ['cb1', ''],
checkboxempty: ['', '']
}))
done()
})
})
it('should not process non-multipart POST request', function (done) {
var req = new stream.PassThrough()
req.end('name=Multer')
req.method = 'POST'
req.headers = {
'content-type': 'application/x-www-form-urlencoded',
'content-length': 11
}
parser(req, null, function (err) {
assert.ifError(err)
assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'body'), false)
assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'files'), false)
done()
})
})
it('should not process non-multipart GET request', function (done) {
var req = new stream.PassThrough()
req.end('name=Multer')
req.method = 'GET'
req.headers = {
'content-type': 'application/x-www-form-urlencoded',
'content-length': 11
}
parser(req, null, function (err) {
assert.ifError(err)
assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'body'), false)
assert.strictEqual(Object.prototype.hasOwnProperty.call(req, 'files'), false)
done()
})
})
testData.forEach(function (test) {
it('should handle ' + test.name, function (done) {
var form = new FormData()
test.fields.forEach(function (field) {
form.append(field.key, field.value)
})
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, test.expected))
done()
})
})
})
it('should convert arrays into objects', function (done) {
var form = new FormData()
form.append('obj[0]', 'a')
form.append('obj[2]', 'c')
form.append('obj[x]', 'yz')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, {
obj: {
0: 'a',
2: 'c',
x: 'yz'
}
}))
done()
})
})
})
================================================
FILE: test/file-filter.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
function withFilter (fileFilter) {
return multer({ fileFilter: fileFilter })
}
function skipSpecificFile (req, file, cb) {
cb(null, file.fieldname !== 'notme')
}
function reportFakeError (req, file, cb) {
cb(new Error('Fake error'))
}
describe('File Filter', function () {
it('should skip some files', function (done) {
var form = new FormData()
var upload = withFilter(skipSpecificFile)
var parser = upload.fields([
{ name: 'notme', maxCount: 1 },
{ name: 'butme', maxCount: 1 }
])
form.append('notme', util.file('tiny0.dat'))
form.append('butme', util.file('tiny1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.notme, undefined)
assert.strictEqual(req.files.butme[0].fieldname, 'butme')
assert.strictEqual(req.files.butme[0].originalname, 'tiny1.dat')
assert.strictEqual(req.files.butme[0].size, 7)
assert.strictEqual(req.files.butme[0].buffer.length, 7)
done()
})
})
it('should report errors from fileFilter', function (done) {
var form = new FormData()
var upload = withFilter(reportFakeError)
var parser = upload.single('test')
form.append('test', util.file('tiny0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.strictEqual(err.message, 'Fake error')
done()
})
})
})
================================================
FILE: test/file-ordering.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
describe('File ordering', function () {
it('should present files in same order as they came', function (done) {
var storage = multer.memoryStorage()
var upload = multer({ storage: storage })
var parser = upload.array('themFiles', 2)
var i = 0
var calls = [{}, {}]
var pending = 2
var _handleFile = storage._handleFile
storage._handleFile = function (req, file, cb) {
var id = (i++)
_handleFile.call(this, req, file, function (err, info) {
if (err) return cb(err)
calls[id].cb = cb
calls[id].info = info
if (--pending === 0) {
calls[1].cb(null, calls[1].info)
calls[0].cb(null, calls[0].info)
}
})
}
var form = new FormData()
form.append('themFiles', util.file('small0.dat'))
form.append('themFiles', util.file('small1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.length, 2)
assert.strictEqual(req.files[0].originalname, 'small0.dat')
assert.strictEqual(req.files[1].originalname, 'small1.dat')
done()
})
})
})
================================================
FILE: test/functionality.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var temp = require('fs-temp')
var rimraf = require('rimraf')
var FormData = require('form-data')
function generateFilename (req, file, cb) {
cb(null, file.fieldname + file.originalname)
}
function startsWith (str, start) {
return (str.substring(0, start.length) === start)
}
describe('Functionality', function () {
var cleanup = []
function makeStandardEnv (cb) {
temp.mkdir(function (err, uploadDir) {
if (err) return cb(err)
cleanup.push(uploadDir)
var storage = multer.diskStorage({
destination: uploadDir,
filename: generateFilename
})
cb(null, {
upload: multer({ storage: storage }),
uploadDir: uploadDir,
form: new FormData()
})
})
}
after(function () {
while (cleanup.length) rimraf.sync(cleanup.pop())
})
it('should upload the file to the `dest` dir', function (done) {
makeStandardEnv(function (err, env) {
if (err) return done(err)
var parser = env.upload.single('small0')
env.form.append('small0', util.file('small0.dat'))
util.submitForm(parser, env.form, function (err, req) {
assert.ifError(err)
assert.ok(startsWith(req.file.path, env.uploadDir))
assert.strictEqual(util.fileSize(req.file.path), 1778)
done()
})
})
})
it('should rename the uploaded file', function (done) {
makeStandardEnv(function (err, env) {
if (err) return done(err)
var parser = env.upload.single('small0')
env.form.append('small0', util.file('small0.dat'))
util.submitForm(parser, env.form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.file.filename, 'small0small0.dat')
done()
})
})
})
it('should ensure all req.files values (single-file per field) point to an array', function (done) {
makeStandardEnv(function (err, env) {
if (err) return done(err)
var parser = env.upload.single('tiny0')
env.form.append('tiny0', util.file('tiny0.dat'))
util.submitForm(parser, env.form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.file.filename, 'tiny0tiny0.dat')
done()
})
})
})
it('should ensure all req.files values (multi-files per field) point to an array', function (done) {
makeStandardEnv(function (err, env) {
if (err) return done(err)
var parser = env.upload.array('themFiles', 2)
env.form.append('themFiles', util.file('small0.dat'))
env.form.append('themFiles', util.file('small1.dat'))
util.submitForm(parser, env.form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.length, 2)
assert.strictEqual(req.files[0].filename, 'themFilessmall0.dat')
assert.strictEqual(req.files[1].filename, 'themFilessmall1.dat')
done()
})
})
})
it('should rename the destination directory to a different directory', function (done) {
var storage = multer.diskStorage({
destination: function (req, file, cb) {
temp.template('testforme-%s').mkdir(function (err, uploadDir) {
if (err) return cb(err)
cleanup.push(uploadDir)
cb(null, uploadDir)
})
},
filename: generateFilename
})
var form = new FormData()
var upload = multer({ storage: storage })
var parser = upload.array('themFiles', 2)
form.append('themFiles', util.file('small0.dat'))
form.append('themFiles', util.file('small1.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files.length, 2)
assert.ok(req.files[0].path.indexOf('/testforme-') >= 0)
assert.ok(req.files[1].path.indexOf('/testforme-') >= 0)
done()
})
})
})
================================================
FILE: test/issue-232.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var temp = require('fs-temp')
var rimraf = require('rimraf')
var FormData = require('form-data')
describe('Issue #232', function () {
var uploadDir, upload
before(function (done) {
temp.mkdir(function (err, path) {
if (err) return done(err)
uploadDir = path
upload = multer({ dest: path, limits: { fileSize: 100 } })
done()
})
})
after(function (done) {
rimraf(uploadDir, done)
})
it('should report limit errors', function (done) {
var form = new FormData()
var parser = upload.single('file')
form.append('file', util.file('large.jpg'))
util.submitForm(parser, form, function (err, req) {
assert.ok(err, 'an error was given')
assert.strictEqual(err.code, 'LIMIT_FILE_SIZE')
assert.strictEqual(err.field, 'file')
done()
})
})
})
================================================
FILE: test/memory-storage.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var deepEqual = require('deep-equal')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
describe('Memory Storage', function () {
var upload
before(function (done) {
upload = multer()
done()
})
it('should process multipart/form-data POST request', function (done) {
var form = new FormData()
var parser = upload.single('small0')
form.append('name', 'Multer')
form.append('small0', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.body.name, 'Multer')
assert.strictEqual(req.file.fieldname, 'small0')
assert.strictEqual(req.file.originalname, 'small0.dat')
assert.strictEqual(req.file.size, 1778)
assert.strictEqual(req.file.buffer.length, 1778)
done()
})
})
it('should process empty fields and an empty file', function (done) {
var form = new FormData()
var parser = upload.single('empty')
form.append('empty', util.file('empty.dat'))
form.append('name', 'Multer')
form.append('version', '')
form.append('year', '')
form.append('checkboxfull', 'cb1')
form.append('checkboxfull', 'cb2')
form.append('checkboxhalfempty', 'cb1')
form.append('checkboxhalfempty', '')
form.append('checkboxempty', '')
form.append('checkboxempty', '')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.body.name, 'Multer')
assert.strictEqual(req.body.version, '')
assert.strictEqual(req.body.year, '')
assert(deepEqual(req.body.checkboxfull, ['cb1', 'cb2']))
assert(deepEqual(req.body.checkboxhalfempty, ['cb1', '']))
assert(deepEqual(req.body.checkboxempty, ['', '']))
assert.strictEqual(req.file.fieldname, 'empty')
assert.strictEqual(req.file.originalname, 'empty.dat')
assert.strictEqual(req.file.size, 0)
assert.strictEqual(req.file.buffer.length, 0)
assert.strictEqual(Buffer.isBuffer(req.file.buffer), true)
done()
})
})
it('should process multiple files', function (done) {
var form = new FormData()
var parser = upload.fields([
{ name: 'empty', maxCount: 1 },
{ name: 'tiny0', maxCount: 1 },
{ name: 'tiny1', maxCount: 1 },
{ name: 'small0', maxCount: 1 },
{ name: 'small1', maxCount: 1 },
{ name: 'medium', maxCount: 1 },
{ name: 'large', maxCount: 1 }
])
form.append('empty', util.file('empty.dat'))
form.append('tiny0', util.file('tiny0.dat'))
form.append('tiny1', util.file('tiny1.dat'))
form.append('small0', util.file('small0.dat'))
form.append('small1', util.file('small1.dat'))
form.append('medium', util.file('medium.dat'))
form.append('large', util.file('large.jpg'))
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert(deepEqual(req.body, {}))
assert.strictEqual(req.files.empty[0].fieldname, 'empty')
assert.strictEqual(req.files.empty[0].originalname, 'empty.dat')
assert.strictEqual(req.files.empty[0].size, 0)
assert.strictEqual(req.files.empty[0].buffer.length, 0)
assert.strictEqual(req.files.tiny0[0].fieldname, 'tiny0')
assert.strictEqual(req.files.tiny0[0].originalname, 'tiny0.dat')
assert.strictEqual(req.files.tiny0[0].size, 122)
assert.strictEqual(req.files.tiny0[0].buffer.length, 122)
assert.strictEqual(req.files.tiny1[0].fieldname, 'tiny1')
assert.strictEqual(req.files.tiny1[0].originalname, 'tiny1.dat')
assert.strictEqual(req.files.tiny1[0].size, 7)
assert.strictEqual(req.files.tiny1[0].buffer.length, 7)
assert.strictEqual(req.files.small0[0].fieldname, 'small0')
assert.strictEqual(req.files.small0[0].originalname, 'small0.dat')
assert.strictEqual(req.files.small0[0].size, 1778)
assert.strictEqual(req.files.small0[0].buffer.length, 1778)
assert.strictEqual(req.files.small1[0].fieldname, 'small1')
assert.strictEqual(req.files.small1[0].originalname, 'small1.dat')
assert.strictEqual(req.files.small1[0].size, 315)
assert.strictEqual(req.files.small1[0].buffer.length, 315)
assert.strictEqual(req.files.medium[0].fieldname, 'medium')
assert.strictEqual(req.files.medium[0].originalname, 'medium.dat')
assert.strictEqual(req.files.medium[0].size, 13196)
assert.strictEqual(req.files.medium[0].buffer.length, 13196)
assert.strictEqual(req.files.large[0].fieldname, 'large')
assert.strictEqual(req.files.large[0].originalname, 'large.jpg')
assert.strictEqual(req.files.large[0].size, 2413677)
assert.strictEqual(req.files.large[0].buffer.length, 2413677)
done()
})
})
})
================================================
FILE: test/none.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
describe('None', function () {
var parser
before(function () {
parser = multer().none()
})
it('should not allow file uploads', function (done) {
var form = new FormData()
form.append('key1', 'val1')
form.append('key2', 'val2')
form.append('file', util.file('small0.dat'))
util.submitForm(parser, form, function (err, req) {
assert.ok(err)
assert.strictEqual(err.code, 'LIMIT_UNEXPECTED_FILE')
assert.strictEqual(req.files, undefined)
assert.strictEqual(req.body.key1, 'val1')
assert.strictEqual(req.body.key2, 'val2')
done()
})
})
it('should handle text fields', function (done) {
var form = new FormData()
form.append('key1', 'val1')
form.append('key2', 'val2')
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.files, undefined)
assert.strictEqual(req.body.key1, 'val1')
assert.strictEqual(req.body.key2, 'val2')
done()
})
})
})
================================================
FILE: test/reuse-middleware.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
describe('Reuse Middleware', function () {
var parser
before(function (done) {
parser = multer().array('them-files')
done()
})
it('should accept multiple requests', function (done) {
var pending = 8
function submitData (fileCount) {
var form = new FormData()
form.append('name', 'Multer')
form.append('files', '' + fileCount)
for (var i = 0; i < fileCount; i++) {
form.append('them-files', util.file('small0.dat'))
}
util.submitForm(parser, form, function (err, req) {
assert.ifError(err)
assert.strictEqual(req.body.name, 'Multer')
assert.strictEqual(req.body.files, '' + fileCount)
assert.strictEqual(req.files.length, fileCount)
req.files.forEach(function (file) {
assert.strictEqual(file.fieldname, 'them-files')
assert.strictEqual(file.originalname, 'small0.dat')
assert.strictEqual(file.size, 1778)
assert.strictEqual(file.buffer.length, 1778)
})
if (--pending === 0) done()
})
}
submitData(9)
submitData(1)
submitData(5)
submitData(7)
submitData(2)
submitData(8)
submitData(3)
submitData(4)
})
})
================================================
FILE: test/select-field.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var util = require('./_util')
var multer = require('../')
var FormData = require('form-data')
function generateForm () {
var form = new FormData()
form.append('CA$|-|', util.file('empty.dat'))
form.append('set-1', util.file('tiny0.dat'))
form.append('set-1', util.file('empty.dat'))
form.append('set-1', util.file('tiny1.dat'))
form.append('set-2', util.file('tiny1.dat'))
form.append('set-2', util.file('tiny0.dat'))
form.append('set-2', util.file('empty.dat'))
return form
}
function assertSet (files, setName, fileNames) {
var len = fileNames.length
assert.strictEqual(files.length, len)
for (var i = 0; i < len; i++) {
assert.strictEqual(files[i].fieldname, setName)
assert.strictEqual(files[i].originalname, fileNames[i])
}
}
describe('Select Field', function () {
var parser
before(function () {
parser = multer().fields([
{ name: 'CA$|-|', maxCount: 1 },
{ name: 'set-1', maxCount: 3 },
{ name: 'set-2', maxCount: 3 }
])
})
it('should select the first file with fieldname', function (done) {
util.submitForm(parser, generateForm(), function (err, req) {
assert.ifError(err)
var file
file = req.files['CA$|-|'][0]
assert.strictEqual(file.fieldname, 'CA$|-|')
assert.strictEqual(file.originalname, 'empty.dat')
file = req.files['set-1'][0]
assert.strictEqual(file.fieldname, 'set-1')
assert.strictEqual(file.originalname, 'tiny0.dat')
file = req.files['set-2'][0]
assert.strictEqual(file.fieldname, 'set-2')
assert.strictEqual(file.originalname, 'tiny1.dat')
done()
})
})
it('should select all files with fieldname', function (done) {
util.submitForm(parser, generateForm(), function (err, req) {
assert.ifError(err)
assertSet(req.files['CA$|-|'], 'CA$|-|', ['empty.dat'])
assertSet(req.files['set-1'], 'set-1', ['tiny0.dat', 'empty.dat', 'tiny1.dat'])
assertSet(req.files['set-2'], 'set-2', ['tiny1.dat', 'tiny0.dat', 'empty.dat'])
done()
})
})
})
================================================
FILE: test/unicode.js
================================================
/* eslint-env mocha */
var assert = require('assert')
var multer = require('../')
var temp = require('fs-temp')
var rimraf = require('rimraf')
var stream = require('stream')
describe('Unicode', function () {
var uploadDir, upload
beforeEach(function (done) {
temp.mkdir(function (err, path) {
if (err) return done(err)
var storage = multer.diskStorage({
destination: path,
filename: function (req, file, cb) {
cb(null, file.originalname)
}
})
uploadDir = path
upload = multer({ storage: storage })
done()
})
})
afterEach(function (done) {
rimraf(uploadDir, done)
})
it('should handle unicode filenames', function (done) {
var req = new stream.PassThrough()
var boundary = 'AaB03x'
var body = [
'--' + boundary,
'Content-Disposition: form-data; name="small0"; filename="poo.dat"; filename*=utf-8\'\'%F0%9F%92%A9.dat',
'Content-Type: text/plain',
'',
'test with unicode filename',
'--' + boundary + '--'
].join('\r\n')
req.headers = {
'content-type': 'multipart/form-data; boundary=' + boundary,
'content-length': body.length
}
req.end(body)
upload.single('small0')(req, null, function (err) {
assert.ifError(err)
assert.strictEqual(req.file.originalname, '\ud83d\udca9.dat')
assert.strictEqual(req.file.fieldname, 'small0')
done()
})
})
})