Skip to content

Commit 02e1f1e

Browse files
committed
docs: add known caveats to customFetch
1 parent 58f81d2 commit 02e1f1e

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/jwks/remote/variables/customFetch.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Support from the community to continue maintaining and improving this module is
99
When passed to [createRemoteJWKSet](../functions/createRemoteJWKSet.md) this allows the resolver
1010
to make use of advanced fetch configurations, HTTP Proxies, retry on network errors, etc.
1111

12+
> [!NOTE]\
13+
> Known caveat: Expect Type-related issues when passing the inputs through to fetch-like modules,
14+
> they hardly ever get their typings inline with actual fetch, you should `@ts-expect-error` them.
15+
1216
## Examples
1317

1418
Using [sindresorhus/ky](https://github.com/sindresorhus/ky) for retries and its hooks feature for

src/jwks/remote.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ if (typeof navigator === 'undefined' || !navigator.userAgent?.startsWith?.('Mozi
3636
* When passed to {@link jwks/remote.createRemoteJWKSet createRemoteJWKSet} this allows the resolver
3737
* to make use of advanced fetch configurations, HTTP Proxies, retry on network errors, etc.
3838
*
39+
* > [!NOTE]\
40+
* > Known caveat: Expect Type-related issues when passing the inputs through to fetch-like modules,
41+
* > they hardly ever get their typings inline with actual fetch, you should `@ts-expect-error` them.
42+
*
3943
* @example
4044
*
4145
* Using [sindresorhus/ky](https://github.com/sindresorhus/ky) for retries and its hooks feature for

0 commit comments

Comments
 (0)