Skip to content

Commit 7efabb6

Browse files
committed
README tweaks
1 parent cc62fdc commit 7efabb6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

packages/multipart-parser/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
- **Universal JavaScript** - One library that works everywhere: Node.js, Bun, Deno, Cloudflare Workers, and browsers
88
- **Blazing Fast** - Consistently outperforms popular alternatives like busboy in benchmarks
9-
- **Zero Dependencies** - Lightweight and secure with no external dependencies for core functionality
9+
- **Zero Dependencies** - Lightweight and secure with no external dependencies
1010
- **Memory Efficient** - Streaming architecture that `yield`s files as they are found in the stream
1111
- **Type Safe** - Written in TypeScript with comprehensive type definitions
1212
- **Standards Based** - Built on the web standard [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) for maximum compatibility
@@ -16,7 +16,7 @@
1616

1717
- Parse file uploads (`multipart/form-data`) with automatic field and file detection
1818
- Support for all `multipart/*` content types (mixed, alternative, related, etc.)
19-
- Convenient `MultipartPart` API with `arrayBuffer`, `bytes`, `text`, and metadata access
19+
- Convenient `MultipartPart` API with `arrayBuffer`, `bytes`, `text`, `size`, and metadata access
2020
- Built-in file size limiting to prevent abuse
2121
- First-class Node.js support with native `http.IncomingMessage` compatibility
2222
- [Examples for every major runtime](https://github.com/mjackson/remix-the-web/tree/main/packages/multipart-parser/examples)
@@ -46,7 +46,7 @@ async function handleRequest(request: Request): void {
4646
try {
4747
for await (let part of parseMultipartRequest(request)) {
4848
if (part.isFile) {
49-
// Access file data in multiple formats - all sync!
49+
// Access file data in multiple formats
5050
let buffer = part.arrayBuffer; // ArrayBuffer
5151
console.log(`File received: ${part.filename} (${buffer.byteLength} bytes)`);
5252
console.log(`Content type: ${part.mediaType}`);
@@ -101,7 +101,7 @@ async function handleRequest(request: Request): Promise<Response> {
101101
}
102102
```
103103

104-
## Node.js Support
104+
## Node.js Bindings
105105

106106
The main module (`import from "@mjackson/multipart-parser"`) assumes you're working with [the fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) (`Request`, `ReadableStream`, etc). Support for these interfaces was added to Node.js by the [undici](https://github.com/nodejs/undici) project in [version 16.5.0](https://nodejs.org/en/blog/release/v16.5.0).
107107

0 commit comments

Comments
 (0)