Multer middleware setup in Express

Introduction

Multer helps your Express app handle file uploads easily by processing files sent from users.

When you want users to upload profile pictures on your website.

When you need to accept documents or images through a form.

When building a blog that allows uploading images for posts.

When handling file uploads in an API endpoint.

When you want to save uploaded files to your server or cloud storage.

Syntax

Express

import multer from 'multer';

const upload = multer({ dest: 'uploads/' });

app.post('/upload', upload.single('fileFieldName'), (req, res) => {
  // req.file contains the uploaded file info
  res.send('File uploaded!');
});

Use upload.single('fieldName') for one file, or upload.array('fieldName', maxCount) for multiple files.

The dest option sets the folder where files are saved temporarily.

Examples

Uploads a single file from the form field named 'avatar' and saves it to 'uploads/' folder.

Express

const upload = multer({ dest: 'uploads/' });
app.post('/profile', upload.single('avatar'), (req, res) => {
  res.send('Avatar uploaded');
});

Uploads up to 3 files from the form field named 'photos'.

Express

const upload = multer({ dest: 'uploads/' });
app.post('/photos', upload.array('photos', 3), (req, res) => {
  res.send('Multiple photos uploaded');
});

Customizes where and how files are saved with unique names.

Express

const storage = multer.diskStorage({
  destination: (req, file, cb) => cb(null, 'custom_folder/'),
  filename: (req, file, cb) => cb(null, Date.now() + '-' + file.originalname)
});
const upload = multer({ storage });

Sample Program

This Express app uses Multer to accept one file from the 'file' field and saves it to 'uploads/'. It sends a success message with the original file name.

Express

import express from 'express';
import multer from 'multer';

const app = express();
const upload = multer({ dest: 'uploads/' });

app.post('/upload', upload.single('file'), (req, res) => {
  if (!req.file) {
    return res.status(400).send('No file uploaded.');
  }
  res.send(`File ${req.file.originalname} uploaded successfully.`);
});

app.listen(3000, () => {
  console.log('Server running on http://localhost:3000');
});

Important Notes

Always create the upload folder (e.g., 'uploads/') before running the app or Multer will error.

Multer only processes multipart/form-data requests, so set your form's enctype accordingly.

For security, validate file types and sizes before saving or processing files.

Summary

Multer is middleware for handling file uploads in Express apps.

Use upload.single() or upload.array() to specify how many files to accept.

You can customize file storage location and names with Multer's storage options.

Practice

1. What is the primary purpose of the multer middleware in an Express application?

easy

A. To serve static files like images and CSS

B. To parse JSON data in request bodies

C. To handle file uploads from client requests

D. To manage user sessions and cookies

Solution

1. Step 1: Understand middleware role

   Multer is middleware designed specifically to handle multipart/form-data, which is used for uploading files.

2. Step 2: Compare with other middleware

   Other middleware like body-parser handle JSON, and express.static serves static files, but multer focuses on file uploads.

3. Final Answer:

   To handle file uploads from client requests -> Option C

4. Quick Check:

   Multer = file upload handler [OK]

Hint: Multer is for file uploads, not JSON or sessions [OK]

Common Mistakes:

• Confusing multer with body-parser for JSON parsing
• Thinking multer manages sessions or cookies
• Assuming multer serves static files

2. Which of the following is the correct way to set up multer to accept a single file upload with the field name 'avatar'?

easy

A. const upload = multer().single('avatar');

B. const upload = multer.single('avatar');

C. const upload = multer().array('avatar');

D. const upload = multer().multi('avatar');

Solution

1. Step 1: Correct multer initialization

   Multer must be called as a function to create an instance: multer().

2. Step 2: Use .single() for single file

   To accept one file, use upload.single('fieldname'). Here, 'avatar' is the field name.

3. Final Answer:

   const upload = multer().single('avatar'); -> Option A

4. Quick Check:

   multer() + .single('avatar') = correct setup [OK]

Hint: Always call multer() before .single() or .array() [OK]

Common Mistakes:

