API Documentation

Welcome to the temporal-contract API documentation. This documentation is auto-generated from the source code using TypeDoc.

Core Packages

• @temporal-contract/contract - Core contract definitions
• @temporal-contract/client - Type-safe Temporal client
• @temporal-contract/worker - Type-safe Temporal worker

The Result / ResultAsync types used throughout the API surface come from neverthrow. See Migrating to neverthrow if you are upgrading from the previous @swan-io/boxed-based version.

Testing

• @temporal-contract/testing - Testing utilities with testcontainers