chore: format and re-run docs

panva · Sep 19, 2023 · 7c5a5a5 · 7c5a5a5
1 parent f8748b9
commit 7c5a5a5
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 21 deletions.
diff --git a/docs/interfaces/jwe_compact_decrypt.CompactDecryptGetKey.md b/docs/interfaces/jwe_compact_decrypt.CompactDecryptGetKey.md
@@ -15,8 +15,8 @@ verified at the time of this function call.
 
 ▸ **CompactDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jwe_flattened_decrypt.FlattenedDecryptGetKey.md b/docs/interfaces/jwe_flattened_decrypt.FlattenedDecryptGetKey.md
@@ -15,8 +15,8 @@ verified at the time of this function call.
 
 ▸ **FlattenedDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jwe_general_decrypt.GeneralDecryptGetKey.md b/docs/interfaces/jwe_general_decrypt.GeneralDecryptGetKey.md
@@ -15,8 +15,8 @@ verified at the time of this function call.
 
 ▸ **GeneralDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jws_compact_verify.CompactVerifyGetKey.md b/docs/interfaces/jws_compact_verify.CompactVerifyGetKey.md
@@ -19,8 +19,8 @@ verified at the time of this function call.
 
 ▸ **CompactVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jws_flattened_verify.FlattenedVerifyGetKey.md b/docs/interfaces/jws_flattened_verify.FlattenedVerifyGetKey.md
@@ -19,8 +19,8 @@ verified at the time of this function call.
 
 ▸ **FlattenedVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jws_general_verify.GeneralVerifyGetKey.md b/docs/interfaces/jws_general_verify.GeneralVerifyGetKey.md
@@ -19,8 +19,8 @@ verified at the time of this function call.
 
 ▸ **GeneralVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jwt_decrypt.JWTDecryptGetKey.md b/docs/interfaces/jwt_decrypt.JWTDecryptGetKey.md
@@ -15,8 +15,8 @@ the time of this function call.
 
 ▸ **JWTDecryptGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/jwt_verify.JWTVerifyGetKey.md b/docs/interfaces/jwt_verify.JWTVerifyGetKey.md
@@ -19,8 +19,8 @@ the time of this function call.
 
 ▸ **JWTVerifyGetKey**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/docs/interfaces/types.GetKeyFunction.md b/docs/interfaces/types.GetKeyFunction.md
@@ -21,8 +21,8 @@ Generic Interface for consuming operations dynamic key resolution.
 
 ▸ **GetKeyFunction**(`protectedHeader`, `token`): [`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md) \| [`Promise`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise )<[`Uint8Array`]( https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array ) \| [`KeyLike`](../types/types.KeyLike.md)\>
 
-Dynamic key resolution function. No token components have been
-verified at the time of this function call.
+Dynamic key resolution function. No token components have been verified at the time of this
+function call.
 
 If you cannot match a key suitable for the token, throw an error instead.
 

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -145,15 +145,18 @@ export interface JWK {
  */
 export interface GetKeyFunction<IProtectedHeader, IToken> {
  /**
- * Dynamic key resolution function. No token components have been
- * verified at the time of this function call.
+ * Dynamic key resolution function. No token components have been verified at the time of this
+ * function call.
  *
  * If you cannot match a key suitable for the token, throw an error instead.
  *
  * @param protectedHeader JWE or JWS Protected Header.
  * @param token The consumed JWE or JWS token.
  */
- (protectedHeader: IProtectedHeader, token: IToken): Promise<KeyLike | Uint8Array> | KeyLike | Uint8Array
+ (
+ protectedHeader: IProtectedHeader,
+ token: IToken,
+ ): Promise<KeyLike | Uint8Array> | KeyLike | Uint8Array
 }
 
 /**