pilcrowonpaper / oslo

A collection of auth-related utilities
https://oslo.js.org
MIT License
1.06k stars 35 forks source link

validateJWT example in docs does not match definition #67

Open ryan0x44 opened 5 months ago

ryan0x44 commented 5 months ago

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.