Documentation

Documentation / zerotal / auth / JwtGuardOptions

Interface: JwtGuardOptions

Defined in: packages/auth/src/JwtGuardMiddleware.ts:5

Properties

secret?

optional secret?: string

Defined in: packages/auth/src/JwtGuardMiddleware.ts:7

HMAC secret. Defaults to JWT_SECRET, then APP_KEY, from the environment.

resolve?

optional resolve?: (claims) => unknown

Defined in: packages/auth/src/JwtGuardMiddleware.ts:9

Resolve a user from the verified token claims. Required to populate ctx.user.

Parameters

claims

JwtPayload

Returns

unknown

header?

optional header?: string

Defined in: packages/auth/src/JwtGuardMiddleware.ts:11

Header carrying the token. Default authorization (with a Bearer prefix).