res.download for file downloads in Express - Performance & Optimization

Performance: res.download for file downloads

MEDIUM IMPACT

This affects how quickly a file starts downloading and how server resources are used during the download process.

Serving a file for user download in an Express app

Express

app.get('/file', (req, res) => {
  res.download('/path/to/file.pdf', 'file.pdf', err => {
    if (err) res.status(500).send('Error downloading file');
  });
});

Streams the file directly to the response, freeing memory and allowing faster download start.

📈 Performance GainNon-blocking, low memory use, faster response start

Serving a file for user download in an Express app

Express

app.get('/file', (req, res) => {
  const file = fs.readFileSync('/path/to/file.pdf');
  res.setHeader('Content-Disposition', 'attachment; filename="file.pdf"');
  res.send(file);
});

Reads the entire file into memory before sending, blocking the event loop and increasing memory use.

📉 Performance CostBlocks server during read, high memory usage for large files, slower response start

Performance Comparison

Pattern	DOM Operations	Reflows	Paint Cost	Verdict
res.send with fs.readFileSync	0 (server-side only)	0	0	[X] Bad
res.download streaming file	0 (server-side only)	0	0	[OK] Good

Rendering Pipeline

The server streams the file data directly to the client without buffering the entire file, minimizing server blocking and memory pressure.

→Server File I/O

→Network Transfer

⚠️ BottleneckServer File I/O if file is large or on slow disk

Optimization Tips

1Stream files with res.download to reduce server memory use and speed up download start.

2Avoid reading entire files into memory before sending to prevent blocking the server.

3File downloads do not impact Core Web Vitals related to page rendering.

Performance Quiz - 3 Questions

Why is using res.download better than reading the file fully into memory before sending?

A Because res.download streams the file, reducing memory use and speeding up response start

B Because res.download compresses the file automatically

C Because res.download caches the file in the browser

D Because res.download encrypts the file during transfer

DevTools: Network

How to check: Open DevTools, go to Network tab, request the file download endpoint, and observe the timing and size of the response.

What to look for: Look for fast 'Time to First Byte' and steady data transfer indicating streaming rather than delayed full buffering.

Practice

1. What does res.download() do in an Express app?

easy

A. Uploads a file from the user to the server

B. Sends a file to the user for download

C. Deletes a file on the server

D. Reads a file and logs its content

Solution

1. Step 1: Understand the purpose of res.download

   res.download() is used to send files to users so they can download them easily.

2. Step 2: Compare with other file operations

   Uploading, deleting, or reading files are different operations and not what res.download() does.

3. Final Answer:

   Sends a file to the user for download -> Option B

4. Quick Check:

   res.download() = Sends file [OK]

Hint: Remember: download means sending file to user [OK]

Common Mistakes:

• Confusing download with upload
• Thinking it deletes files
• Assuming it reads file content

2. Which is the correct syntax to send a file named report.pdf for download using res.download?

easy

A. res.download('report.pdf')

B. res.download(report.pdf)

C. res.download('report.pdf', 'download')

D. res.download('report.pdf', {filename: 'download.pdf'})

Solution

1. Step 1: Check the basic usage of res.download

   The first argument is the file path as a string, so res.download('report.pdf') is correct.

2. Step 2: Analyze other options

   res.download(report.pdf) misses quotes making it invalid syntax. res.download('report.pdf', 'download') adds a second argument incorrectly as a string. res.download('report.pdf', {filename: 'download.pdf'}) uses an object which is not valid for filename.

3. Final Answer:

   res.download('report.pdf') -> Option A

4. Quick Check:

   File path string only = res.download('report.pdf') [OK]

Hint: File path must be a string in quotes [OK]

Common Mistakes:

• Omitting quotes around filename
• Passing wrong argument types
• Using object instead of string for filename

3. What will happen when this code runs?

app.get('/file', (req, res) => {
  res.download('files/data.txt', 'info.txt');
});

medium

A. The file 'files/data.txt' is sent and saved as 'info.txt' by the user

B. The file 'info.txt' is sent from the server

C. An error occurs because the second argument is invalid

D. The file 'data.txt' is sent without renaming

Solution

1. Step 1: Understand res.download parameters

   The first argument is the path on the server, the second is the filename for the user.

2. Step 2: Apply to given code

   The server sends 'files/data.txt' but the user will see it saved as 'info.txt'.

3. Final Answer:

   The file 'files/data.txt' is sent and saved as 'info.txt' by the user -> Option A

4. Quick Check:

   res.download(path, filename) renames file [OK]

Hint: Second argument renames file for user [OK]

Common Mistakes:

• Thinking second argument is server file path
• Assuming no renaming happens
• Believing second argument causes error

4. Identify the error in this code snippet:

app.get('/download', (req, res) => {
  res.download();
});

medium

A. res.download requires a callback as first argument

B. res.download cannot be used inside app.get

C. No error, code works fine

D. Missing file path argument in res.download

Solution

1. Step 1: Check res.download required arguments

   res.download() requires at least the file path as the first argument.

2. Step 2: Analyze given code

   The code calls res.download() with no arguments, causing an error.

3. Final Answer:

   Missing file path argument in res.download -> Option D

4. Quick Check:

   res.download needs file path [OK]

Hint: Always provide file path to res.download [OK]

Common Mistakes:

• Calling res.download without arguments
• Thinking res.download needs callback first
• Assuming no error if arguments missing

5. You want to send a file report.pdf for download but also handle errors if the file is missing. Which code correctly does this?

hard

A. res.download('report.pdf', (err) => { if (err) throw err; });

B. res.download('report.pdf').catch(() => res.status(404).send('File not found'));

C. res.download('report.pdf', err => { if (err) res.status(404).send('File not found'); });

D. res.download('report.pdf', 'report.pdf', err => { if (err) res.send('Error'); });

Solution

1. Step 1: Understand error handling in res.download

   res.download accepts an optional callback as the last argument to handle errors.

2. Step 2: Check each option

   res.download('report.pdf', err => { if (err) res.status(404).send('File not found'); }); uses the callback correctly to send 404 if error occurs. res.download('report.pdf').catch(() => res.status(404).send('File not found')); wrongly uses .catch which is not supported. res.download('report.pdf', 'report.pdf', err => { if (err) res.send('Error'); }); has an extra filename argument which is unnecessary here. res.download('report.pdf', (err) => { if (err) throw err; }); throws error instead of handling gracefully.

3. Final Answer:

   res.download('report.pdf', err => { if (err) res.status(404).send('File not found'); }); -> Option C

4. Quick Check:

   Use callback to handle errors in res.download [OK]

Hint: Use callback function to catch errors in res.download [OK]

Common Mistakes:

• Using promises or .catch with res.download
• Not handling errors at all
• Passing wrong number of arguments