Add doc comments, style tweaks

Author: mjackson

packages/multipart-parser/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This is the changelog for [`multipart-parser`](https://github.com/mjackson/remix-the-web/tree/main/packages/multipart-parser). It follows [semantic versioning](https://semver.org/).
 
+## HEAD
+
+- Add doc comments on custom error classes
+
 ## v0.10.0 (2025-06-13)
 
 This release represents a major refactoring and simplification of this library from a `async`/promise-based architecture to a generator that suspends the parser as parts are found.

packages/multipart-parser/examples/bun/server.ts

@@ -1,7 +1,7 @@
 import { MultipartParseError, parseMultipartRequest } from '@mjackson/multipart-parser';
 import tmp from 'tmp';
 
-let server = Bun.serve({
+const server = Bun.serve({
   port: 3000,
   async fetch(request) {
     if (request.method === 'GET') {

packages/multipart-parser/examples/node/server.js

@@ -6,7 +6,7 @@ import { MultipartParseError, parseMultipartRequest } from '@mjackson/multipart-
 
 const PORT = 3000;
 
-let server = http.createServer(async (req, res) => {
+const server = http.createServer(async (req, res) => {
   if (req.method === 'GET') {
     res.writeHead(200, { 'Content-Type': 'text/html' });
     res.end(`

packages/multipart-parser/src/lib/multipart.ts

@@ -4,20 +4,29 @@ 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 {
   constructor(message: string) {
     super(message);
     this.name = 'MultipartParseError';
   }
 }
 
+/**
+ * An error thrown when the maximum allowed size of a header is exceeded.
+ */
 export class MaxHeaderSizeExceededError extends MultipartParseError {
   constructor(maxHeaderSize: number) {
     super(`Multipart header size exceeds maximum allowed size of ${maxHeaderSize} bytes`);
     this.name = 'MaxHeaderSizeExceededError';
   }
 }
 
+/**
+ * An error thrown when the maximum allowed size of a file is exceeded.
+ */
 export class MaxFileSizeExceededError extends MultipartParseError {
   constructor(maxFileSize: number) {
     super(`File size exceeds maximum allowed size of ${maxFileSize} bytes`);