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

This rule requires the default-exported scheduled job function to be async.

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 default-exported scheduled job that isn't an async function.

The following code is reported by the rule:

src/jobs/sync-products.ts
export default function syncProducts() {}

Instead, make the job function async:

src/jobs/sync-products.ts
export default async function syncProducts() {}

Why it's Important#

Scheduled jobs receive the Medusa container and are always awaited by Medusa. Making the job async ensures Medusa can wait for its work to finish before continuing.

Learn more in the Scheduled Jobs documentation.

Fixable#

This rule is auto-fixable. Run the linter with the --fix option to apply the fix automatically.