fix: readme #342
Merged
fix: readme #342
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
simoneb
reviewed
Apr 10, 2025
README.md
Outdated
| @@ -41,7 +43,7 @@ const getJwks = buildGetJwks({ | |||
| - `checkIssuer`: Optional user defined function to validate a token's domain. | |||
| - `providerDiscovery`: Indicates if the Provider Configuration Information is used to automatically get the jwks_uri from the [OpenID Provider Discovery Endpoint](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig). This endpoint is exposing the [Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). With this flag set to true the domain will be treated as the OpenID Issuer which is the iss property in the token. Defaults to false. Ignored if jwksPath is specified. | |||
| - `jwksPath`: Specify a relative path to the jwks_uri. Example `/otherdir/jwks.json`. Takes precedence over providerDiscovery. Optional. | |||
| - `agent`: The custom agent to use for requests, as specified in [node-fetch documentation](https://github.com/node-fetch/node-fetch#custom-agent). Defaults to `null`. | |||
| - `fetchOptions`: The custom [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit) used to instrument `fetch`. Optional. | |||
There was a problem hiding this comment.
are we sure that these are the ones that we should be referring to? aren't they those accepted by Undici, which while compliant with the standard (I believe) actually accepts different options?
There was a problem hiding this comment.
Undici accepts more parameters (like the dispatcher), with are not available in plain fetch
At the moment, we are using plain fetch provided by nodejs, which is compliant with the linked RequestInit
|
Can you please add a types test which confirms that we can pass a Node-specific option to fetchOptions? |
Closed
simoneb
approved these changes
Apr 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should address an issue raised in #341
Resolves #341