docs: mention signed JWT alg as required

panva · Nov 11, 2021 · 2e2b79d · 2e2b79d
1 parent 7645ff0
commit 2e2b79d
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/classes/jwt_sign.SignJWT.md b/docs/classes/jwt_sign.SignJWT.md
@@ -165,7 +165,7 @@ Sets the JWS Protected Header on the SignJWT object.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `protectedHeader` | [`JWSHeaderParameters`](../interfaces/types.JWSHeaderParameters.md) | JWS Protected Header. |
+| `protectedHeader` | [`JWSHeaderParameters`](../interfaces/types.JWSHeaderParameters.md) | JWS Protected Header. Must contain an "alg" (JWS Algorithm) property. |
 
 #### Returns
 

diff --git a/src/jwt/sign.ts b/src/jwt/sign.ts
@@ -27,6 +27,7 @@ export class SignJWT extends ProduceJWT {
  * Sets the JWS Protected Header on the SignJWT object.
  *
  * @param protectedHeader JWS Protected Header.
+ * Must contain an "alg" (JWS Algorithm) property.
  */
  setProtectedHeader(protectedHeader: JWSHeaderParameters) {
  this._protectedHeader = protectedHeader