Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

validateJWT example in docs does not match definition #67

Open
ryan0x44 opened this issue Apr 26, 2024 · 0 comments
Open

validateJWT example in docs does not match definition #67

ryan0x44 opened this issue Apr 26, 2024 · 0 comments

Comments

@ryan0x44
Copy link

ryan0x44 commented Apr 26, 2024

The example shown on https://oslo.js.org/reference/jwt/validateJWT is:

import { validateJWT } from "oslo/jwt";

try {
	const jwt = validateJWT(
		"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZXNzYWdlIjoiaGVsbG8ifQ.yP03DaEblJkk9mR-Y5L7YCMzJgHL-RDPx90aXz-cuAI"
	);
	const message = jwt.payload.message;
} catch {
	// invalid signature
	// expired token
	// inactive token (`nbf`)
}

where a single string argument is passed to the validateJWT function.

However, the Definition in the docs is:

function validateJWT(
	algorithm: JWTAlgorithm,
	key: ArrayBuffer | TypedArray,
	jwt: string
): Promise<JWT>;

which matches the code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant