.github/workflows/ci.yml

@@ -12,6 +12,23 @@ permissions:
   contents: read
 
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+
+      - name: Install Node.js dependencies
+        run: npm install --ignore-scripts --include=dev
+
+      - name: Lint code
+        run: npm run lint
+
   test:
     name: Test - Node.js ${{ matrix.node-version }}
     runs-on: ubuntu-latest
@@ -34,9 +51,6 @@ jobs:
       - name: Run tests
         run: npm run test-ci
 
-      - name: Lint code
-        run: npm run lint
-
       - name: Upload code coverage
         uses: actions/upload-artifact@v4
         with:

HISTORY.md

@@ -1,3 +1,10 @@
+2.2.0 / 2025-03-27
+=========================
+
+* refactor: normalize common options for all parsers
+* deps:
+  * iconv-lite@^0.6.3
+
 2.1.0 / 2025-02-10
 =========================
 

README.md

@@ -51,7 +51,7 @@ $ npm install body-parser
 ## API
 
 ```js
-var bodyParser = require('body-parser')
+const bodyParser = require('body-parser')
 ```
 
 The `bodyParser` object exposes various factories to create middlewares. All
@@ -404,10 +404,10 @@ top-level middleware, which will parse the bodies of all incoming requests.
 This is the simplest setup.
 
 ```js
-var express = require('express')
-var bodyParser = require('body-parser')
+const express = require('express')
+const bodyParser = require('body-parser')
 
-var app = express()
+const app = express()
 
 // parse application/x-www-form-urlencoded
 app.use(bodyParser.urlencoded())
@@ -429,16 +429,16 @@ need them. In general, this is the most recommended way to use body-parser with
 Express.
 
 ```js
-var express = require('express')
-var bodyParser = require('body-parser')
+const express = require('express')
+const bodyParser = require('body-parser')
 
-var app = express()
+const app = express()
 
 // create application/json parser
-var jsonParser = bodyParser.json()
+const jsonParser = bodyParser.json()
 
 // create application/x-www-form-urlencoded parser
