Interface IAuthenticator

The authenticator service contract.

interface IAuthenticator {
    decode: <T extends JwtClaims = JwtClaims>(token: string) => T;
    sign: (claims: JwtClaims, options?: SignOptions) => Promise<string>;
    verify: <T extends JwtClaims = JwtClaims>(
        token: string,
        options?: VerifyOptions,
    ) => Promise<T>;
}

Implemented by

Authenticator

Index

Properties

decode sign verify

Properties

decode

decode: <T extends JwtClaims = JwtClaims>(token: string) => T

Decode a token without verifying it (never trust the result for authorization).

sign

sign: (claims: JwtClaims, options?: SignOptions) => Promise<string>

Sign a token from claims.

verify

verify: <T extends JwtClaims = JwtClaims>(
token: string,
options?: VerifyOptions,
) => Promise<T>

Verify a token and return its claims (throws on invalid/expired).