Merge pull request #4 from samialdury/fix-docs-headers

pilcrowonpaper · web-flow · commit 439b15430e0c · 2024-12-24T20:47:09.000+09:00
fix(docs): `.algorithm()` should be called on `headerParameters`
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ import { parseJWT, JWSRegisteredHeaders, JWTRegisteredClaims, joseAlgorithmHS256
 
 const [header, payload, signature] = parseJWT(jwt);
 const headerParameters = new JWSRegisteredHeaders(header);
-if (header.algorithm() !== joseAlgorithmHS256) {
+if (headerParameters.algorithm() !== joseAlgorithmHS256) {
 	throw new Error("Unsupported algorithm");
 }
 const claims = new JWTRegisteredClaims(payload);
diff --git a/docs/pages/index.md b/docs/pages/index.md
@@ -15,7 +15,7 @@ import { parseJWT, JWSRegisteredHeaders, JWTRegisteredClaims, joseAlgorithmHS256
 
 const [header, payload, signature] = parseJWT(jwt);
 const headerParameters = new JWSRegisteredHeaders(header);
-if (header.algorithm() !== joseAlgorithmHS256) {
+if (headerParameters.algorithm() !== joseAlgorithmHS256) {
 	throw new Error("Unsupported algorithm");
 }
 const claims = new JWTRegisteredClaims(payload);

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ import { parseJWT, JWSRegisteredHeaders, JWTRegisteredClaims, joseAlgorithmHS256`
`13`	`13`
`14`	`14`	`const [header, payload, signature] = parseJWT(jwt);`
`15`	`15`	`const headerParameters = new JWSRegisteredHeaders(header);`
`16`		`-if (header.algorithm() !== joseAlgorithmHS256) {`
	`16`	`+if (headerParameters.algorithm() !== joseAlgorithmHS256) {`
`17`	`17`	`throw new Error("Unsupported algorithm");`
`18`	`18`	`}`
`19`	`19`	`const claims = new JWTRegisteredClaims(payload);`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ import { parseJWT, JWSRegisteredHeaders, JWTRegisteredClaims, joseAlgorithmHS256`
`15`	`15`
`16`	`16`	`const [header, payload, signature] = parseJWT(jwt);`
`17`	`17`	`const headerParameters = new JWSRegisteredHeaders(header);`
`18`		`-if (header.algorithm() !== joseAlgorithmHS256) {`
	`18`	`+if (headerParameters.algorithm() !== joseAlgorithmHS256) {`
`19`	`19`	`throw new Error("Unsupported algorithm");`
`20`	`20`	`}`
`21`	`21`	`const claims = new JWTRegisteredClaims(payload);`