Gathering detailed insights and metrics for @d-fischer/raw-body
Gathering detailed insights and metrics for @d-fischer/raw-body
npm install @d-fischer/raw-body
Typescript
Module System
Min. Node Version
Node Version
NPM Version
JavaScript (100%)
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Total Downloads
158,328
Last Day
77
Last Week
902
Last Month
2,746
Last Year
32,106
MIT License
388 Stars
519 Commits
70 Forks
8 Watchers
4 Branches
16 Contributors
Updated on Mar 11, 2025
Minified
Minified + Gzipped
Latest Version
2.4.3
Package Id
@d-fischer/raw-body@2.4.3
Size
7.56 kB
NPM Version
6.14.7
Node Version
14.7.0
Published on
Oct 04, 2020
Cumulative downloads
Total Downloads
Last Day
16.7%
77
Compared to previous day
Last Week
60.5%
902
Compared to previous week
Last Month
7.5%
2,746
Compared to previous month
Last Year
-8.7%
32,106
Compared to previous year
Gets the entire buffer of a stream either as a Buffer
or a string.
Validates the stream's length against an expected length and maximum limit.
Ideal for parsing request bodies.
This is a Node.js module available through the
npm registry. Installation is done using the
npm install
command:
1$ npm install raw-body
This module includes a TypeScript
declaration file to enable auto complete in compatible editors and type
information for TypeScript projects. This module depends on the Node.js
types, so install @types/node
:
1$ npm install @types/node
1var getRawBody = require('raw-body')
Returns a promise if no callback specified and global Promise
exists.
Options:
length
- The length of the stream.
If the contents of the stream do not add up to this length,
an 400
error code is returned.limit
- The byte limit of the body.
This is the number of bytes or any string format supported by
bytes,
for example 1000
, '500kb'
or '3mb'
.
If the body ends up being larger than this limit,
a 413
error code is returned.encoding
- The encoding to use to decode the body into a string.
By default, a Buffer
instance will be returned when no encoding is specified.
Most likely, you want utf-8
, so setting encoding
to true
will decode as utf-8
.
You can use any type of encoding supported by iconv-lite.You can also pass a string in place of options to just specify the encoding.
If an error occurs, the stream will be paused, everything unpiped,
and you are responsible for correctly disposing the stream.
For HTTP requests, no handling is required if you send a response.
For streams that use file descriptors, you should stream.destroy()
or stream.close()
to prevent leaks.
This module creates errors depending on the error condition during reading. The error may be an error from the underlying Node.js implementation, but is otherwise an error created by this module, which has the following attributes:
limit
- the limit in byteslength
and expected
- the expected length of the streamreceived
- the received bytesencoding
- the invalid encodingstatus
and statusCode
- the corresponding status code for the errortype
- the error typeThe errors from this module have a type
property which allows for the progamatic
determination of the type of error returned.
This error will occur when the encoding
option is specified, but the value does
not map to an encoding supported by the iconv-lite
module.
This error will occur when the limit
option is specified, but the stream has
an entity that is larger.
This error will occur when the request stream is aborted by the client before reading the body has finished.
This error will occur when the length
option is specified, but the stream has
emitted more bytes.
This error will occur when the given stream has an encoding set on it, making it
a decoded stream. The stream should not have an encoding set and is expected to
emit Buffer
objects.
1var contentType = require('content-type') 2var express = require('express') 3var getRawBody = require('raw-body') 4 5var app = express() 6 7app.use(function (req, res, next) { 8 getRawBody(req, { 9 length: req.headers['content-length'], 10 limit: '1mb', 11 encoding: contentType.parse(req).parameters.charset 12 }, function (err, string) { 13 if (err) return next(err) 14 req.text = string 15 next() 16 }) 17}) 18 19// now access req.text
1var contentType = require('content-type') 2var getRawBody = require('raw-body') 3var koa = require('koa') 4 5var app = koa() 6 7app.use(function * (next) { 8 this.text = yield getRawBody(this.req, { 9 length: this.req.headers['content-length'], 10 limit: '1mb', 11 encoding: contentType.parse(this.req).parameters.charset 12 }) 13 yield next 14}) 15 16// now access this.text
To use this library as a promise, simply omit the callback
and a promise is
returned, provided that a global Promise
is defined.
1var getRawBody = require('raw-body') 2var http = require('http') 3 4var server = http.createServer(function (req, res) { 5 getRawBody(req) 6 .then(function (buf) { 7 res.statusCode = 200 8 res.end(buf.length + ' bytes submitted') 9 }) 10 .catch(function (err) { 11 res.statusCode = 500 12 res.end(err.message) 13 }) 14}) 15 16server.listen(3000)
1import * as getRawBody from 'raw-body'; 2import * as http from 'http'; 3 4const server = http.createServer((req, res) => { 5 getRawBody(req) 6 .then((buf) => { 7 res.statusCode = 200; 8 res.end(buf.length + ' bytes submitted'); 9 }) 10 .catch((err) => { 11 res.statusCode = err.statusCode; 12 res.end(err.message); 13 }); 14}); 15 16server.listen(3000);
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
security policy file detected
Details
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
0 existing vulnerabilities detected
Reason
Found 2/17 approved changesets -- score normalized to 1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-03-03
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