release: next-test-api-route-handler@5.0.3 [skip ci]

Xunnamius · Xunnamius · commit dff9c33196c6 · 2025-09-03T23:55:25.000-07:00
## ⚡️ Optimizations - Use Node's ReadableStream.from instead of ponyfill ([6f32402][2]) [1]: https://github.com/Xunnamius/next-test-api-route-handler/compare/next-test-api-route-handler@5.0.2...next-test-api-route-handler@5.0.3 [2]: 6f32402
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/README.md b/docs/README.md
@@ -7,7 +7,5 @@
 ## Modules
 
 - [src](src/README.md)
-- [test/integration/integration-smoke-external.ignore](test/integration/integration-smoke-external.ignore/README.md)
 - [test/setup](test/setup/README.md)
-- [test/unit-external.ignore](test/unit-external.ignore/README.md)
 - [test/util](test/util/README.md)
diff --git a/docs/src/functions/testApiHandler.md b/docs/src/functions/testApiHandler.md
@@ -8,7 +8,7 @@
 
 > **testApiHandler**\<`NextResponseJsonType`\>(`__namedParameters`): `Promise`\<`void`\>
 
-Defined in: [src/index.ts:310](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L310)
+Defined in: [src/index.ts:311](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L311)
 
 Uses Next's internal `apiResolver` (for Pages Router) or an
 `AppRouteRouteModule` instance (for App Router) to execute api route handlers
diff --git a/docs/src/interfaces/NtarhInit.md b/docs/src/interfaces/NtarhInit.md
@@ -6,7 +6,7 @@
 
 # Interface: NtarhInit\<NextResponseJsonType\>
 
-Defined in: [src/index.ts:144](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L144)
+Defined in: [src/index.ts:145](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L145)
 
 ## Extended by
 
