TypeScript SDK reference
View as MarkdownThis reference covers the Dex TypeScript SDK. Check the SDK version your application uses before you rely on a detail:
npm ls @superdurable/dex
Install
The TypeScript SDK is the npm package @superdurable/dex. Pin an exact release:
npm install @superdurable/dex@1.37.0
The package supports Node.js 22 and 24. Releases use the tag sdk-typescript/vX.Y.Z.
Supported versions
| SDK minor | Server requirement |
|---|---|
| 1.37, 1.35 | server-zd 0.1.17 or newer (protocol version 4) |
| 1.32, 1.30, 1.29 | See the compatibility matrix |
Minor numbers follow the shared Dex release train. A missing minor means the TypeScript SDK did not change in that release.
API reference
Read the TypeScript SDK API reference for the latest release, 1.37.0.
Versioned snapshots: 1.37.0, 1.35.0, 1.32.0, 1.30.0, 1.29.0.
RPC codecs
TypeScript uses JSON when inputCodec or outputCodec is omitted. Provide a codec when the input or output is not JSON, including scalar values such as strings, numbers, booleans, and bigints.
Pages
- Flows and Steps: Flow and Step behavior with TypeScript code: start options, waits, Step decisions, Step options, and failure handling.
- Workers: TypeScript names for Worker readiness, capacity, and shutdown settings.
Release notes
See the sdk-typescript releases on GitHub.