content-disposition

Create an attachment Content-Disposition header

Installation

$ npm install content-disposition

API

var contentDisposition = require('content-disposition')

contentDisposition([filename])

Create an attachment Content-Disposition header value using the given file name, if supplied.

res.setHeader('Content-Disposition', contentDisposition('∫ maths.pdf'))

Examples

Send a file for download

var contentDisposition = require('content-disposition')
var destroy = require('destroy')
var http = require('http')
var onFinished = require('on-finished')

var filePath = '/path/to/public/plans.pdf'

http.createServer(function onRequest(req, res) {
  // set headers
  res.setHeader('Content-Type', 'application/pdf')
  res.setHeader('Content-Disposition', contentDisposition(filePath))

  // send file
  var stream = fs.createReadStream(filePath)
  stream.pipe(res)
  onFinished(res, function (err) {
    destroy(stream)
  })
})

Testing

$ npm test

References

• RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1
• RFC 5987: Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters
• RFC 6266: Use of the Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)
• Test Cases for HTTP Content-Disposition header field (RFC 6266) and the Encodings defined in RFCs 2047, 2231 and 5987

License

MIT