Back to Medusa

{metadata.title}

www/apps/resources/app/lint/rules/no-conditional-expressions-in-workflow/page.mdx

2.17.01.7 KB
Original Source

export const metadata = { title: no-conditional-expressions-in-workflow - ESLint plugin rules, }

{metadata.title}

This rule disallows conditional operators, such as &&, ||, ??, ternaries, !, optional chaining, and equality checks, directly inside a createWorkflow constructor or a when().then() callback.

Severity

error. This rule is enabled in the recommended preset.

What it Targets

This rule targets files in your project's src/workflows directory. It reports conditional operators placed directly in a workflow's constructor or in a when().then() callback.

The following code is reported by the rule:

ts
import {
  createWorkflow,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

createWorkflow("my-workflow", (input) => {
  const v = input || "default"
  return new WorkflowResponse(v)
})

Instead, wrap value manipulation in transform:

ts
import {
  createWorkflow,
  transform,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

createWorkflow("my-workflow", (input) => {
  const v = transform({ input }, (data) => {
    return data.input || "default"
  })

  return new WorkflowResponse(v)
})

Why it's Important

A workflow's constructor and when().then() callbacks run at definition time, not execution time. So, the operands are placeholders rather than real values, and conditional operators don't behave as you might expect. Use transform to manipulate values at execution time.

Learn more in the Workflows documentation.

Fixable

This rule isn't auto-fixable.