npmpackage.info

Gathering detailed insights and metrics for content-disposition

content-disposition

Create and parse HTTP Content-Disposition header

0.5.4

234

MIT

JavaScript

1.55 kB

6.8

Installations

npm install content-disposition

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>= 0.6

Node Version

16.7.0

NPM Version

7.20.3 Score

99.5

Supply Chain

Quality

81.3

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

8

Total

49

Closed

21

Merged

20

Issues

Open

5

Total

32

Closed

27

Releases

0.5.4

v0.5.4

Updated on Dec 10, 2021

0.5.3

v0.5.3

Updated on Dec 17, 2018

0.5.2

v0.5.2

Updated on Dec 09, 2016

0.5.1

v0.5.1

Updated on Jan 17, 2016

0.5.0

v0.5.0

Updated on Oct 11, 2014

0.4.0

v0.4.0

Updated on Sep 21, 2014

View All 12 releases

Languages

JavaScript

JavaScript (100%)

Developer

jshttp

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

234 Stars

153 Commits

45 Forks

15 Watchers

9 Branches

32 Contributors

Updated on Jun 01, 2025

Bundle Size

3.78 kB

Minified

1.55 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 32 Contributors

Package Meta Information

Latest Version

0.5.4

Package Id

content-disposition@0.5.4

Unpacked Size

18.67 kB

Size

6.58 kB

File Count

NPM Version

7.20.3

Node Version

16.7.0

Published on

Dec 10, 2021

Total Downloads

Cumulative downloads

Total Downloads

NaN

Dependencies

safe-buffer

Dev Dependencies

deep-equal eslint eslint-config-standard eslint-plugin-import eslint-plugin-markdown eslint-plugin-node eslint-plugin-promise eslint-plugin-standard istanbul mocha

content-disposition

Create and parse HTTP Content-Disposition header

Installation

1$ npm install content-disposition

API

1var contentDisposition = require('content-disposition')

contentDisposition(filename, options)

Create an attachment Content-Disposition header value using the given file name, if supplied. The filename is optional and if no file name is desired, but you want to specify options, set filename to undefined.

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

note HTTP headers are of the ISO-8859-1 character set. If you are writing this header through a means different from setHeader in Node.js, you'll want to specify the 'binary' encoding in Node.js.

Options

contentDisposition accepts these properties in the options object.

fallback

If the filename option is outside ISO-8859-1, then the file name is actually stored in a supplemental field for clients that support Unicode file names and a ISO-8859-1 version of the file name is automatically generated.

This specifies the ISO-8859-1 file name to override the automatic generation or disables the generation all together, defaults to true.

A string will specify the ISO-8859-1 file name to use in place of automatic generation.
false will disable including a ISO-8859-1 file name and only include the Unicode version (unless the file name is already ISO-8859-1).
true will enable automatic generation if the file name is outside ISO-8859-1.

If the filename option is ISO-8859-1 and this option is specified and has a different value, then the filename option is encoded in the extended field and this set as the fallback field, even though they are both ISO-8859-1.

type

Specifies the disposition type, defaults to "attachment". This can also be "inline", or any other value (all values except inline are treated like attachment, but can convey additional information if both parties agree to it). The type is normalized to lower-case.

contentDisposition.parse(string)

1var disposition = contentDisposition.parse('attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt')

Parse a Content-Disposition header string. This automatically handles extended ("Unicode") parameters by decoding them and providing them under the standard parameter name. This will return an object with the following properties (examples are shown for the string 'attachment; filename="EURO rates.txt"; filename*=UTF-8\'\'%e2%82%ac%20rates.txt'):

type: The disposition type (always lower case). Example: 'attachment'
parameters: An object of the parameters in the disposition (name of parameter always lower case and extended versions replace non-extended versions). Example: {filename: "€ rates.txt"}

Examples

Send a file for download

1var contentDisposition = require('content-disposition')
2var destroy = require('destroy')
3var fs = require('fs')
4var http = require('http')
5var onFinished = require('on-finished')
6
7var filePath = '/path/to/public/plans.pdf'
8
9http.createServer(function onRequest (req, res) {
10  // set headers
11  res.setHeader('Content-Type', 'application/pdf')
12  res.setHeader('Content-Disposition', contentDisposition(filePath))
13
14  // send file
15  var stream = fs.createReadStream(filePath)
16  stream.pipe(res)
17  onFinished(res, function () {
18    destroy(stream)
19  })
20})

Testing

1$ npm test

References

License

MIT

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

9

Security-Policy

Determines if the project has published a security policy.

7

SAST

Determines if the project uses static code analysis.

7

CI-Tests

Determines if the project runs tests before pull requests are merged.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

4

Maintained

Determines if the project is "actively maintained".

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/jshttp/content-disposition/ci.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:30
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:52
Info: 6 out of 13 GitHub-owned GitHubAction dependencies pinned
Info: 1 out of 2 third-party GitHubAction dependencies pinned
Info: 0 out of 2 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.8

/10

Last Scanned on 2025-06-30T21:30:21Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to content-disposition

Other packages similar to content-disposition

content-disposition

Installations

Developer Guide

No

N/A

>= 0.6

16.7.0

7.20.3

Score

Pull Requests

8

49

21

20

Issues

5

32

27

Releases

Languages

Developer

jshttp

Download Statistics

GitHub Statistics

Bundle Size

3.78 kB

1.55 kB

Maintainers

Package Meta Information

Total Downloads

NaN

Dependencies

Dev Dependencies

content-disposition

Installation

API

contentDisposition(filename, options)

Options

fallback

type

contentDisposition.parse(string)

Examples

Send a file for download

Testing

References

License

10

10

10

10

10

10

10

9

7

7

5

4

3

0

0

0

6.8

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads