Skip to content

Commit 072da62

Browse files
committed
docs: document behaviour of customFetch on discovery
1 parent 71b62d1 commit 072da62

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/interfaces/DiscoveryRequestOptions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Support from the community to continue maintaining and improving this module is
1313
`optional` **\[customFetch\]**: [`CustomFetch`](../type-aliases/CustomFetch.md)
1414

1515
Custom [Fetch API](https://developer.mozilla.org/docs/Web/API/Window/fetch) implementation to use for the HTTP Requests
16-
the client will be making.
16+
the client will be making. If this option is used, then the same timeout
17+
value will be assigned to the resolved [Configuration](../classes/Configuration.md) instance for
18+
use with all its future individual HTTP requests.
1719

1820
#### See
1921

src/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -939,7 +939,9 @@ export function randomDPoPKeyPair(
939939
export interface DiscoveryRequestOptions {
940940
/**
941941
* Custom {@link !fetch Fetch API} implementation to use for the HTTP Requests
942-
* the client will be making.
942+
* the client will be making. If this option is used, then the same timeout
943+
* value will be assigned to the resolved {@link Configuration} instance for
944+
* use with all its future individual HTTP requests.
943945
*
944946
* @see {@link customFetch}
945947
*/

0 commit comments

Comments
 (0)