docs: add note about createRemoteJWKSet to get key interfaces

panva · Apr 1, 2021 · 8282c28 · 8282c28
1 parent cb856c8
commit 8282c28
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/src/jws/compact/verify.ts b/src/jws/compact/verify.ts
@@ -13,6 +13,9 @@ import type {
 /**
  * Interface for Compact JWS Verification dynamic key resolution.
  * No token components have been verified at the time of this function call.
+ *
+ * See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset)
+ * to verify using a remote JSON Web Key Set.
  */
 export interface CompactVerifyGetKey
   extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {}

diff --git a/src/jws/flattened/verify.ts b/src/jws/flattened/verify.ts
@@ -24,6 +24,9 @@ const checkAlgOption = validateAlgorithms.bind(undefined, 'algorithms')
 /**
  * Interface for Flattened JWS Verification dynamic key resolution.
  * No token components have been verified at the time of this function call.
+ *
+ * See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset)
+ * to verify using a remote JSON Web Key Set.
  */
 export interface FlattenedVerifyGetKey
   extends GetKeyFunction<JWSHeaderParameters | undefined, FlattenedJWSInput> {}

diff --git a/src/jws/general/verify.ts b/src/jws/general/verify.ts
@@ -14,6 +14,9 @@ import isObject from '../../lib/is_object.js'
 /**
  * Interface for General JWS Verification dynamic key resolution.
  * No token components have been verified at the time of this function call.
+ *
+ * See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset)
+ * to verify using a remote JSON Web Key Set.
  */
 export interface GeneralVerifyGetKey
   extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {}

diff --git a/src/jwt/verify.ts b/src/jwt/verify.ts
@@ -20,6 +20,9 @@ interface JWTVerifyOptions extends VerifyOptions, JWTClaimVerificationOptions {}
 /**
  * Interface for JWT Verification dynamic key resolution.
  * No token components have been verified at the time of this function call.
+ *
+ * See [createRemoteJWKSet](../functions/jwks_remote.createremotejwkset.md#function-createremotejwkset)
+ * to verify using a remote JSON Web Key Set.
  */
 export interface JWTVerifyGetKey extends GetKeyFunction<JWSHeaderParameters, FlattenedJWSInput> {}