Skip to main content

CleanSessionsTask

cleanSessionsTask​

@vendure/coreclean-sessions-task.ts
v3.3.0

A scheduled task that cleans expired & inactive sessions from the database.

Example

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: 10_000
          batchSize: 5_000,
        },
      }),
    ],
  },
};