API Reference

workflow/observability

Utilities to hydrate serialized step input/output (I/O) and parse machine-readable workflow names for display.

The workflow/observability package provides utilities for observability and debugging tools. Use it to hydrate serialized step input/output (I/O) for display and parse machine-readable names into display-friendly formats.

import {
  hydrateResourceIO,
  observabilityRevivers,
  hydrateData,
  parseStepName,
  parseWorkflowName,
  parseClassName,
} from "workflow/observability";

Data hydration

hydrateResourceIO()

Hydrate the serialized data fields of a run, step, hook, or event for display.

observabilityRevivers

Standard revivers for deserializing workflow data types (Date, Map, Set, streams, etc.).

hydrateData()

Hydrate a single serialized value (lower-level than hydrateResourceIO).

Name parsing

parseStepName()

Parse a machine-readable step name into display-friendly components.

parseWorkflowName()

Parse a machine-readable workflow name into display-friendly components.

parseClassName()

Parse a machine-readable class ID into display-friendly components.

Encrypted data

When a World stores encrypted data, the hydration utilities intentionally leave encrypted values untouched: hydrateData() and hydrateResourceIO() return encrypted fields as raw Uint8Array values so observability tools can detect them and decide how to render them (for example, the Workflow CLI shows an "Encrypted" placeholder). Decryption is handled by the runtime and the World implementation. See Encryption for how keys are managed.

PrevioushealthCheckNexthydrateResourceIO