SudoSOS Back-end API / internal/middleware / MiddlewareOptions

Interface: MiddlewareOptions

The configuration options for the token middleware.

Properties

isUserDeleted?

optional isUserDeleted?: (userId) => Promise<boolean>;

Checks whether the user with the given id has been soft-deleted. Tokens of deleted users are rejected, so deleting a user also revokes their existing tokens. Defaults to a database lookup.

Parameters

Parameter	Type
userId	number

Returns

Promise<boolean>

---

refreshFactor

refreshFactor: number;

The factor of the configured expiry of the token handler at which the token will be refreshed. Set to 0.0 for refreshing on every request. Setting to 1.0 or higher will prevent refeshing, as tokens will expire before a possible refresh.

---

tokenHandler

tokenHandler: TokenHandler;

The token handler instance internally used by the middleware.