release: [email protected] [skip ci]

## 🪄 Fixes

- **src:** address incompatibility with next\@15.2 ([69525da][2]) <sup>see [#1129][3]</sup>

## ⚙️ Build System

- **deps:** bump @whatwg-node/server from 0.9.66 to 0.9.70 ([1c11e5d][4])

[1]: https://github.com/Xunnamius/next-test-api-route-handler/compare/[email protected]@4.0.15
[2]: 69525da
[3]: #1129
[4]: 1c11e5d

Author: Xunnamius

CHANGELOG.md

@@ -1,25 +1,11 @@
-**next-test-api-route-handler** • **Docs**
+**next-test-api-route-handler**
 
 ***
 
 # next-test-api-route-handler
 
-## Interfaces
+## Modules
 
-- [NtarhInit](interfaces/NtarhInit.md)
-- [NtarhInitAppRouter](interfaces/NtarhInitAppRouter.md)
-- [NtarhInitPagesRouter](interfaces/NtarhInitPagesRouter.md)
-
-## Type Aliases
-
-- [FetchReturnType](type-aliases/FetchReturnType.md)
-- [Promisable](type-aliases/Promisable.md)
-
-## Variables
-
-- [$isPatched](variables/$isPatched.md)
-- [$originalGlobalFetch](variables/$originalGlobalFetch.md)
-
-## Functions
-
-- [testApiHandler](functions/testApiHandler.md)
+- [src](src/README.md)
+- [test/setup](test/setup/README.md)
+- [test/util](test/util/README.md)

docs/README.md

@@ -0,0 +1,17 @@
+[**next-test-api-route-handler**](../README.md)
+
+***
+
+[next-test-api-route-handler](../README.md) / src
+
+# src
+
+## Interfaces
+
+- [NtarhInit](interfaces/NtarhInit.md)
+- [NtarhInitAppRouter](interfaces/NtarhInitAppRouter.md)
+- [NtarhInitPagesRouter](interfaces/NtarhInitPagesRouter.md)
+
+## Functions
+
+- [testApiHandler](functions/testApiHandler.md)

docs/functions/testApiHandler.md

@@ -0,0 +1,29 @@
+[**next-test-api-route-handler**](../../README.md)
+
+***
+
+[next-test-api-route-handler](../../README.md) / [src](../README.md) / testApiHandler
+
+# Function: testApiHandler()
+
+> **testApiHandler**\<`NextResponseJsonType`\>(`__namedParameters`): `Promise`\<`void`\>
+
+Defined in: [src/index.ts:285](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L285)
+
+Uses Next's internal `apiResolver` (for Pages Router) or an
+`AppRouteRouteModule` instance (for App Router) to execute api route handlers
+in a Next-like testing environment.
+
+## Type Parameters
+
+• **NextResponseJsonType** = `any`
+
+## Parameters
+
+### \_\_namedParameters
+
+[`NtarhInitAppRouter`](../interfaces/NtarhInitAppRouter.md)\<`NextResponseJsonType`\> | [`NtarhInitPagesRouter`](../interfaces/NtarhInitPagesRouter.md)\<`NextResponseJsonType`\>
+
+## Returns
+
+`Promise`\<`void`\>

docs/src/README.md

@@ -1,12 +1,12 @@
-[**next-test-api-route-handler**](../README.md) • **Docs**
+[**next-test-api-route-handler**](../../README.md)
 
 ***
 
-[next-test-api-route-handler](../README.md) / NtarhInit
+[next-test-api-route-handler](../../README.md) / [src](../README.md) / NtarhInit
 
 # Interface: NtarhInit\<NextResponseJsonType\>
 
-**`Internal`**
+Defined in: [src/index.ts:119](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L119)
 
 ## Extended by
 
@@ -23,6 +23,8 @@
 
 > `optional` **rejectOnHandlerError**: `boolean`
 
+Defined in: [src/index.ts:132](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L132)
+
 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`,
 the [testApiHandler](../functions/testApiHandler.md) function will reject immediately instead.
@@ -38,30 +40,26 @@ negative despite exceptions being thrown.
 false
 ```
 
-#### Defined in
-
-[index.ts:137](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L137)
-
 ***
 
 ### test()
 
-> **test**: (`parameters`) => [`Promisable`](../type-aliases/Promisable.md)\<`void`\>
+> **test**: (`parameters`) => `Promisable`\<`void`\>
+
+Defined in: [src/index.ts:138](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L138)
 
 `test` is a function that runs your test assertions. This function receives
 one destructured parameter: `fetch`, which is equivalent to
 `globalThis.fetch` but with the first parameter omitted.
 
 #### Parameters
 
-• **parameters**
+##### parameters
 
-• **parameters.fetch**
+###### fetch
 
-#### Returns
-
-[`Promisable`](../type-aliases/Promisable.md)\<`void`\>
+(`customInit`?) => `FetchReturnType`\<`NextResponseJsonType`\>
 
-#### Defined in
+#### Returns
 
-[index.ts:143](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L143)
+`Promisable`\<`void`\>

docs/src/functions/testApiHandler.md

@@ -1,11 +1,13 @@
-[**next-test-api-route-handler**](../README.md) • **Docs**
+[**next-test-api-route-handler**](../../README.md)
 
 ***
 
-[next-test-api-route-handler](../README.md) / NtarhInitAppRouter
+[next-test-api-route-handler](../../README.md) / [src](../README.md) / NtarhInitAppRouter
 
 # Interface: NtarhInitAppRouter\<NextResponseJsonType\>
 
+Defined in: [src/index.ts:149](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L149)
+
 The parameters expected by `testApiHandler` when using `appHandler`.
 
 ## Extends
@@ -22,32 +24,30 @@ The parameters expected by `testApiHandler` when using `appHandler`.
 
 > **appHandler**: `Partial`\<`Omit`\<`AppRouteUserlandModule`, `"GET"` \| `"HEAD"` \| `"OPTIONS"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"PATCH"`\> & `object`\>
 
+Defined in: [src/index.ts:158](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L158)
+
 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
 a valid configuration option. See [the Next.js
 documentation](https://nextjs.org/docs/app/building-your-application/routing/route-handlers)
 for details.
 
-#### Defined in
-
-[index.ts:163](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L163)
-
 ***
 
 ### pagesHandler?
 
 > `optional` **pagesHandler**: `undefined`
 
-#### Defined in
-
-[index.ts:174](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L174)
+Defined in: [src/index.ts:169](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L169)
 
 ***
 
 ### params?
 
 > `optional` **params**: `Record`\<`string`, `string` \| `string`[]\>
 
+Defined in: [src/index.ts:179](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L179)
+
 `params` is passed directly to the handler and represents processed dynamic
 routes. This should not be confused with query string parsing, which is
 handled by `Request` automatically.
@@ -56,15 +56,13 @@ handled by `Request` automatically.
 params.id = 'some-id' }`. This is useful for quickly setting many params at
 once.
 
-#### Defined in
-
-[index.ts:184](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L184)
-
 ***
 
 ### paramsPatcher()?
 
-> `optional` **paramsPatcher**: (`params`) => [`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Record`\<`string`, `string` \| `string`[]\>\>
+> `optional` **paramsPatcher**: (`params`) => `Promisable`\<`void` \| `Record`\<`string`, `string` \| `string`[]\>\>
+
+Defined in: [src/index.ts:189](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L189)
 
 A function that receives `params`, an object representing "processed"
 dynamic route parameters. Modifications to `params` are passed directly to
@@ -76,22 +74,22 @@ is handled by `Request` automatically.
 
 #### Parameters
 
-• **params**: `Record`\<`string`, `string` \| `string`[]\>
-
-#### Returns
+##### params
 
-[`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Record`\<`string`, `string` \| `string`[]\>\>
+`Record`\<`string`, `string` \| `string`[]\>
 
-#### Defined in
+#### Returns
 
-[index.ts:194](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L194)
+`Promisable`\<`void` \| `Record`\<`string`, `string` \| `string`[]\>\>
 
 ***
 
 ### rejectOnHandlerError?
 
 > `optional` **rejectOnHandlerError**: `boolean`
 
+Defined in: [src/index.ts:132](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L132)
+
 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`,
 the [testApiHandler](../functions/testApiHandler.md) function will reject immediately instead.
@@ -111,15 +109,13 @@ false
 
 [`NtarhInit`](NtarhInit.md).[`rejectOnHandlerError`](NtarhInit.md#rejectonhandlererror)
 
-#### Defined in
-
-[index.ts:137](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L137)
-
 ***
 
 ### requestPatcher()?
 
-> `optional` **requestPatcher**: (`request`) => [`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Request`\>
+> `optional` **requestPatcher**: (`request`) => `Promisable`\<`void` \| `Request`\>
+
+Defined in: [src/index.ts:201](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L201)
 
 A function that receives a `NextRequest` object and returns a `Request`
 instance. Use this function to edit the request _before_ it's injected
@@ -131,21 +127,21 @@ NextRequest(returnedRequest, { ... })`.
 
 #### Parameters
 
-• **request**: `NextRequest`
-
-#### Returns
+##### request
 
-[`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Request`\>
+`NextRequest`
 
-#### Defined in
+#### Returns
 
-[index.ts:207](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L207)
+`Promisable`\<`void` \| `Request`\>
 
 ***
 
 ### responsePatcher()?
 
-> `optional` **responsePatcher**: (`res`) => [`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Response`\>
+> `optional` **responsePatcher**: (`res`) => `Promisable`\<`void` \| `Response`\>
+
+Defined in: [src/index.ts:214](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L214)
 
 A function that receives the `Response` object returned from `appHandler`
 and returns a `Response` instance. Use this function to edit the response
@@ -158,53 +154,49 @@ unhandled exception occurs _and_ `rejectOnHandlerError` is `true`.
 
 #### Parameters
 
-• **res**: `Response`
-
-#### Returns
+##### res
 
-[`Promisable`](../type-aliases/Promisable.md)\<`void` \| `Response`\>
+`Response`
 
-#### Defined in
+#### Returns
 
-[index.ts:220](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L220)
+`Promisable`\<`void` \| `Response`\>
 
 ***
 
 ### test()
 
-> **test**: (`parameters`) => [`Promisable`](../type-aliases/Promisable.md)\<`void`\>
+> **test**: (`parameters`) => `Promisable`\<`void`\>
+
+Defined in: [src/index.ts:138](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L138)
 
 `test` is a function that runs your test assertions. This function receives
 one destructured parameter: `fetch`, which is equivalent to
 `globalThis.fetch` but with the first parameter omitted.
 
 #### Parameters
 
-• **parameters**
+##### parameters
+
+###### fetch
 
-• **parameters.fetch**
+(`customInit`?) => `FetchReturnType`\<`NextResponseJsonType`\>
 
 #### Returns
 
-[`Promisable`](../type-aliases/Promisable.md)\<`void`\>
+`Promisable`\<`void`\>
 
 #### Inherited from
 
 [`NtarhInit`](NtarhInit.md).[`test`](NtarhInit.md#test)
 
-#### Defined in
-
-[index.ts:143](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L143)
-
 ***
 
 ### url?
 
 > `optional` **url**: `string`
 
+Defined in: [src/index.ts:219](https://github.com/Xunnamius/next-test-api-route-handler/blob/85e69e8c9f0f5d099e62128bf945b508df618dd6/src/index.ts#L219)
+
 `url: 'your-url'` is shorthand for `requestPatcher: (request) => new
 NextRequest('your-url', request)`
-
-#### Defined in
-
-[index.ts:225](https://github.com/Xunnamius/next-test-api-route-handler/blob/e773623b6be329996aafd723ed43e973bdc65aa6/src/index.ts#L225)