@vendure/core
Version:
A modern, headless ecommerce framework
38 lines (37 loc) • 977 B
TypeScript
import { ScheduledTask } from '../scheduled-task';
/**
* @description
* A {@link ScheduledTask} that cleans expired & inactive sessions from the database.
*
* @example
* ```ts
* import { cleanSessionsTask, VendureConfig } from '\@vendure/core';
*
* export const config: VendureConfig = {
* // ...
* schedulerOptions: {
* tasks: [
* // Use the task as is
* cleanSessionsTask,
* // or configure the task
* cleanSessionsTask.configure({
* // Run the task every day at 3:00am
* // The default schedule is every day at 00:00am
* schedule: cron => cron.everyDayAt(3, 0),
* params: {
* // How many sessions to process in each batch
* // Default: 1000
* batchSize: 5_000,
* },
* }),
* ],
* },
* };
* ```
*
* @since 3.3.0
* @docsCategory scheduled-tasks
*/
export declare const cleanSessionsTask: ScheduledTask<{
batchSize: number;
}>;