@litert/jwt

Appearance

Documents for @litert/jwt / Types / IJwtValidator

Interface: IJwtValidator ​

Defined in: src/lib/Types.ts:412

The type of the validator objects that validate the JWTs, after parsing.

The validator is not only verifying the signature, but also could do other checks on the payload, such as expiration, audience, issuer, etc.

Properties ​

name ​

readonly name: string

Defined in: src/lib/Types.ts:420

The name of the validator.

When using with the JwtVerifier class, this name can be used to identify which validator failed.

Methods ​

validate() ​

validate(parseResult): void

Defined in: src/lib/Types.ts:429

Validate the provided parse result of a JWT, checking if the JWT is valid.

Parameters ​

parseResult ​

IJwtParseResult

The result returned by parse API.

Returns ​

void

Throws ​

If validation failed or an error occurred inside.