@remix-run/multipart-parser 0.13.0 → 0.14.0

package/README.md

@@ -2,7 +2,7 @@
 
 `multipart-parser` is a fast, streaming multipart parser that works in **any JavaScript environment**, from serverless functions to traditional servers. Whether you're handling file uploads, parsing email attachments, or working with multipart API responses, `multipart-parser` has you covered.
 
-## 🚀 Why multipart-parser?
+## Why multipart-parser?
 
 - **Universal JavaScript** - One library that works everywhere: Node.js, Bun, Deno, Cloudflare Workers, and browsers
 - **Blazing Fast** - Consistently outperforms popular alternatives like busboy in benchmarks
@@ -12,14 +12,14 @@
 - **Standards Based** - Built on the web standard [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) for maximum compatibility
 - **Production Ready** - Battle-tested error handling with specific error types for common scenarios
 
-## 📦 Features
+## Features
 
-- Parse file uploads (`multipart/form-data`) with automatic field and file detection
-- Support for all `multipart/*` content types (mixed, alternative, related, etc.)
-- Convenient `MultipartPart` API with `arrayBuffer`, `bytes`, `text`, `size`, and metadata access
-- Built-in file size limiting to prevent abuse
-- First-class Node.js support with native `http.IncomingMessage` compatibility
-- [Demos for every major runtime](https://github.com/remix-run/remix/tree/main/packages/multipart-parser/demos)
+- **File Upload Parsing** - Parse file uploads (`multipart/form-data`) with automatic field and file detection
+- **Full Multipart Support** - Support for all `multipart/*` content types (mixed, alternative, related, etc.)
+- **Convenient API** - `MultipartPart` API with `arrayBuffer`, `bytes`, `text`, `size`, and metadata access
+- **File Size Limiting** - Built-in file size limiting to prevent abuse
+- **Node.js Support** - First-class Node.js support with native `http.IncomingMessage` compatibility
+- **Runtime Demos** - [Demos for every major runtime](https://github.com/remix-run/remix/tree/main/packages/multipart-parser/demos)
 
 ## Installation
 

package/dist/lib/multipart.d.ts

@@ -3,20 +3,32 @@ import Headers from '@remix-run/headers';
  * The base class for errors thrown by the multipart parser.
  */
 export declare class MultipartParseError extends Error {
+    /**
+     * @param message The error message
+     */
     constructor(message: string);
 }
 /**
  * An error thrown when the maximum allowed size of a header is exceeded.
  */
 export declare class MaxHeaderSizeExceededError extends MultipartParseError {
+    /**
+     * @param maxHeaderSize The maximum header size that was exceeded
+     */
     constructor(maxHeaderSize: number);
 }
 /**
  * An error thrown when the maximum allowed size of a file is exceeded.
  */
 export declare class MaxFileSizeExceededError extends MultipartParseError {
+    /**
+     * @param maxFileSize The maximum file size that was exceeded
+     */
     constructor(maxFileSize: number);
 }
+/**
+ * Options for parsing a multipart message.
+ */
 export interface ParseMultipartOptions {
     /**
      * The boundary string used to separate parts in the multipart message,
@@ -27,14 +39,14 @@ export interface ParseMultipartOptions {
      * The maximum allowed size of a header in bytes. If an individual part's header
      * exceeds this size, a `MaxHeaderSizeExceededError` will be thrown.
      *
-     * Default: 8 KiB
+     * @default 8192 (8 KiB)
      */
     maxHeaderSize?: number;
     /**
      * The maximum allowed size of a file in bytes. If an individual part's content
      * exceeds this size, a `MaxFileSizeExceededError` will be thrown.
      *
-     * Default: 2 MiB
+     * @default 2097152 (2 MiB)
      */
     maxFileSize?: number;
 }
@@ -60,6 +72,9 @@ export declare function parseMultipart(message: Uint8Array | Iterable<Uint8Array
  * @return An async generator that yields `MultipartPart` objects
  */
 export declare function parseMultipartStream(stream: ReadableStream<Uint8Array>, options: ParseMultipartOptions): AsyncGenerator<MultipartPart, void, unknown>;
+/**
+ * Options for configuring a `MultipartParser`.
+ */
 export type MultipartParserOptions = Omit<ParseMultipartOptions, 'boundary'>;
 /**
  * A streaming parser for `multipart/*` HTTP messages.
@@ -69,6 +84,10 @@ export declare class MultipartParser {
     readonly boundary: string;
     readonly maxHeaderSize: number;
     readonly maxFileSize: number;
+    /**
+     * @param boundary The boundary string used to separate parts
+     * @param options Options for the parser
+     */
     constructor(boundary: string, options?: MultipartParserOptions);
     /**
      * Write a chunk of data to the parser.
@@ -96,6 +115,10 @@ export declare class MultipartPart {
      * The raw content of this part as an array of `Uint8Array` chunks.
      */
     readonly content: Uint8Array[];
+    /**
+     * @param header The raw header bytes
+     * @param content The content chunks
+     */
     constructor(header: Uint8Array, content: Uint8Array[]);
     /**
      * The content of this part as an `ArrayBuffer`.

package/dist/lib/multipart.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"multipart.d.ts","sourceRoot":"","sources":["../../src/lib/multipart.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,oBAAoB,CAAA;AAMxC;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,mBAAmB;gBACrD,aAAa,EAAE,MAAM;CAIlC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,mBAAmB;gBACnD,WAAW,EAAE,MAAM;CAIhC;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;GASG;AACH,wBAAiB,cAAc,CAC7B,OAAO,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,EAC1C,OAAO,EAAE,qBAAqB,GAC7B,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAmBzC;AAED;;;;;;;;;GASG;AACH,wBAAuB,oBAAoB,CACzC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAClC,OAAO,EAAE,qBAAqB,GAC7B,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAe9C;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAA;AAa5E;;GAEG;AACH,qBAAa,eAAe;;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;gBAahB,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB;IAY9D;;;;;OAKG;IACF,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC;IA0HlE;;;;;;;OAOG;IACH,MAAM,IAAI,IAAI;CAKf;AAID;;GAEG;AACH,qBAAa,aAAa;;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAA;gBAKlB,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE;IAKrD;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,UAAU,CAUtB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAMrB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAQjB;IAED;;;;;OAKG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}
+{"version":3,"file":"multipart.d.ts","sourceRoot":"","sources":["../../src/lib/multipart.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,oBAAoB,CAAA;AAUxC;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;gBACS,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,mBAAmB;IACjE;;OAEG;gBACS,aAAa,EAAE,MAAM;CAIlC;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,mBAAmB;IAC/D;;OAEG;gBACS,WAAW,EAAE,MAAM;CAIhC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;GASG;AACH,wBAAiB,cAAc,CAC7B,OAAO,EAAE,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC,EAC1C,OAAO,EAAE,qBAAqB,GAC7B,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAmBzC;AAED;;;;;;;;;GASG;AACH,wBAAuB,oBAAoB,CACzC,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAClC,OAAO,EAAE,qBAAqB,GAC7B,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAe9C;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAA;AAa5E;;GAEG;AACH,qBAAa,eAAe;;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAa5B;;;OAGG;gBACS,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB;IAY9D;;;;;OAKG;IACF,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC;IA0HlE;;;;;;;OAOG;IACH,MAAM,IAAI,IAAI;CAKf;AAID;;GAEG;AACH,qBAAa,aAAa;;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAA;IAK9B;;;OAGG;gBACS,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE;IAKrD;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,UAAU,CAUtB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAMrB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,GAAG,SAAS,CAEjC;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,GAAG,SAAS,CAElC;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,GAAG,SAAS,CAE7B;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAQjB;IAED;;;;;OAKG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;CACF"}

package/dist/lib/multipart.js

@@ -1,10 +1,13 @@
 import Headers from '@remix-run/headers';
+import { createSearch, createPartialTailSearch, } from "./buffer-search.js";
 import { readStream } from "./read-stream.js";
-import { createSearch, createPartialTailSearch } from "./buffer-search.js";
 /**
  * The base class for errors thrown by the multipart parser.
  */
 export class MultipartParseError extends Error {
+    /**
+     * @param message The error message
+     */
     constructor(message) {
         super(message);
         this.name = 'MultipartParseError';
@@ -14,6 +17,9 @@ export class MultipartParseError extends Error {
  * An error thrown when the maximum allowed size of a header is exceeded.
  */
 export class MaxHeaderSizeExceededError extends MultipartParseError {
+    /**
+     * @param maxHeaderSize The maximum header size that was exceeded
+     */
     constructor(maxHeaderSize) {
         super(`Multipart header size exceeds maximum allowed size of ${maxHeaderSize} bytes`);
         this.name = 'MaxHeaderSizeExceededError';
@@ -23,6 +29,9 @@ export class MaxHeaderSizeExceededError extends MultipartParseError {
  * An error thrown when the maximum allowed size of a file is exceeded.
  */
 export class MaxFileSizeExceededError extends MultipartParseError {
+    /**
+     * @param maxFileSize The maximum file size that was exceeded
+     */
     constructor(maxFileSize) {
         super(`File size exceeds maximum allowed size of ${maxFileSize} bytes`);
         this.name = 'MaxFileSizeExceededError';
@@ -103,6 +112,10 @@ export class MultipartParser {
     #buffer = null;
     #currentPart = null;
     #contentLength = 0;
+    /**
+     * @param boundary The boundary string used to separate parts
+     * @param options Options for the parser
+     */
     constructor(boundary, options) {
         this.boundary = boundary;
         this.maxHeaderSize = options?.maxHeaderSize ?? 8 * oneKb;
@@ -236,6 +249,10 @@ export class MultipartPart {
     content;
     #header;
     #headers;
+    /**
+     * @param header The raw header bytes
+     * @param content The content chunks
+     */
     constructor(header, content) {
         this.#header = header;
         this.content = content;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/multipart-parser",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "A fast, efficient parser for multipart streams in any JavaScript environment",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "repository": {
@@ -29,8 +29,8 @@
     },
     "./package.json": "./package.json"
   },
-  "dependencies": {
-    "@remix-run/headers": "^0.15.0"
+  "peerDependencies": {
+    "@remix-run/headers": "^0.18.0"
   },
   "devDependencies": {
     "@types/node": "^24.6.0",

package/src/lib/multipart.ts

@@ -1,13 +1,20 @@
 import Headers from '@remix-run/headers'
 
+import {
+  createSearch,
+  createPartialTailSearch,
+  type SearchFunction,
+  type PartialTailSearchFunction,
+} from './buffer-search.ts'
 import { readStream } from './read-stream.ts'
-import type { SearchFunction, PartialTailSearchFunction } from './buffer-search.ts'
-import { createSearch, createPartialTailSearch } from './buffer-search.ts'
 
 /**
  * The base class for errors thrown by the multipart parser.
  */
 export class MultipartParseError extends Error {
+  /**
+   * @param message The error message
+   */
   constructor(message: string) {
     super(message)
     this.name = 'MultipartParseError'
@@ -18,6 +25,9 @@ export class MultipartParseError extends Error {
  * An error thrown when the maximum allowed size of a header is exceeded.
  */
 export class MaxHeaderSizeExceededError extends MultipartParseError {
+  /**
+   * @param maxHeaderSize The maximum header size that was exceeded
+   */
   constructor(maxHeaderSize: number) {
     super(`Multipart header size exceeds maximum allowed size of ${maxHeaderSize} bytes`)
     this.name = 'MaxHeaderSizeExceededError'
@@ -28,12 +38,18 @@ export class MaxHeaderSizeExceededError extends MultipartParseError {
  * An error thrown when the maximum allowed size of a file is exceeded.
  */
 export class MaxFileSizeExceededError extends MultipartParseError {
+  /**
+   * @param maxFileSize The maximum file size that was exceeded
+   */
   constructor(maxFileSize: number) {
     super(`File size exceeds maximum allowed size of ${maxFileSize} bytes`)
     this.name = 'MaxFileSizeExceededError'
   }
 }
 
+/**
+ * Options for parsing a multipart message.
+ */
 export interface ParseMultipartOptions {
   /**
    * The boundary string used to separate parts in the multipart message,
@@ -44,14 +60,14 @@ export interface ParseMultipartOptions {
    * The maximum allowed size of a header in bytes. If an individual part's header
    * exceeds this size, a `MaxHeaderSizeExceededError` will be thrown.
    *
-   * Default: 8 KiB
+   * @default 8192 (8 KiB)
    */
   maxHeaderSize?: number
   /**
    * The maximum allowed size of a file in bytes. If an individual part's content
    * exceeds this size, a `MaxFileSizeExceededError` will be thrown.
    *
-   * Default: 2 MiB
+   * @default 2097152 (2 MiB)
    */
   maxFileSize?: number
 }
@@ -120,6 +136,9 @@ export async function* parseMultipartStream(
   parser.finish()
 }
 
+/**
+ * Options for configuring a `MultipartParser`.
+ */
 export type MultipartParserOptions = Omit<ParseMultipartOptions, 'boundary'>
 
 const MultipartParserStateStart = 0
@@ -152,6 +171,10 @@ export class MultipartParser {
   #currentPart: MultipartPart | null = null
   #contentLength = 0
 
+  /**
+   * @param boundary The boundary string used to separate parts
+   * @param options Options for the parser
+   */
   constructor(boundary: string, options?: MultipartParserOptions) {
     this.boundary = boundary
     this.maxHeaderSize = options?.maxHeaderSize ?? 8 * oneKb
@@ -321,6 +344,10 @@ export class MultipartPart {
   #header: Uint8Array
   #headers?: Headers
 
+  /**
+   * @param header The raw header bytes
+   * @param content The content chunks
+   */
   constructor(header: Uint8Array, content: Uint8Array[]) {
     this.#header = header
     this.content = content