-var urlencodedParser = bodyParser.urlencoded()
+const urlencodedParser = bodyParser.urlencoded()
 
 // POST /login gets urlencoded bodies
 app.post('/login', urlencodedParser, function (req, res) {
@@ -459,10 +459,10 @@ All the parsers accept a `type` option which allows you to change the
 `Content-Type` that the middleware will parse.
 
 ```js
-var express = require('express')
-var bodyParser = require('body-parser')
+const express = require('express')
+const bodyParser = require('body-parser')
 
-var app = express()
+const app = express()
 
 // parse various different custom JSON types as JSON
 app.use(bodyParser.json({ type: 'application/*+json' }))

lib/types/json.js

@@ -12,13 +12,12 @@
  * @private
  */
 
-var bytes = require('bytes')
-var contentType = require('content-type')
 var createError = require('http-errors')
 var debug = require('debug')('body-parser:json')
 var isFinished = require('on-finished').isFinished
 var read = require('../read')
 var typeis = require('type-is')
+var { getCharset, normalizeOptions } = require('../utils')
 
 /**
  * Module exports.
@@ -52,25 +51,10 @@ var JSON_SYNTAX_REGEXP = /#+/g
  */
 
 function json (options) {
-  var opts = options || {}
-
-  var limit = typeof opts.limit !== 'number'
-    ? bytes.parse(opts.limit || '100kb')
-    : opts.limit
-  var inflate = opts.inflate !== false
-  var reviver = opts.reviver
-  var strict = opts.strict !== false
-  var type = opts.type || 'application/json'
-  var verify = opts.verify || false
-
-  if (verify !== false && typeof verify !== 'function') {
-    throw new TypeError('option verify must be function')
-  }
+  var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'application/json')
 
-  // create the appropriate type checking function
-  var shouldParse = typeof type !== 'function'
-    ? typeChecker(type)
-    : type
+  var reviver = options?.reviver
+  var strict = options?.strict !== false
 
   function parse (body) {
     if (body.length === 0) {
@@ -140,9 +124,9 @@ function json (options) {
     // read
     read(req, res, next, parse, debug, {
       encoding: charset,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      inflate,
+      limit,
+      verify
     })
   }
 }
@@ -196,21 +180,6 @@ function firstchar (str) {
     : undefined
 }
 
-/**
- * Get the charset of a request.
- *
- * @param {object} req
- * @api private
- */
-
-function getCharset (req) {
-  try {
-    return (contentType.parse(req).parameters.charset || '').toLowerCase()
-  } catch (e) {
-    return undefined
-  }
-}
-
 /**
  * Normalize a SyntaxError for JSON.parse.
  *
@@ -235,16 +204,3 @@ function normalizeJsonSyntaxError (error, obj) {
 
   return error
 }
-
-/**
- * Get the simple type checker.
- *
- * @param {string} type
- * @return {function}
- */
-
-function typeChecker (type) {
-  return function checkType (req) {
-    return Boolean(typeis(req, type))
-  }
-}

lib/types/raw.js

@@ -10,11 +10,11 @@
  * Module dependencies.
  */
 
-var bytes = require('bytes')
 var debug = require('debug')('body-parser:raw')
 var isFinished = require('on-finished').isFinished
 var read = require('../read')
 var typeis = require('type-is')
+var { normalizeOptions } = require('../utils')
 
 /**
  * Module exports.
@@ -31,23 +31,7 @@ module.exports = raw
  */
 
 function raw (options) {
-  var opts = options || {}
-
-  var inflate = opts.inflate !== false
-  var limit = typeof opts.limit !== 'number'
-    ? bytes.parse(opts.limit || '100kb')
-    : opts.limit
-  var type = opts.type || 'application/octet-stream'
-  var verify = opts.verify || false
-
-  if (verify !== false && typeof verify !== 'function') {
-    throw new TypeError('option verify must be function')
-  }
-
-  // create the appropriate type checking function
-  var shouldParse = typeof type !== 'function'
-    ? typeChecker(type)
-    : type
+  var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'application/octet-stream')
 
   function parse (buf) {
     return buf
@@ -83,22 +67,9 @@ function raw (options) {
     // read
     read(req, res, next, parse, debug, {
       encoding: null,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      inflate,
+      limit,
+      verify
     })
   }
 }
-
-/**
- * Get the simple type checker.
- *
- * @param {string} type
- * @return {function}
- */
-
-function typeChecker (type) {
-  return function checkType (req) {
-    return Boolean(typeis(req, type))
-  }
-}

lib/types/text.js

@@ -10,12 +10,11 @@
  * Module dependencies.
  */
 
-var bytes = require('bytes')
-var contentType = require('content-type')
 var debug = require('debug')('body-parser:text')
 var isFinished = require('on-finished').isFinished
 var read = require('../read')
 var typeis = require('type-is')
+var { getCharset, normalizeOptions } = require('../utils')
 
 /**
  * Module exports.
@@ -32,24 +31,9 @@ module.exports = text
  */
 
 function text (options) {
-  var opts = options || {}
-
-  var defaultCharset = opts.defaultCharset || 'utf-8'
-  var inflate = opts.inflate !== false
-  var limit = typeof opts.limit !== 'number'
-    ? bytes.parse(opts.limit || '100kb')
-    : opts.limit
-  var type = opts.type || 'text/plain'
-  var verify = opts.verify || false
-
-  if (verify !== false && typeof verify !== 'function') {
-    throw new TypeError('option verify must be function')
-  }
+  var { inflate, limit, verify, shouldParse } = normalizeOptions(options, 'text/plain')
 
-  // create the appropriate type checking function
-  var shouldParse = typeof type !== 'function'
-    ? typeChecker(type)
-    : type
+  var defaultCharset = options?.defaultCharset || 'utf-8'
 
   function parse (buf) {
     return buf
@@ -88,37 +72,9 @@ function text (options) {
     // read
     read(req, res, next, parse, debug, {
       encoding: charset,
-      inflate: inflate,
-      limit: limit,
-      verify: verify
+      inflate,
+      limit,
+      verify
     })
   }
 }
-
-/**
- * Get the charset of a request.
- *
- * @param {object} req
- * @api private
- */
-
-function getCharset (req) {
-  try {
-    return (contentType.parse(req).parameters.charset || '').toLowerCase()
-  } catch (e) {
-    return undefined
-  }
-}
-
-/**
- * Get the simple type checker.
- *
- * @param {string} type
- * @return {function}
- */
-
-function typeChecker (type) {
-  return function checkType (req) {
-    return Boolean(typeis(req, type))
-  }
-}