@@ -25,7 +25,7 @@ Defined in: [src/index.ts:144](https://github.com/Xunnamius/next-test-api-route-
 
 > `optional` **rejectOnHandlerError**: `boolean`
 
-Defined in: [src/index.ts:157](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L157)
+Defined in: [src/index.ts:158](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L158)
 
 If `false`, errors thrown from within a handler are kicked up to Next.js's
 resolver to deal with, which is what would happen in production. If `true`,
@@ -48,7 +48,7 @@ false
 
 > **test**: (`parameters`) => `Promisable`\<`void`\>
 
-Defined in: [src/index.ts:163](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L163)
+Defined in: [src/index.ts:164](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L164)
 
 `test` is a function that runs your test assertions. This function receives
 one destructured parameter: `fetch`, which is equivalent to
diff --git a/docs/src/interfaces/NtarhInitAppRouter.md b/docs/src/interfaces/NtarhInitAppRouter.md
@@ -6,7 +6,7 @@
 
 # Interface: NtarhInitAppRouter\<NextResponseJsonType\>
 
-Defined in: [src/index.ts:174](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L174)
+Defined in: [src/index.ts:175](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L175)
 
 The parameters expected by `testApiHandler` when using `appHandler`.
 
@@ -26,7 +26,7 @@ The parameters expected by `testApiHandler` when using `appHandler`.
 
 > **appHandler**: `Partial`\<`Omit`\<`AppRouteUserlandModule`, keyof `AppRouteHandlers`\> & `{ [key in keyof AppRouteHandlers]?: (req: NextRequest, segmentData?: any) => any }`\>
 
-Defined in: [src/index.ts:183](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L183)
+Defined in: [src/index.ts:184](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L184)
 
 The actual App Router route handler under test. It should be an object
 containing one or more async functions named for valid HTTP methods and/or
@@ -40,15 +40,15 @@ for details.
 
 > `optional` **pagesHandler**: `undefined`
 
-Defined in: [src/index.ts:194](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L194)
+Defined in: [src/index.ts:195](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L195)
 
 ***
 
 ### params?
 
 > `optional` **params**: `Record`\<`string`, `string` \| `string`[]\>
 
-Defined in: [src/index.ts:204](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L204)
+Defined in: [src/index.ts:205](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L205)
 
 `params` is passed directly to the handler and represents processed dynamic
 routes. This should not be confused with query string parsing, which is
@@ -64,7 +64,7 @@ once.
 
 > `optional` **paramsPatcher**: (`params`) => `Promisable`\<`void` \| `Record`\<`string`, `string` \| `string`[]\>\>
 
-Defined in: [src/index.ts:214](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L214)
+Defined in: [src/index.ts:215](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L215)
 
 A function that receives `params`, an object representing "processed"
 dynamic route parameters. Modifications to `params` are passed directly to
@@ -90,7 +90,7 @@ is handled by `Request` automatically.
 
 > `optional` **rejectOnHandlerError**: `boolean`
 
-Defined in: [src/index.ts:157](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L157)
+Defined in: [src/index.ts:158](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L158)
 
 If `false`, errors thrown from within a handler are kicked up to Next.js's
 resolver to deal with, which is what would happen in production. If `true`,
@@ -117,7 +117,7 @@ false
 
 > `optional` **requestPatcher**: (`request`) => `Promisable`\<`void` \| `Request`\>
 
-Defined in: [src/index.ts:226](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L226)
+Defined in: [src/index.ts:227](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L227)
 
 A function that receives a `NextRequest` object and returns a `Request`
 instance. Use this function to edit the request _before_ it's injected
@@ -143,7 +143,7 @@ NextRequest(returnedRequest, { ... })`.
 
 > `optional` **responsePatcher**: (`res`) => `Promisable`\<`void` \| `Response`\>
 
-Defined in: [src/index.ts:239](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L239)
+Defined in: [src/index.ts:240](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L240)
 
 A function that receives the `Response` object returned from `appHandler`
 and returns a `Response` instance. Use this function to edit the response
@@ -170,7 +170,7 @@ unhandled exception occurs _and_ `rejectOnHandlerError` is `true`.
 
 > **test**: (`parameters`) => `Promisable`\<`void`\>
 
-Defined in: [src/index.ts:163](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L163)
+Defined in: [src/index.ts:164](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L164)
 
 `test` is a function that runs your test assertions. This function receives
 one destructured parameter: `fetch`, which is equivalent to
@@ -198,7 +198,7 @@ one destructured parameter: `fetch`, which is equivalent to
 
 > `optional` **url**: `string`
 
-Defined in: [src/index.ts:244](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L244)
+Defined in: [src/index.ts:245](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L245)
 
 `url: 'your-url'` is shorthand for `requestPatcher: (request) => new
 NextRequest('your-url', request)`
diff --git a/docs/src/interfaces/NtarhInitPagesRouter.md b/docs/src/interfaces/NtarhInitPagesRouter.md
@@ -6,7 +6,7 @@
 
 # Interface: NtarhInitPagesRouter\<NextResponseJsonType\>
 
-Defined in: [src/index.ts:250](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L250)
+Defined in: [src/index.ts:251](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L251)
 
 The parameters expected by `testApiHandler` when using `pagesHandler`.
 
@@ -26,15 +26,15 @@ The parameters expected by `testApiHandler` when using `pagesHandler`.
 
 > `optional` **appHandler**: `undefined`
 
-Defined in: [src/index.ts:262](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L262)
+Defined in: [src/index.ts:263](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L263)
 
 ***
 
 ### pagesHandler
 
 > **pagesHandler**: `NextApiHandler` \| \{ `default`: `NextApiHandler`; \}
 
-Defined in: [src/index.ts:261](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L261)
+Defined in: [src/index.ts:262](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L262)
 
 The actual Pages Router route handler under test. It should be an async
 function that accepts `NextApiRequest` and `NextApiResult` objects (in
@@ -50,7 +50,7 @@ will have a typed result.
 
 > `optional` **params**: `Record`\<`string`, `unknown`\>
 
-Defined in: [src/index.ts:272](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L272)
+Defined in: [src/index.ts:273](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L273)
 
 `params` is passed directly to the handler and represents processed dynamic
 routes. This should not be confused with query string parsing, which is
@@ -66,7 +66,7 @@ once.
 
 > `optional` **paramsPatcher**: (`params`) => `Promisable`\<`void` \| `Record`\<`string`, `unknown`\>\>
 
-Defined in: [src/index.ts:282](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L282)
+Defined in: [src/index.ts:283](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L283)
 
 A function that receives `params`, an object representing "processed"
 dynamic route parameters. Modifications to `params` are passed directly to
@@ -92,7 +92,7 @@ is handled automatically.
 
 > `optional` **rejectOnHandlerError**: `boolean`
 
-Defined in: [src/index.ts:157](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L157)
+Defined in: [src/index.ts:158](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L158)
 
 If `false`, errors thrown from within a handler are kicked up to Next.js's
 resolver to deal with, which is what would happen in production. If `true`,
@@ -119,7 +119,7 @@ false
 
 > `optional` **requestPatcher**: (`request`) => `Promisable`\<`void`\>
 
-Defined in: [src/index.ts:292](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L292)
+Defined in: [src/index.ts:293](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L293)
 
 A function that receives an `IncomingMessage` object. Use this function
 to edit the request _before_ it's injected into the handler.
@@ -143,7 +143,7 @@ lowercase.**
 
 > `optional` **responsePatcher**: (`res`) => `Promisable`\<`void`\>
 
-Defined in: [src/index.ts:297](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L297)
+Defined in: [src/index.ts:298](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L298)
 
 A function that receives a `ServerResponse` object. Use this function
 to edit the response _before_ it's injected into the handler.
@@ -164,7 +164,7 @@ to edit the response _before_ it's injected into the handler.
 
 > **test**: (`parameters`) => `Promisable`\<`void`\>
 
-Defined in: [src/index.ts:163](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L163)
+Defined in: [src/index.ts:164](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L164)
 
 `test` is a function that runs your test assertions. This function receives
 one destructured parameter: `fetch`, which is equivalent to
@@ -192,7 +192,7 @@ one destructured parameter: `fetch`, which is equivalent to
 
 > `optional` **url**: `string`
 
-Defined in: [src/index.ts:302](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/src/index.ts#L302)
+Defined in: [src/index.ts:303](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/src/index.ts#L303)
 
 `url: 'your-url'` is shorthand for `requestPatcher: (req) => { req.url =
 'your-url' }`
diff --git a/docs/test/integration/integration-smoke-external.ignore/README.md b/docs/test/integration/integration-smoke-external.ignore/README.md
diff --git a/docs/test/unit-external.ignore/README.md b/docs/test/unit-external.ignore/README.md
diff --git a/docs/test/util/README.md b/docs/test/util/README.md
@@ -88,7 +88,6 @@
 - [dummyNpmPackageFixture](functions/dummyNpmPackageFixture.md)
 - [ensurePackageHasBeenBuilt](functions/ensurePackageHasBeenBuilt.md)
 - [expectExceptionsWithMatchingErrors](functions/expectExceptionsWithMatchingErrors.md)
-- [getNextjsReactPeerDependencies](functions/getNextjsReactPeerDependencies.md)
 - [gitRepositoryFixture](functions/gitRepositoryFixture.md)
 - [isolatedImport](functions/isolatedImport.md)
 - [mockArgvFactory](functions/mockArgvFactory.md)
diff --git a/docs/test/util/functions/getNextjsReactPeerDependencies.md b/docs/test/util/functions/getNextjsReactPeerDependencies.md
diff --git a/docs/test/util/functions/nodeImportAndRunTestFixture.md b/docs/test/util/functions/nodeImportAndRunTestFixture.md
@@ -8,7 +8,7 @@
 
 > **nodeImportAndRunTestFixture**(): [`NodeImportAndRunTestFixture`](../type-aliases/NodeImportAndRunTestFixture.md)
 
-Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/dist/packages/test-mock-fixture/src/fixtures/node-import-and-run-test.d.ts:81
+Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/dist/packages/test-mock-fixture/src/fixtures/node-import-and-run-test.d.ts:92
 
 This fixture initializes the dummy root directory with an index file under
 `src` (described by `initialVirtualFiles`) and then executes it using node
diff --git a/docs/test/util/type-aliases/FixtureContext.md b/docs/test/util/type-aliases/FixtureContext.md
@@ -12,7 +12,7 @@ Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/d
 
 The context object passed around between every [MockFixture](MockFixture.md).
 
-## Type declaration
+## Type Declaration
 
 ### debug
 
diff --git a/docs/test/util/type-aliases/FixtureFs.md b/docs/test/util/type-aliases/FixtureFs.md
@@ -17,7 +17,7 @@ Note that all relative `PathLike` parameters are considered local to `root`,
 not the current working directory, and will be translated into
 AbsolutePaths as such.
 
-## Type declaration
+## Type Declaration
 
 ### isAccessible()
 
diff --git a/docs/test/util/type-aliases/NodeImportAndRunTestFixtureContext.md b/docs/test/util/type-aliases/NodeImportAndRunTestFixtureContext.md
@@ -8,7 +8,7 @@
 
 > **NodeImportAndRunTestFixtureContext** = `Tagged`\<\{ `testResult`: `RunReturnType`\<`RunOptions`\>; \}, *typeof* [`nodeImportAndRunTestFixtureName`](../variables/nodeImportAndRunTestFixtureName.md)\>
 
-Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/dist/packages/test-mock-fixture/src/fixtures/node-import-and-run-test.d.ts:65
+Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/dist/packages/test-mock-fixture/src/fixtures/node-import-and-run-test.d.ts:76
 
 Contains any additional context properties this fixture makes available by
 the time its `setup` function has successfully executed.
diff --git a/docs/test/util/type-aliases/NodeImportAndRunTestFixtureOptions.md b/docs/test/util/type-aliases/NodeImportAndRunTestFixtureOptions.md
@@ -6,7 +6,7 @@
 
 # Type Alias: NodeImportAndRunTestFixtureOptions
 
-> **NodeImportAndRunTestFixtureOptions** = `Tagged`\<\{ `runWith?`: \{ `args?`: `string`[]; `binary?`: `string`; `runnerOptions?`: `RunOptions`; \}; \}, *typeof* [`nodeImportAndRunTestFixtureName`](../variables/nodeImportAndRunTestFixtureName.md)\>
+> **NodeImportAndRunTestFixtureOptions** = `Tagged`\<\{ `runWith?`: \{ `args?`: `string`[]; `binary?`: `string`; `runnerOptions?`: `RunOptions`; `useIndexPath?`: `boolean`; \}; \}, *typeof* [`nodeImportAndRunTestFixtureName`](../variables/nodeImportAndRunTestFixtureName.md)\>
 
 Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-fixture/dist/packages/test-mock-fixture/src/fixtures/node-import-and-run-test.d.ts:20
 
diff --git a/docs/test/util/variables/ExitErrorMessage.md b/docs/test/util/variables/ExitErrorMessage.md
@@ -12,7 +12,7 @@ Defined in: node\_modules/@-xun/symbiote/node\_modules/@-xun/test-mock-exit/dist
 
 A collection of possible error and warning messages.
 
-## Type declaration
+## Type Declaration
 
 ### SuppressedExitAttempt()
 
diff --git a/docs/test/util/variables/globalDebugger.md b/docs/test/util/variables/globalDebugger.md
@@ -8,4 +8,4 @@
 
 > `const` **globalDebugger**: `ExtendedDebugger`
 
-Defined in: [test/util.ts:21](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/test/util.ts#L21)
+Defined in: [test/util.ts:27](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/test/util.ts#L27)
diff --git a/docs/test/util/variables/globalDebuggerNamespace.md b/docs/test/util/variables/globalDebuggerNamespace.md
@@ -8,7 +8,7 @@
 
 > `const` **globalDebuggerNamespace**: `"ntarh"` = `'ntarh'`
 
-Defined in: [test/util.ts:19](https://github.com/Xunnamius/next-test-api-route-handler/blob/fc0972ebac2c7f073379ab76e95e9fc328afef50/test/util.ts#L19)
+Defined in: [test/util.ts:25](https://github.com/Xunnamius/next-test-api-route-handler/blob/7680aa4482550d5e81f4eff590b7532434ed2196/test/util.ts#L25)
 
 The project-wide namespace that appears in debugger output. Only used in
 tests.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "next-test-api-route-handler",
-  "version": "5.0.2",
+  "version": "5.0.3",
   "description": "Confidently unit and integration test your Next.js API routes/handlers in an isolated Next.js-like environment",
   "keywords": [
     "api",
