@compas/store
Version:
Postgres & S3-compatible wrappers for common things
37 lines (36 loc) • 1.43 kB
TypeScript
/**
* Returns a {@link QueueWorkerHandler} that removes expired and revoked sessions via
* {@link sessionStoreCleanupExpiredSessions}. By default, removes expired and revoked
* sessions after 14 days.
*
* If 'maxSessionLifetimeInDays' is provided, even active sessions will be removed if
* they are created 'maxSessionLifetimeInDays'-days ago.
*
* Recommended interval: daily
* Recommended cronExpression: 0 2 * * *
*
* @param {{
* maxRevokedAgeInDays?: number,
* maxSessionLifetimeInDays?: number,
* }} [options]
* @returns {import("./queue-worker.js").QueueWorkerHandler}
*/
export function jobSessionStoreCleanup(options?: {
maxRevokedAgeInDays?: number;
maxSessionLifetimeInDays?: number;
}): import("./queue-worker.js").QueueWorkerHandler;
/**
* A {@link QueueWorkerHandler} to process reported leaked sessions. These jobs occur
* when the session store finds that refresh token is used multiple times. The job is
* able to either process the leaked session in to a report and log it via `type:
* "sessionStore.leakedSession.report"` or is able to dump the raw session information
* via `type: "sessionStore.leakedSession.dump"`
*
* @param {{
* useDump?: boolean,
* }} [options]
* @returns {import("./queue-worker.js").QueueWorkerHandler}
*/
export function jobSessionStoreProcessLeakedSession(options?: {
useDump?: boolean;
}): import("./queue-worker.js").QueueWorkerHandler;