Documentation / zerotal / auth / RememberMeMiddleware

Class: RememberMeMiddleware

Defined in: packages/auth/src/RememberMeMiddleware.ts:47

Persistent "remember me" login.

Registered globally by AuthProvider, after PersistUserMiddleware:

Read (before the request): when no user was restored from the session, it reads the remember_web cookie (id|token), loads the user by id, and constant-time-compares sha256(token) to the stored hash. On a match it re-authenticates the user, re-seeds the session, and flags Auth.viaRemember().
Write (after the request): it flushes any cookie action queued by Auth.login({ remember: true }) / Auth.logout() onto the response.

The user loader is the same auth.userLoader binding PersistUserMiddleware uses; if none is registered, the read step is a silent no-op.

Extends

BaseMiddleware<RememberMeOptions>

Constructors

Constructor

new RememberMeMiddleware(): RememberMeMiddleware

Defined in: packages/core/src/middleware/BaseMiddleware.ts:36

Returns

RememberMeMiddleware

Inherited from

BaseMiddleware.constructor

Properties

options

protected options: RememberMeOptions = {}

Defined in: packages/auth/src/RememberMeMiddleware.ts:48

Subclasses must declare this with their default option values. TypeScript enforces this at compile time — forgetting it is a type error.

Overrides

BaseMiddleware.options

Methods

handle()

handle(http, next): Promise<void | Response>

Defined in: packages/auth/src/RememberMeMiddleware.ts:50

Parameters

http

HttpContext

NextFn

Returns

Promise<void | Response>

Overrides

BaseMiddleware.handle

loadUser()

protected loadUser(userId, ctx): Promise<AuthUser | null>

Defined in: packages/auth/src/RememberMeMiddleware.ts:64

Load a user for a remember-cookie id via the auth.userLoader binding. Returns null (no throw) when no loader is registered — remember-me is best-effort and must never break a request.