NonRetryableError

Author: elithrar

src/content/docs/workflows/build/sleeping-and-retrying.mdx

@@ -84,3 +84,27 @@ let someState = step.do("call an API", {
   timeout: "30 minutes",
 }, async () => { /* Step code goes here /* }
 ```
+
+### Force a step to fail
+
+You can also force a Workflow instance to fail and _not_ retry by throwing a `NonRetryableError` from within the step.
+
+This can be useful when you detect a terminal (permanent) error from an upstream system (such as an authentication failure) or other errors where retrying would not help.
+
+```ts
+// Import the NonRetryableError definition
+import { WorkflowEntrypoint, WorkflowStep, WorkflowEvent, NonRetryableError } from 'cloudflare:workers';
+
+// In your step code:
+export class MyWorkflow extends WorkflowEntrypoint<Env, Params> {
+	async run(event: WorkflowEvent<Params>, step: WorkflowStep) {
+	  await step.do("some step", async () => {
+			  if !(event.data) {
+					throw NonRetryableError("event.data did not contain the expected payload")
+				}
+			})
+	}
+}
+```
+
+The Workflow instance itself will fail immediately, no further steps will be invoked, and the Workflow will not be retried.