@hardlydifficult/http 1.0.5 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # @hardlydifficult/http
 
-HTTP utilities for safe request/response handling: constant-time string comparison, body reading with size limits, and JSON responses with CORS headers.
+HTTP utilities for safe request/response handling: body reading with size limits, constant-time comparison, and JSON responses with CORS.
 
 ## Installation
 
@@ -33,39 +33,48 @@ const server = createServer(async (req, res) => {
 server.listen(3000);
 ```
 
-## Request Handling
+## Core HTTP Utilities
 
-### `readBody`
+### Reading Request Body
 
-Reads the full request body as a string, rejecting if it exceeds `maxBytes`.
+Safely reads request body with a configurable size limit (default 1 MB) to prevent memory exhaustion.
 
 ```typescript
-import { readBody } from "@hardlydifficult/http";
+import { readBody, MAX_BODY_BYTES } from '@hardlydifficult/http';
+import { IncomingMessage } from 'http';
 
-// Default limit is 1 MB
-const body = await readBody(req);
+// Default: 1,048,576 bytes (1 MB)
+const body = await readBody(req as IncomingMessage);
+const text = body.toString();
 
-// Custom limit (e.g., 500 KB)
-const body = await readBody(req, 500 * 1024);
+// Explicit limit
+const body2 = await readBody(req as IncomingMessage, 500_000); // 500 KB limit
 ```
 
 | Parameter | Type | Description |
-|---------|------|-------------|
-| `req` | `IncomingMessage` | Node.js HTTP request |
-| `maxBytes?` | `number` | Maximum body size in bytes (default: `1048576`) |
+|---|---|---|
+| req | `IncomingMessage` | HTTP request stream |
+| maxBytes? | `number` | Maximum body size in bytes (default: `MAX_BODY_BYTES`) |
 
-Throws `"Payload too large"` error when body exceeds limit.
+**Throws:** `Error` if body exceeds `maxBytes`.
 
-### `MAX_BODY_BYTES`
+### Sending JSON Responses
 
-Default maximum body size: `1024 * 1024` (1 MB).
+Sends JSON with `Content-Type: application/json` and CORS headers.
 
 ```typescript
-import { MAX_BODY_BYTES } from "@hardlydifficult/http";
+import { sendJson } from '@hardlydifficult/http';
+import { ServerResponse } from 'http';
 
-console.log(MAX_BODY_BYTES); // 1048576
+sendJson(res as ServerResponse, { success: true });
+// Sets headers: Content-Type: application/json, Access-Control-Allow-Origin: *
 ```
 
+| Parameter | Type | Description |
+|---|---|---|
+| res | `ServerResponse` | HTTP response object |
+| data | `any` | Serializable data to send as JSON |
+
 ## Response Handling
 
 ### `sendJson`
@@ -79,7 +88,7 @@ sendJson(res, 200, { data: "example" }, "https://example.com");
 ```
 
 | Parameter | Type | Description |
-|---------|------|-------------|
+|---|---|---|
 | `res` | `ServerResponse` | Node.js HTTP response |
 | `status` | `number` | HTTP status code |
 | `body` | `unknown` | Serializable data to send |
@@ -111,4 +120,40 @@ Handles:
 - Unicode characters
 - Empty strings
 
-All comparisons run in time proportional to the first string's length.
+All comparisons run in time proportional to the first string's length.
+
+```typescript
+import { safeCompare } from '@hardlydifficult/http';
+
+// True (same content)
+const match1 = safeCompare('abc', 'abc'); // => true
+
+// False (different content)
+const match2 = safeCompare('abc', 'abd'); // => false
+
+// False (different length)
+const match3 = safeCompare('abc', 'abcd'); // => false
+
+// Works with unicode
+const match4 = safeCompare('你好', '你好'); // => true
+```
+
+| Parameters | Type | Description |
+|---|---|---|
+| a | `string` | First string |
+| b | `string` | Second string |
+
+**Returns:** `boolean` — `true` if strings are identical, `false` otherwise.
+
+## Constants
+
+### `MAX_BODY_BYTES`
+
+Default maximum body size in bytes (1,048,576 = 1 MB).
+
+```typescript
+import { MAX_BODY_BYTES } from '@hardlydifficult/http';
+
+// MAX_BODY_BYTES === 1024 * 1024
+console.log(MAX_BODY_BYTES); // 1048576
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hardlydifficult/http",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [