@wnodex/body-parser 0.2.1 → 0.2.2

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 
-> @wnodex/body-parser@0.2.1 build /home/runner/work/wnodex/wnodex/packages/body-parser
+> @wnodex/body-parser@0.2.2 build /home/runner/work/wnodex/wnodex/packages/body-parser
 > rolldown -c && tsc
 
 [log] <DIR>/index.js  chunk │ size: 1.13 kB
 [log]
-[success] rolldown v1.0.0-rc.1 Finished in 50.22 ms
+[success] rolldown v1.0.0-rc.1 Finished in 21.97 ms

package/README.md

@@ -1,14 +1,79 @@
 # @wnodex/body-parser
 
-wnodex body-parser middleware
+> wnodex body-parser middleware
 
----
+Part of the [wnodex](https://github.com/wnodex/wnodex) ecosystem, this package provides body-parser middleware for `wnodex`.
 
-## Table of Content
+## About
 
-- [License](#license)
+`@wnodex/body-parser` is a middleware for `wnodex` that integrates the `body-parser` library to handle JSON and URL-encoded request bodies. It allows you to configure body parsing behavior through the main `wnodex` configuration.
 
----
+## Features
+
+- Seamless integration with the `wnodex` server.
+- Parses incoming request bodies in a middleware before your handlers.
+- Supports both JSON and URL-encoded bodies.
+- Configuration is centralized in the `wnodex` constructor.
+- Based on the widely-used `body-parser` library.
+
+## Why use it?
+
+This package simplifies request body parsing in your `wnodex` application. By integrating with the `wnodex` configuration system, it provides a consistent and streamlined way to manage middleware settings, abstracting away the boilerplate of setting up `body-parser` manually.
+
+## Installation
+
+You can install the package using your favorite package manager:
+
+**pnpm**
+
+```bash
+pnpm add @wnodex/body-parser
+```
+
+**npm**
+
+```bash
+npm install @wnodex/body-parser
+```
+
+**yarn**
+
+```bash
+yarn add @wnodex/body-parser
+```
+
+**bun**
+
+```bash
+bun add @wnodex/body-parser
+```
+
+## Usage
+
+`@wnodex/body-parser` is enabled by default in `wnodex`. You can customize its behavior by passing a `bodyParsers` object to the `Wnodex` constructor.
+
+To disable it, set `bodyParsers` to `false`.
+
+```typescript
+import { Wnodex } from 'wnodex';
+
+// Example: Enable with custom options
+const server = new Wnodex({
+  bodyParsers: {
+    json: { limit: '10mb' },
+    urlencoded: { extended: true },
+  },
+});
+
+// Example: Disable body-parser
+const serverWithDisabledBodyParser = new Wnodex({
+  bodyParsers: false,
+});
+
+server.start();
+```
+
+The options for `json` and `urlencoded` are passed directly to the `body-parser` library.
 
 ## License
 

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "@wnodex/body-parser",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "private": false,
-  "description": "wnodex body-parser middleware",
+  "description": "A wnodex middleware that integrates body-parser to handle JSON and URL-encoded request bodies.",
   "keywords": [
-    "wnodex"
+    "wnodex",
+    "middleware",
+    "body-parser",
+    "express",
+    "json",
+    "urlencoded",
+    "parser"
   ],
   "homepage": "https://github.com/wnodex/wnodex#readme",
   "bugs": {
@@ -39,7 +45,7 @@
     "@types/node": "^25.0.10",
     "rolldown": "1.0.0-rc.1",
     "typescript": "5.9.2",
-    "@wnodex/typescript-config": "0.2.1"
+    "@wnodex/typescript-config": "0.2.2"
   },
   "publishConfig": {
     "access": "public"