Documentation / @zerotal/auth / RequestGuard
Class: RequestGuard
Defined in: auth/src/guards.ts:54
A stateless guard that resolves its user from the request on first access and caches the result on the context for the rest of the request.
Implements
Constructors
Constructor
new RequestGuard(
_name,_resolver):RequestGuard
Defined in: auth/src/guards.ts:55
Parameters
_name
string
_resolver
Returns
RequestGuard
Methods
userOrNull()
userOrNull():
Promise<unknown>
Defined in: auth/src/guards.ts:63
Resolve the user from the request (cached per request), or undefined.
Returns
Promise<unknown>
Implementation of
user()
user():
Promise<unknown>
Defined in: auth/src/guards.ts:78
The resolved user.
Returns
Promise<unknown>
Throws
when the resolver yields no user.
Implementation of
check()
check():
Promise<boolean>
Defined in: auth/src/guards.ts:84
true when a user is authenticated on this guard.
Returns
Promise<boolean>
Implementation of
guest()
guest():
Promise<boolean>
Defined in: auth/src/guards.ts:88
true when no user is authenticated on this guard.
Returns
Promise<boolean>
Implementation of
id()
id():
Promise<string|number|undefined>
Defined in: auth/src/guards.ts:92
The authenticated user's id, or undefined when there is none.
Returns
Promise<string | number | undefined>