Skip to content
Related Articles

Related Articles

Express.js res.attachment() Function
  • Last Updated : 07 Jul, 2020

The res.attachment() function is used to set the HTTP response Content-Disposition header field to ‘attachment’. If the name of the file is given as filename, then it sets the Content-Type based on the extension name through res.type() function and finally sets the Content-Disposition ‘filename = ‘ parameter.

Syntax:

res.attachment( [filename] )

Parameter: The filename parameter describes the the name of the file.

Return Value: It retuns an Object.

Installation of express module:



  1. You can visit the link to Install express module. You can install this package by using this command.
    npm install express
  2. After installing the express module, you can check your express version in command prompt using the command.
    npm version express
  3. After that, you can just create a folder and add a file for example, index.js. To run this file you need to run the following command.
    node index.js

Example 1: Filename: index.js




var express = require('express');
var app = express();
var PORT = 3000;
  
// Without middleware
app.get('/', function(req, res){
    res.attachment('Hello.txt');
    console.log(res.get('Content-Disposition')); 
});
  
app.listen(PORT, function(err){
    if (err) console.log(err);
    console.log("Server listening on PORT", PORT);
});

Place any file in root directory of the project which can be attached, like here we have used Hello.txt.

Steps to run the program:

  1. The project structure will look like this:
  2. Make sure you have installed express module using the following command:
    npm install express
  3. Run index.js file using below command:
    node index.js

    Output:

    Server listening on PORT 3000
    
  4. Open your browser and go to http://localhost:3000/, now you can see the following output on your console:
    Server listening on PORT 3000
    attachment; filename="Hello.txt"
    

    Example 2: Filename: index.js




    var express = require('express');
    var app = express();
    var PORT = 3000;
      
    // With middleware
    app.use('/', function(req, res, next){
        res.attachment('GFG.txt');
        console.log(res.get('Content-Disposition')); 
        next();
    })
      
    app.get('/', function(req, res){
        console.log('Attachment Added'); 
        res.send();
    });
      
    app.listen(PORT, function(err){
        if (err) console.log(err);
        console.log("Server listening on PORT", PORT);
    });

    Run index.js file using below command:

    node index.js

    Open your browser and go to http://localhost:3000/, now you can see the following output on your console:

    Server listening on PORT 3000
    attachment; filename="GFG.txt"
    Attachment Added
    

    Reference: https://expressjs.com/en/5x/api.html#res.attachment

    My Personal Notes arrow_drop_up
Recommended Articles
Page :