medusa-starter/src/jobs/README.md

Custom scheduled jobs

A scheduled job is a function executed at a specified interval of time in the background of your Medusa application.

Learn more about scheduled jobs in this documentation.

A scheduled job is created in a TypeScript or JavaScript file under the src/jobs directory.

For example, create the file src/jobs/hello-world.ts with the following content:

import {
  MedusaContainer
} from "@medusajs/framework/types";

export default async function myCustomJob(container: MedusaContainer) {
  const productService = container.resolve("product")

  const products = await productService.listAndCountProducts();

  // Do something with the products
}

export const config = {
  name: "daily-product-report",
  schedule: "0 0 * * *", // Every day at midnight
};

A scheduled job file must export:

• The function to be executed whenever it’s time to run the scheduled job.
• A configuration object defining the job. It has three properties:
  • name: a unique name for the job.
  • schedule: a cron expression.
  • numberOfExecutions: an optional integer, specifying how many times the job will execute before being removed

The handler is a function that accepts one parameter, container, which is a MedusaContainer instance used to resolve services.