JavaScript Workflow SDK

Build stateful, long-running, reliable workflows using the Dapr Workflow JavaScript SDK with Catalyst. The Dapr Workflow JavaScript SDK provides a powerful way to orchestrate complex business processes using Node.js and TypeScript.

Prefer to start from a diagram? Use Workflow Composer to generate a runnable JavaScript Dapr Workflow project from a BPMN flowchart, then iterate with this SDK. For local monitoring of running workflows, use the Dapr Dev Dashboard.

Resources

• Dapr JavaScript SDK GitHub
• Dapr JavaScript SDK npm
• Dapr Workflow Documentation
• Catalyst Workflow Quickstart

Prerequisites:

• Node.js LTS or Current (Download)
• Dapr JavaScript SDK

Installation

Install the Dapr JavaScript SDK via npm:

npm install --save @dapr/dapr

Core Application

Use the essential components of a Dapr Workflow application (Workflows and Activities) to build and run a workflow application.

Develop a Workflow Definition

Learn how to define workflows using generator functions and TypeScript types

Develop an Activity Definition

Create activities that perform the actual work orchestrated by workflows

Dapr Client

Connect to the Dapr Workflow API and start, get status, and manage workflow executions.

Workflow Client and Runtime

Learn how to create and configure the DaprWorkflowClient and WorkflowRuntime, including registration of workflows and activities

Start a Workflow

Schedule new workflow instances via the JavaScript SDK

Get Workflow Results

Retrieve workflow instance data such as the current status, input, custom status, and output

Failure Detection

Explore how your application can detect failures using timeouts.

Workflow Timeouts

Each workflow timeout controls the maximum duration of a different aspect of a workflow execution

Activity Timeouts

Each activity timeout controls the maximum duration of a different aspect of an activity execution

External Events

Wait for external input and send events to running workflows.

Wait for External Event

Wait for external input, such as human approvals or system responses

Raise Workflow Event

Send an event to a running workflow instance from a client or another workflow

Control Workflow Progression

Interrupt a workflow execution with pause, resume, or terminate actions.

Pause a Workflow

Pause a running workflow instance

Resume a Workflow

Resume a paused workflow instance

Terminate a Workflow

Terminate a workflow execution and its activities

Advanced Features

Durable Timers

Use timers to make a workflow execution pause or sleep for a fixed time period

Continue-As-New

Continue the workflow execution with a new workflow execution using the same workflow ID

Observability

Configure and use observability features to monitor and debug workflows.

Workflow Visibility

Use the Catalyst workflow dashboard to view workflow executions, states, and success rates

Getting Started

Workflow Quickstart

Get started with workflows in Catalyst

Workflow Patterns

Learn about common workflow patterns

Dapr Workflow Documentation

Comprehensive Dapr workflow guide