WorkflowWorldError is the base error class for failures originating from a workflow world (storage backend). World implementations (local, Postgres, Vercel) throw subclasses of this error when storage operations fail.

You can use instanceof WorkflowWorldError to catch any world-related error regardless of the specific type. Note that the static .is() method only matches errors constructed directly as WorkflowWorldError — use the subclass-specific .is() methods (e.g. EntityConflictError.is()) to match specific error types.

import { WorkflowWorldError } from "workflow/errors"
declare const world: { events: { create(...args: any[]): Promise<any> } }; // @setup
declare const runId: string; // @setup
declare const event: any; // @setup

try {
  await world.events.create(runId, event);
} catch (error) {
  if (error instanceof WorkflowWorldError) { 
    console.error("Storage backend error:", error.message);
  }
}

Properties

Static Methods

WorkflowWorldError.is(value)

Type-safe check that matches only errors constructed directly as WorkflowWorldError. Does not match subclasses like EntityConflictError — use instanceof to catch all world errors, or the subclass-specific .is() methods.

import { WorkflowWorldError } from "workflow/errors"
declare const error: unknown; // @setup

if (WorkflowWorldError.is(error)) {
  // error is typed as WorkflowWorldError (not subclasses)
}

Subclasses

The following error types extend WorkflowWorldError:

• EntityConflictError — operation conflicts with entity state
• RunExpiredError — run has expired
• TooEarlyError — request made before system is ready
• ThrottleError — request was rate-limited