scheduled-job-default-export-required - ESLint plugin rules

This rule requires scheduled job files to default-export the job function.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files in your project's src/jobs directory. It reports a scheduled job file that has no default export.

The following code is reported by the rule:

src/jobs/sync-products.ts
export const syncProducts = async () => {}

Instead, default-export the async job function:

src/jobs/sync-products.ts
1export default async function syncProducts() {}2
3export const config = {4  name: "sync-products",5  schedule: "0 0 * * *",6}

Why it's Important#

Medusa registers and runs the job's default export on its schedule. Without a default export, the job never runs.

Learn more in the Scheduled Jobs documentation.

Fixable#

This rule isn't auto-fixable.