From 072da62d10d522bc0fd68fabe3015bfa7fe2c42b Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Sun, 20 Oct 2024 17:12:57 +0200 Subject: [PATCH] docs: document behaviour of customFetch on discovery --- docs/interfaces/DiscoveryRequestOptions.md | 4 +++- src/index.ts | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/interfaces/DiscoveryRequestOptions.md b/docs/interfaces/DiscoveryRequestOptions.md index da56c0e6..fbd17536 100644 --- 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 index 5cc16ff3..4ae87be4 100644 --- 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} */