• Calling multer.single() without parentheses
• Using .array() instead of .single() for one file
• Using non-existent .multi() method

3. Given this Express route setup with multer:

const multer = require('multer');
const upload = multer({ dest: 'uploads/' });

app.post('/profile', upload.single('photo'), (req, res) => {
  res.send(req.file.path);
});

What will be the response when a user uploads a file named 'pic.jpg' in the 'photo' field?

medium

A. Undefined, because req.file is not set

B. The original filename 'pic.jpg'

C. An error because 'dest' is not a valid option

D. The path where the file is saved, like 'uploads/abc123'

Solution

1. Step 1: Understand multer storage with 'dest'

   Setting 'dest' tells multer to save files to that folder with a generated filename, not the original name.

2. Step 2: Check what req.file.path contains

   req.file.path contains the full path to the saved file, e.g., 'uploads/abc123'.

3. Final Answer:

   The path where the file is saved, like 'uploads/abc123' -> Option D

4. Quick Check:

   dest option saves file with generated name = path returned [OK]

Hint: dest saves file with random name; req.file.path shows saved path [OK]

Common Mistakes:

• Expecting original filename in req.file.path
• Thinking 'dest' is invalid option
• Assuming req.file is undefined without upload

4. Consider this code snippet:

const multer = require('multer');
const upload = multer({ dest: 'uploads/' });

app.post('/upload', upload.single('file'), (req, res) => {
  console.log(req.files);
  res.send('Upload complete');
});

What is the problem with this code?

medium

A. Incorrect destination folder name

B. Using req.files instead of req.file for single file upload

C. Missing call to multer() function

D. upload.single() should be upload.array() for single file

Solution

1. Step 1: Check multer method used

   upload.single('file') handles one file and stores it in req.file (singular).

2. Step 2: Identify incorrect property usage

   The code logs req.files (plural), which is undefined for single file uploads.

3. Final Answer:

   Using req.files instead of req.file for single file upload -> Option B

4. Quick Check:

   single() sets req.file, not req.files [OK]

Hint: Use req.file for single, req.files for multiple uploads [OK]

Common Mistakes:

• Confusing req.file and req.files
• Not calling multer() before .single()
• Using upload.array() when single file expected

5. You want to customize multer to store uploaded files in a folder named 'images' and rename each file to include the current timestamp before the original filename. Which setup correctly achieves this?

hard

A. const storage = multer.diskStorage({ destination: 'images', filename: (req, file, cb) => { cb(null, Date.now() + '-' + file.originalname); } }); const upload = multer({ storage });

B. const storage = multer.diskStorage({ destination: (req, file, cb) => { cb(null, images); }, filename: (req, file, cb) => { cb(null, Date.now() + '-' + file.originalname); } }); const upload = multer({ storage });

C. const storage = multer.diskStorage({ destination: 'images', filename: (req, file, cb) => { cb(null, file.originalname); } }); const upload = multer({ storage });

D. const upload = multer({ dest: 'images', filename: (req, file, cb) => { cb(null, Date.now() + '-' + file.originalname); } });

Solution

1. Step 1: Understand diskStorage options

   diskStorage accepts destination as string or function(req, file, cb); filename must be function(req, file, cb).

2. Step 2: Verify timestamp renaming

   Filename function must call cb(null, Date.now() + '-' + file.originalname).

3. Step 3: Identify correct setup

   const storage = multer.diskStorage({ destination: 'images', filename: (req, file, cb) => { cb(null, Date.now() + '-' + file.originalname); } }); const upload = multer({ storage }); uses valid string destination and correct filename.

4. Final Answer:

   const storage = multer.diskStorage({ destination: 'images', filename: (req, file, cb) => { cb(null, Date.now() + '-' + file.originalname); } }); const upload = multer({ storage }); -> Option A

5. Quick Check:

   destination string + filename(Date.now()) [OK]

Hint: destination: string or fn(); filename: fn() always [OK]

Common Mistakes:

• Using unquoted path in destination function (images vs 'images')
• Passing filename option directly to multer instead of diskStorage
• Not using callback cb in destination or filename