refactor(types): move customFetch options into its own interface

panva · Dec 2, 2024 · 21c7d0a · 21c7d0a
1 parent e37a27a
commit 21c7d0a
Show file tree

Hide file tree

Showing 15 changed files with 93 additions and 95 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -188,6 +188,7 @@ Support from the community to continue maintaining and improving this module is
 - [ClientCredentialsGrantRequestOptions](interfaces/ClientCredentialsGrantRequestOptions.md)
 - [ConfirmationClaims](interfaces/ConfirmationClaims.md)
 - [CryptoKeyPair](interfaces/CryptoKeyPair.md)
+- [CustomFetchOptions](interfaces/CustomFetchOptions.md)
 - [DeviceAuthorizationRequestOptions](interfaces/DeviceAuthorizationRequestOptions.md)
 - [DeviceAuthorizationResponse](interfaces/DeviceAuthorizationResponse.md)
 - [DiscoveryRequestOptions](interfaces/DiscoveryRequestOptions.md)

diff --git a/docs/interfaces/ClientCredentialsGrantRequestOptions.md b/docs/interfaces/ClientCredentialsGrantRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/CustomFetchOptions.md b/docs/interfaces/CustomFetchOptions.md
@@ -0,0 +1,55 @@
+# Interface: CustomFetchOptions\<Method, BodyType\>
+
+[💗 Help the project](https://github.com/sponsors/panva)
+
+Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
+
+***
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `Method` | - |
+| `BodyType` | `undefined` |
+
+## Properties
+
+### body
+
+• **body**: `BodyType`
+
+The request body content to send to the server
+
+***
+
+### headers
+
+• **headers**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>
+
+HTTP Headers
+
+***
+
+### method
+
+• **method**: `Method`
+
+The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods)
+
+***
+
+### redirect
+
+• **redirect**: `"manual"`
+
+See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect)
+
+***
+
+### signal?
+
+• `optional` **signal**: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal)
+
+Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed,
+otherwise undefined
diff --git a/docs/interfaces/DeviceAuthorizationRequestOptions.md b/docs/interfaces/DeviceAuthorizationRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: `undefined`;`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"GET"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | `undefined` | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"GET"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"GET"`, `undefined`\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/HttpRequestOptions.md b/docs/interfaces/HttpRequestOptions.md
@@ -36,12 +36,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: `BodyType`;`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `Method`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | `BodyType` | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `Method` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`Method`, `BodyType`\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/IntrospectionRequestOptions.md b/docs/interfaces/IntrospectionRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/ProtectedResourceRequestOptions.md b/docs/interfaces/ProtectedResourceRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`ProtectedResourceRequestBody`](../type-aliases/ProtectedResourceRequestBody.md);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `string`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`ProtectedResourceRequestBody`](../type-aliases/ProtectedResourceRequestBody.md) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `string` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`string`, [`ProtectedResourceRequestBody`](../type-aliases/ProtectedResourceRequestBody.md)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/PushedAuthorizationRequestOptions.md b/docs/interfaces/PushedAuthorizationRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/RevocationRequestOptions.md b/docs/interfaces/RevocationRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/TokenEndpointRequestOptions.md b/docs/interfaces/TokenEndpointRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams);`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"POST"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams) | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"POST"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"POST"`, [`URLSearchParams`](https://developer.mozilla.org/docs/Web/API/URLSearchParams)\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns
 

diff --git a/docs/interfaces/UserInfoRequestOptions.md b/docs/interfaces/UserInfoRequestOptions.md
@@ -29,12 +29,7 @@ See [customFetch](../variables/customFetch.md).
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `url` | `string` | URL the request is being made sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `resource` argument |
-| `options` | \{`body`: `undefined`;`headers`: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>;`method`: `"GET"`;`redirect`: `"manual"`;`signal`: [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal); \} | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
-| `options.body` | `undefined` | The request body content to send to the server |
-| `options.headers` | [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\> | HTTP Headers |
-| `options.method` | `"GET"` | The [request method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) |
-| `options.redirect` | `"manual"` | See [Request.redirect](https://developer.mozilla.org/docs/Web/API/Request/redirect) |
-| `options.signal`? | [`AbortSignal`](https://developer.mozilla.org/docs/Web/API/AbortSignal) | Depending on whether [HttpRequestOptions.signal](HttpRequestOptions.md#signal) was used, if so, it is the value passed, otherwise undefined |
+| `options` | [`CustomFetchOptions`](CustomFetchOptions.md)\<`"GET"`, `undefined`\> | Options otherwise sent to [fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) as the `options` argument |
 
 #### Returns