Merge branch 'master' of https://github.com/tinyhttp/milliparsec into feature-basic-form-data/multipart-support

Author: talentlessguy

Diff for: .eslintrc

@@ -22,14 +22,13 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2-beta
+      - uses: actions/checkout@v4
+      - name: Enable corepack
+        run: corepack enable pnpm
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.3.0'
-      - name: install pnpm
-        uses: pnpm/[email protected]
-        with:
-          version: 6.8.0
+          node-version: 18
+          cache: 'pnpm'
       - run: pnpm install
       - run: pnpm test:coverage
       - run: pnpm test:report

Diff for: .github/workflows/main.yml

@@ -0,0 +1,16 @@
+{
+  "biome.enabled": true,
+  "editor.defaultFormatter": "biomejs.biome",
+  "prettier.enable": false,
+  "eslint.enable": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "always"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "[typescript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "biomejs.biome"
+  }
+}

Diff for: .prettierrc.json

@@ -17,9 +17,10 @@ Check out [deno-libs/parsec](https://github.com/deno-libs/parsec) for Deno port.
 
 - ⏩ built with `async` / `await`
 - 🛠 JSON / raw / urlencoded data support
-- 📦 tiny package size (728B)
+- 📦 tiny package size (7.39KB)
 - 🔥 no dependencies
-- ⚡ [tinyhttp](https://github.com/talentlessguy/tinyhttp) and Express support
+- ✨ [tinyhttp](https://github.com/tinyhttp/tinyhttp) and Express support
+- ⚡ 30% faster than body-parser
 
 ## Install
 
@@ -108,6 +109,6 @@ The parsec is a unit of length used to measure large distances to astronomical o
 [npm-url]: https://www.npmjs.com/package/milliparsec
 [dl-badge-url]: https://img.shields.io/npm/dt/milliparsec?style=for-the-badge&color=25608B
 [github-actions]: https://github.com/talentlessguy/milliparsec/actions
-[gh-actions-img]: https://img.shields.io/github/workflow/status/talentlessguy/milliparsec/CI?style=for-the-badge&color=25608B&label=&logo=github
+[gh-actions-img]: https://img.shields.io/github/actions/workflow/status/tinyhttp/milliparsec/main.yml?branch=master&style=for-the-badge&color=25608B&label=&logo=github
 [cov-img]: https://img.shields.io/coveralls/github/tinyhttp/milliparsec?style=for-the-badge&color=25608B
 [cov-url]: https://coveralls.io/github/tinyhttp/milliparsec

Diff for: .vscode/settings.json

@@ -0,0 +1,15 @@
+// @ts-check
+
+import bodyParser from 'body-parser'
+import { createServer } from 'node:http'
+
+const mw = bodyParser.json()
+
+const server = createServer((req, res) => {
+  mw(req, res, () => {
+    // @ts-expect-error added by body parser
+    res.end(JSON.stringify(req.body))
+  })
+})
+
+server.listen(3002)

Diff for: README.md

@@ -0,0 +1,65 @@
+## Benchmark
+
+Below is a comparison of body-parser and milliparsec in terms of parsing a request with JSON payload.
+
+### Environment
+
+- Node.js 22.3.0
+- System: Linux 6.9.7
+- Machine: Asus ROG Zephyrus G16
+
+### Benchmark command:
+
+```sh
+autocannon -b '{"a":1}' -H "Content-Type=application/json" localhost:3002 # or 3003
+```
+
+### Results
+
+body-parser result:
+
+```
+┌─────────┬──────┬──────┬───────┬──────┬─────────┬─────────┬────────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%  │ Avg     │ Stdev   │ Max    │
+├─────────┼──────┼──────┼───────┼──────┼─────────┼─────────┼────────┤
+│ Latency │ 0 ms │ 0 ms │ 0 ms  │ 0 ms │ 0.01 ms │ 0.79 ms │ 251 ms │
+└─────────┴──────┴──────┴───────┴──────┴─────────┴─────────┴────────┘
+┌───────────┬─────────┬─────────┬─────────┬─────────┬───────────┬──────────┬─────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min     │
+├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
+│ Req/Sec   │ 31,231  │ 31,231  │ 42,815  │ 43,935  │ 41,823.28 │ 3,470.88 │ 31,224  │
+├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼─────────┤
+│ Bytes/Sec │ 4.03 MB │ 4.03 MB │ 5.52 MB │ 5.67 MB │ 5.39 MB   │ 448 kB   │ 4.03 MB │
+└───────────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────┴─────────┘
+
+Req/Bytes counts sampled once per second.
+# of samples: 11
+
+460k requests in 11.02s, 59.3 MB read
+```
+
+milliparsec result:
+
+```
+┌─────────┬──────┬──────┬───────┬──────┬─────────┬─────────┬────────┐
+│ Stat    │ 2.5% │ 50%  │ 97.5% │ 99%  │ Avg     │ Stdev   │ Max    │
+├─────────┼──────┼──────┼───────┼──────┼─────────┼─────────┼────────┤
+│ Latency │ 0 ms │ 0 ms │ 0 ms  │ 0 ms │ 0.01 ms │ 0.65 ms │ 254 ms │
+└─────────┴──────┴──────┴───────┴──────┴─────────┴─────────┴────────┘
+┌───────────┬─────────┬─────────┬─────────┬─────────┬───────────┬──────────┬────────┐
+│ Stat      │ 1%      │ 2.5%    │ 50%     │ 97.5%   │ Avg       │ Stdev    │ Min    │
+├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼────────┤
+│ Req/Sec   │ 52,511  │ 52,511  │ 63,007  │ 67,455  │ 63,397.82 │ 4,255.42 │ 52,480 │
+├───────────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────┼────────┤
+│ Bytes/Sec │ 6.41 MB │ 6.41 MB │ 7.69 MB │ 8.23 MB │ 7.74 MB   │ 519 kB   │ 6.4 MB │
+└───────────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────┴────────┘
+
+Req/Bytes counts sampled once per second.
+# of samples: 11
+
+697k requests in 11.02s, 85.1 MB rea
+```
+
+## Verdict
+
+milliparsec, on average, is ~34% faster.

Diff for: bench/body-parser.js

@@ -0,0 +1,15 @@
+// @ts-check
+
+import { createServer } from 'node:http'
+import * as bodyParser from '../dist/index.js'
+
+const mw = bodyParser.json()
+
+const server = createServer((req, res) => {
+  mw(req, res, () => {
+    // @ts-expect-error added by body parser
+    res.end(JSON.stringify(req.body))
+  })
+})
+
+server.listen(3003)

Diff for: bench/index.md

@@ -0,0 +1,18 @@
+{
+  "name": "bench",
+  "type": "module",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "bench": "autocannon -b '{\"a\":1}' -H \"Content-Type=application/json\""
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/body-parser": "^1.19.5",
+    "autocannon": "^7.15.0",
+    "body-parser": "^1.20.2"
+  }
+}