@remix-run/multipart-parser 0.13.0 → 0.14.1

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/buffer-search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"buffer-search.d.ts","sourceRoot":"","sources":["../../src/lib/buffer-search.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC/C;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CA+B5D;AAED,MAAM,WAAW,yBAAyB;IACxC,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,CAAA;CAC/B;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAyBlF"}
+{"version":3,"file":"buffer-search.d.ts","sourceRoot":"","sources":["../../src/lib/buffer-search.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,cAAc;IAC7B,CAAC,QAAQ,EAAE,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC/C;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,cAAc,CAkC5D;AAED,MAAM,WAAW,yBAAyB;IACxC,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,CAAA;CAC/B;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAyBlF"}

package/dist/lib/buffer-search.js

@@ -1,9 +1,10 @@
 export function createSearch(pattern) {
     let needle = new TextEncoder().encode(pattern);
     let search;
-    if ('Buffer' in globalThis && !('Bun' in globalThis || 'Deno' in globalThis)) {
-        // Use the built-in Buffer.indexOf method on Node.js for better perf.
-        search = (haystack, start = 0) => Buffer.prototype.indexOf.call(haystack, needle, start);
+    // Use the built-in Buffer.indexOf method on Node.js for better perf.
+    let BufferClass = globalThis.Buffer;
+    if (BufferClass && !('Bun' in globalThis || 'Deno' in globalThis)) {
+        search = (haystack, start = 0) => BufferClass.prototype.indexOf.call(haystack, needle, start);
     }
     else {
         let needleEnd = needle.length - 1;

package/dist/lib/multipart-request.d.ts

@@ -3,14 +3,14 @@ import type { MultipartParserOptions, MultipartPart } from './multipart.ts';
  * Extracts the boundary string from a `multipart/*` content type.
  *
  * @param contentType The `Content-Type` header value from the request
- * @return The boundary string if found, or null if not present
+ * @returns The boundary string if found, or null if not present
  */
 export declare function getMultipartBoundary(contentType: string): string | null;
 /**
  * Returns true if the given request contains multipart data.
  *
  * @param request The `Request` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export declare function isMultipartRequest(request: Request): boolean;
 /**
@@ -19,7 +19,7 @@ export declare function isMultipartRequest(request: Request): boolean;
  *
  * @param request The `Request` object containing multipart data
  * @param options Optional parser options, such as `maxHeaderSize` and `maxFileSize`
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export declare function parseMultipartRequest(request: Request, options?: MultipartParserOptions): AsyncGenerator<MultipartPart, void, unknown>;
 //# sourceMappingURL=multipart-request.d.ts.map

package/dist/lib/multipart-request.js

@@ -3,7 +3,7 @@ import { MultipartParseError, parseMultipartStream } from "./multipart.js";
  * Extracts the boundary string from a `multipart/*` content type.
  *
  * @param contentType The `Content-Type` header value from the request
- * @return The boundary string if found, or null if not present
+ * @returns The boundary string if found, or null if not present
  */
 export function getMultipartBoundary(contentType) {
     let match = /boundary=(?:"([^"]+)"|([^;]+))/i.exec(contentType);
@@ -13,7 +13,7 @@ export function getMultipartBoundary(contentType) {
  * Returns true if the given request contains multipart data.
  *
  * @param request The `Request` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export function isMultipartRequest(request) {
     let contentType = request.headers.get('Content-Type');
@@ -25,7 +25,7 @@ export function isMultipartRequest(request) {
  *
  * @param request The `Request` object containing multipart data
  * @param options Optional parser options, such as `maxHeaderSize` and `maxFileSize`
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartRequest(request, options) {
     if (!isMultipartRequest(request)) {

package/dist/lib/multipart.d.ts

@@ -1,22 +1,33 @@
-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 +38,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;
 }
@@ -46,7 +57,7 @@ export interface ParseMultipartOptions {
  *
  * @param message The multipart message as a `Uint8Array` or an iterable of `Uint8Array` chunks
  * @param options Options for the parser
- * @return A generator that yields `MultipartPart` objects
+ * @returns A generator that yields `MultipartPart` objects
  */
 export declare function parseMultipart(message: Uint8Array | Iterable<Uint8Array>, options: ParseMultipartOptions): Generator<MultipartPart, void, unknown>;
 /**
@@ -57,9 +68,12 @@ export declare function parseMultipart(message: Uint8Array | Iterable<Uint8Array
  *
  * @param stream A stream containing multipart data as a `ReadableStream<Uint8Array>`
  * @param options Options for the parser
- * @return An async generator that yields `MultipartPart` objects
+ * @returns 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,12 +83,16 @@ 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.
      *
      * @param chunk A chunk of data to write to the parser
-     * @return A generator yielding `MultipartPart` objects as they are parsed
+     * @returns A generator yielding `MultipartPart` objects as they are parsed
      */
     write(chunk: Uint8Array): Generator<MultipartPart, void, unknown>;
     /**
@@ -82,8 +100,6 @@ export declare class MultipartParser {
      *
      * Note: This will throw if the multipart message is incomplete or
      * wasn't properly terminated.
-     *
-     * @return void
      */
     finish(): void;
 }
@@ -96,6 +112,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":"AAUA;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,KAAK;IAC5C;;OAEG;IACH,YAAY,OAAO,EAAE,MAAM,EAG1B;CACF;AAED;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,mBAAmB;IACjE;;OAEG;IACH,YAAY,aAAa,EAAE,MAAM,EAGhC;CACF;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,mBAAmB;IAC/D;;OAEG;IACH,YAAY,WAAW,EAAE,MAAM,EAG9B;CACF;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;IACH,YAAY,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,EAU7D;IAED;;;;;OAKG;IACF,KAAK,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CA+GjE;IAWD;;;;;OAKG;IACH,MAAM,IAAI,IAAI,CAIb;CACF;AAID;;GAEG;AACH,qBAAa,aAAa;;IACxB;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,CAAA;IAK9B;;;OAGG;IACH,YAAY,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,EAGpD;IAED;;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 { ContentDisposition, ContentType, parse as parseRawHeaders } 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';
@@ -36,7 +45,7 @@ export class MaxFileSizeExceededError extends MultipartParseError {
  *
  * @param message The multipart message as a `Uint8Array` or an iterable of `Uint8Array` chunks
  * @param options Options for the parser
- * @return A generator that yields `MultipartPart` objects
+ * @returns A generator that yields `MultipartPart` objects
  */
 export function* parseMultipart(message, options) {
     let parser = new MultipartParser(options.boundary, {
@@ -64,7 +73,7 @@ export function* parseMultipart(message, options) {
  *
  * @param stream A stream containing multipart data as a `ReadableStream<Uint8Array>`
  * @param options Options for the parser
- * @return An async generator that yields `MultipartPart` objects
+ * @returns An async generator that yields `MultipartPart` objects
  */
 export async function* parseMultipartStream(stream, options) {
     let parser = new MultipartParser(options.boundary, {
@@ -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;
@@ -117,7 +130,7 @@ export class MultipartParser {
      * Write a chunk of data to the parser.
      *
      * @param chunk A chunk of data to write to the parser
-     * @return A generator yielding `MultipartPart` objects as they are parsed
+     * @returns A generator yielding `MultipartPart` objects as they are parsed
      */
     *write(chunk) {
         if (this.#state === MultipartParserStateDone) {
@@ -216,8 +229,6 @@ export class MultipartParser {
      *
      * Note: This will throw if the multipart message is incomplete or
      * wasn't properly terminated.
-     *
-     * @return void
      */
     finish() {
         if (this.#state !== MultipartParserStateDone) {
@@ -236,6 +247,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;
@@ -264,7 +279,7 @@ export class MultipartPart {
      */
     get headers() {
         if (!this.#headers) {
-            this.#headers = new Headers(decoder.decode(this.#header));
+            this.#headers = parseRawHeaders(decoder.decode(this.#header));
         }
         return this.#headers;
     }
@@ -284,19 +299,19 @@ export class MultipartPart {
      * The filename of the part, if it is a file upload.
      */
     get filename() {
-        return this.headers.contentDisposition.preferredFilename;
+        return ContentDisposition.from(this.headers.get('content-disposition')).preferredFilename;
     }
     /**
      * The media type of the part.
      */
     get mediaType() {
-        return this.headers.contentType.mediaType;
+        return ContentType.from(this.headers.get('content-type')).mediaType;
     }
     /**
      * The name of the part, usually the `name` of the field in the `<form>` that submitted the request.
      */
     get name() {
-        return this.headers.contentDisposition.name;
+        return ContentDisposition.from(this.headers.get('content-disposition')).name;
     }
     /**
      * The size of the content in bytes.

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

@@ -9,7 +9,7 @@ import type { ParseMultipartOptions, MultipartParserOptions, MultipartPart } fro
  *
  * @param message The multipart message as a `Buffer` or an iterable of `Buffer` chunks
  * @param options Options for the parser
- * @return A generator yielding `MultipartPart` objects
+ * @returns A generator yielding `MultipartPart` objects
  */
 export declare function parseMultipart(message: Buffer | Iterable<Buffer>, options: ParseMultipartOptions): Generator<MultipartPart, void, unknown>;
 /**
@@ -20,14 +20,14 @@ export declare function parseMultipart(message: Buffer | Iterable<Buffer>, optio
  *
  * @param stream A Node.js `Readable` stream containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export declare function parseMultipartStream(stream: Readable, options: ParseMultipartOptions): AsyncGenerator<MultipartPart, void, unknown>;
 /**
  * Returns true if the given request is a multipart request.
  *
  * @param req The Node.js `http.IncomingMessage` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export declare function isMultipartRequest(req: http.IncomingMessage): boolean;
 /**
@@ -35,7 +35,7 @@ export declare function isMultipartRequest(req: http.IncomingMessage): boolean;
  *
  * @param req The Node.js `http.IncomingMessage` object containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export declare function parseMultipartRequest(req: http.IncomingMessage, options?: MultipartParserOptions): AsyncGenerator<MultipartPart, void, unknown>;
 //# sourceMappingURL=multipart.node.d.ts.map

package/dist/lib/multipart.node.js

@@ -9,7 +9,7 @@ import { getMultipartBoundary } from "./multipart-request.js";
  *
  * @param message The multipart message as a `Buffer` or an iterable of `Buffer` chunks
  * @param options Options for the parser
- * @return A generator yielding `MultipartPart` objects
+ * @returns A generator yielding `MultipartPart` objects
  */
 export function* parseMultipart(message, options) {
     yield* parseMultipartWeb(message, options);
@@ -22,7 +22,7 @@ export function* parseMultipart(message, options) {
  *
  * @param stream A Node.js `Readable` stream containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartStream(stream, options) {
     yield* parseMultipartStreamWeb(Readable.toWeb(stream), options);
@@ -31,7 +31,7 @@ export async function* parseMultipartStream(stream, options) {
  * Returns true if the given request is a multipart request.
  *
  * @param req The Node.js `http.IncomingMessage` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export function isMultipartRequest(req) {
     let contentType = req.headers['content-type'];
@@ -42,7 +42,7 @@ export function isMultipartRequest(req) {
  *
  * @param req The Node.js `http.IncomingMessage` object containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartRequest(req, options) {
     if (!isMultipartRequest(req)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remix-run/multipart-parser",
-  "version": "0.13.0",
+  "version": "0.14.1",
   "description": "A fast, efficient parser for multipart streams in any JavaScript environment",
   "author": "Michael Jackson <mjijackson@gmail.com>",
   "repository": {
@@ -29,12 +29,12 @@
     },
     "./package.json": "./package.json"
   },
-  "dependencies": {
-    "@remix-run/headers": "^0.15.0"
+  "peerDependencies": {
+    "@remix-run/headers": "^0.19.0"
   },
   "devDependencies": {
     "@types/node": "^24.6.0",
-    "typescript": "^5.9.3"
+    "@typescript/native-preview": "7.0.0-dev.20251125.1"
   },
   "keywords": [
     "multipart",
@@ -47,9 +47,9 @@
     "bench:bun": "bun run ./bench/runner.ts",
     "bench:deno": "deno run --allow-sys ./bench/runner.ts",
     "bench:node": "node --disable-warning=ExperimentalWarning ./bench/runner.ts",
-    "build": "tsc -p tsconfig.build.json",
+    "build": "tsgo -p tsconfig.build.json",
     "clean": "git clean -fdX",
-    "test": "node --disable-warning=ExperimentalWarning --test './src/**/*.test.ts'",
-    "typecheck": "tsc --noEmit"
+    "test": "node --disable-warning=ExperimentalWarning --test",
+    "typecheck": "tsgo --noEmit"
   }
 }

package/src/lib/buffer-search.ts

@@ -6,9 +6,12 @@ export function createSearch(pattern: string): SearchFunction {
   let needle = new TextEncoder().encode(pattern)
 
   let search: SearchFunction
-  if ('Buffer' in globalThis && !('Bun' in globalThis || 'Deno' in globalThis)) {
-    // Use the built-in Buffer.indexOf method on Node.js for better perf.
-    search = (haystack, start = 0) => Buffer.prototype.indexOf.call(haystack, needle, start)
+  // Use the built-in Buffer.indexOf method on Node.js for better perf.
+  let BufferClass = (globalThis as any).Buffer as
+    | { prototype: { indexOf(this: Uint8Array, needle: Uint8Array, start: number): number } }
+    | undefined
+  if (BufferClass && !('Bun' in globalThis || 'Deno' in globalThis)) {
+    search = (haystack, start = 0) => BufferClass.prototype.indexOf.call(haystack, needle, start)
   } else {
     let needleEnd = needle.length - 1
     let skipTable = new Uint8Array(256).fill(needle.length)

package/src/lib/multipart-request.ts

@@ -5,7 +5,7 @@ import { MultipartParseError, parseMultipartStream } from './multipart.ts'
  * Extracts the boundary string from a `multipart/*` content type.
  *
  * @param contentType The `Content-Type` header value from the request
- * @return The boundary string if found, or null if not present
+ * @returns The boundary string if found, or null if not present
  */
 export function getMultipartBoundary(contentType: string): string | null {
   let match = /boundary=(?:"([^"]+)"|([^;]+))/i.exec(contentType)
@@ -16,7 +16,7 @@ export function getMultipartBoundary(contentType: string): string | null {
  * Returns true if the given request contains multipart data.
  *
  * @param request The `Request` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export function isMultipartRequest(request: Request): boolean {
   let contentType = request.headers.get('Content-Type')
@@ -29,7 +29,7 @@ export function isMultipartRequest(request: Request): boolean {
  *
  * @param request The `Request` object containing multipart data
  * @param options Optional parser options, such as `maxHeaderSize` and `maxFileSize`
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartRequest(
   request: Request,

package/src/lib/multipart.node.ts

@@ -17,7 +17,7 @@ import { getMultipartBoundary } from './multipart-request.ts'
  *
  * @param message The multipart message as a `Buffer` or an iterable of `Buffer` chunks
  * @param options Options for the parser
- * @return A generator yielding `MultipartPart` objects
+ * @returns A generator yielding `MultipartPart` objects
  */
 export function* parseMultipart(
   message: Buffer | Iterable<Buffer>,
@@ -34,7 +34,7 @@ export function* parseMultipart(
  *
  * @param stream A Node.js `Readable` stream containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartStream(
   stream: Readable,
@@ -47,7 +47,7 @@ export async function* parseMultipartStream(
  * Returns true if the given request is a multipart request.
  *
  * @param req The Node.js `http.IncomingMessage` object to check
- * @return `true` if the request is a multipart request, `false` otherwise
+ * @returns `true` if the request is a multipart request, `false` otherwise
  */
 export function isMultipartRequest(req: http.IncomingMessage): boolean {
   let contentType = req.headers['content-type']
@@ -59,7 +59,7 @@ export function isMultipartRequest(req: http.IncomingMessage): boolean {
  *
  * @param req The Node.js `http.IncomingMessage` object containing multipart data
  * @param options Options for the parser
- * @return An async generator yielding `MultipartPart` objects
+ * @returns An async generator yielding `MultipartPart` objects
  */
 export async function* parseMultipartRequest(
   req: http.IncomingMessage,

package/src/lib/multipart.ts

@@ -1,13 +1,20 @@
-import Headers from '@remix-run/headers'
-
+import { ContentDisposition, ContentType, parse as parseRawHeaders } 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
 }
@@ -64,7 +80,7 @@ export interface ParseMultipartOptions {
  *
  * @param message The multipart message as a `Uint8Array` or an iterable of `Uint8Array` chunks
  * @param options Options for the parser
- * @return A generator that yields `MultipartPart` objects
+ * @returns A generator that yields `MultipartPart` objects
  */
 export function* parseMultipart(
   message: Uint8Array | Iterable<Uint8Array>,
@@ -98,7 +114,7 @@ export function* parseMultipart(
  *
  * @param stream A stream containing multipart data as a `ReadableStream<Uint8Array>`
  * @param options Options for the parser
- * @return An async generator that yields `MultipartPart` objects
+ * @returns An async generator that yields `MultipartPart` objects
  */
 export async function* parseMultipartStream(
   stream: ReadableStream<Uint8Array>,
@@ -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
@@ -168,7 +191,7 @@ export class MultipartParser {
    * Write a chunk of data to the parser.
    *
    * @param chunk A chunk of data to write to the parser
-   * @return A generator yielding `MultipartPart` objects as they are parsed
+   * @returns A generator yielding `MultipartPart` objects as they are parsed
    */
   *write(chunk: Uint8Array): Generator<MultipartPart, void, unknown> {
     if (this.#state === MultipartParserStateDone) {
@@ -297,8 +320,6 @@ export class MultipartParser {
    *
    * Note: This will throw if the multipart message is incomplete or
    * wasn't properly terminated.
-   *
-   * @return void
    */
   finish(): void {
     if (this.#state !== MultipartParserStateDone) {
@@ -321,6 +342,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
@@ -354,7 +379,7 @@ export class MultipartPart {
    */
   get headers(): Headers {
     if (!this.#headers) {
-      this.#headers = new Headers(decoder.decode(this.#header))
+      this.#headers = parseRawHeaders(decoder.decode(this.#header))
     }
 
     return this.#headers
@@ -378,21 +403,21 @@ export class MultipartPart {
    * The filename of the part, if it is a file upload.
    */
   get filename(): string | undefined {
-    return this.headers.contentDisposition.preferredFilename
+    return ContentDisposition.from(this.headers.get('content-disposition')).preferredFilename
   }
 
   /**
    * The media type of the part.
    */
   get mediaType(): string | undefined {
-    return this.headers.contentType.mediaType
+    return ContentType.from(this.headers.get('content-type')).mediaType
   }
 
   /**
    * The name of the part, usually the `name` of the field in the `<form>` that submitted the request.
    */
   get name(): string | undefined {
-    return this.headers.contentDisposition.name
+    return ContentDisposition.from(this.headers.get('content-disposition')).name
   }
 
   /**