subscriber-default-export-required - ESLint plugin rules

This rule requires subscriber files to default-export the subscriber function.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

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

The following code is reported by the rule:

src/subscribers/order-placed.ts
export const orderPlacedHandler = async () => {}

Instead, default-export the subscriber handler function:

src/subscribers/order-placed.ts
1export default async function orderPlacedHandler() {}2
3export const config = {4  event: "order.placed",5}

Why it's Important#

Medusa registers and runs the subscriber's default export when its event is emitted. Without a default export, the subscriber never runs.

Learn more in the Subscribers documentation.

Fixable#

This rule isn't auto-fixable.