docs: document behaviour of customFetch on discovery

panva · Oct 20, 2024 · 072da62 · 072da62
1 parent 71b62d1
commit 072da62
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md
@@ -13,7 +13,9 @@ Support from the community to continue maintaining and improving this module is
 • `optional` **\[customFetch\]**: [`CustomFetch`](../type-aliases/CustomFetch.md)
 
 Custom [Fetch API](https://developer.mozilla.org/docs/Web/API/Window/fetch) implementation to use for the HTTP Requests
-the client will be making.
+the client will be making. If this option is used, then the same timeout
+value will be assigned to the resolved [Configuration](../classes/Configuration.md) instance for
+use with all its future individual HTTP requests.
 
 #### See
 

diff --git a/src/index.ts b/src/index.ts
@@ -939,7 +939,9 @@ export function randomDPoPKeyPair(
 export interface DiscoveryRequestOptions {
   /**
    * Custom {@link !fetch Fetch API} implementation to use for the HTTP Requests
-   * the client will be making.
+   * the client will be making. If this option is used, then the same timeout
+   * value will be assigned to the resolved {@link Configuration} instance for
+   * use with all its future individual HTTP requests.
    *
    * @see {@link customFetch}
    */