docs: update getValidatedIdTokenClaims description

panva · Feb 18, 2025 · 15836c5 · 15836c5
1 parent 1cf0cca
commit 15836c5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/docs/functions/getValidatedIdTokenClaims.md b/docs/functions/getValidatedIdTokenClaims.md
@@ -8,15 +8,15 @@ Support from the community to continue maintaining and improving this module is
 
 ▸ **getValidatedIdTokenClaims**(`ref`): [`IDToken`](../interfaces/IDToken.md) \| `undefined`
 
-Returns ID Token claims validated during [processRefreshTokenResponse](processRefreshTokenResponse.md),
-[processBackchannelAuthenticationGrantResponse](processBackchannelAuthenticationGrantResponse.md), or [processDeviceCodeResponse](processDeviceCodeResponse.md). To
-optionally validate its JWS Signature use [validateApplicationLevelSignature](validateApplicationLevelSignature.md)
+Returns ID Token Claims Set from a [TokenEndpointResponse](../interfaces/TokenEndpointResponse.md) processed by e.g.
+[processAuthorizationCodeResponse](processAuthorizationCodeResponse.md). To optionally validate the ID Token Signature use
+[validateApplicationLevelSignature](validateApplicationLevelSignature.md).
 
 ## Parameters
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `ref` | [`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) | Value previously resolved from [processRefreshTokenResponse](processRefreshTokenResponse.md), [processBackchannelAuthenticationGrantResponse](processBackchannelAuthenticationGrantResponse.md), or [processDeviceCodeResponse](processDeviceCodeResponse.md). |
+| `ref` | [`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) | [TokenEndpointResponse](../interfaces/TokenEndpointResponse.md) previously resolved from e.g. [processAuthorizationCodeResponse](processAuthorizationCodeResponse.md) |
 
 ## Returns
 

diff --git a/src/index.ts b/src/index.ts
@@ -3191,12 +3191,12 @@ const idTokenClaims = new WeakMap<TokenEndpointResponse, IDToken>()
 const jwtRefs = new WeakMap<Response, string>()
 
 /**
- * Returns ID Token claims validated during {@link processRefreshTokenResponse},
- * {@link processBackchannelAuthenticationGrantResponse}, or {@link processDeviceCodeResponse}. To
- * optionally validate its JWS Signature use {@link validateApplicationLevelSignature}
+ * Returns ID Token Claims Set from a {@link TokenEndpointResponse} processed by e.g.
+ * {@link processAuthorizationCodeResponse}. To optionally validate the ID Token Signature use
+ * {@link validateApplicationLevelSignature}.
  *
- * @param ref Value previously resolved from {@link processRefreshTokenResponse},
- *   {@link processBackchannelAuthenticationGrantResponse}, or {@link processDeviceCodeResponse}.
+ * @param ref {@link TokenEndpointResponse} previously resolved from e.g.
+ *   {@link processAuthorizationCodeResponse}
  *
  * @returns JWT Claims Set from an ID Token, or undefined if there is no ID Token in `ref`.
  *