AuthHelpers
AuthHelpers<
TUser> =object
Defined in: packages/auth/src/helpers.ts:45
The auth helper functions returned by createAuthHelpers.
Type Parameters
Section titled “Type Parameters”TUser extends AuthUser = AuthUser
The (potentially enriched) user type.
Properties
Section titled “Properties”getAuthContext()
Section titled “getAuthContext()”getAuthContext: (
request) =>Promise<{grants:AuthContext["grants"];user:TUser|null; }>
Defined in: packages/auth/src/helpers.ts:47
Returns the auth context for the request. User is null if unauthenticated.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<{ grants: AuthContext["grants"]; user: TUser | null; }>
getUser()
Section titled “getUser()”getUser: (
request) =>Promise<TUser|null>
Defined in: packages/auth/src/helpers.ts:51
Returns the user, or null if unauthenticated.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<TUser | null>
requireAuthContext()
Section titled “requireAuthContext()”requireAuthContext: (
request) =>Promise<{grants:AuthenticatedContext["grants"];user:TUser; }>
Defined in: packages/auth/src/helpers.ts:49
Returns the auth context, throwing a 302 redirect if the user is not authenticated.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<{ grants: AuthenticatedContext["grants"]; user: TUser; }>
requireUser()
Section titled “requireUser()”requireUser: (
request) =>Promise<TUser>
Defined in: packages/auth/src/helpers.ts:53
Returns the user, throwing a 302 redirect if not authenticated.
Parameters
Section titled “Parameters”request
Section titled “request”Request
Returns
Section titled “Returns”Promise<TUser>