@temporalio/client

Starting a Workflow

This feature allows you to start a new workflow. The code sample demonstrates how to create a connection to the Temporal server, instantiate a WorkflowClient, and start a workflow with a specified task queue.

const { Connection, WorkflowClient } = require('@temporalio/client');

async function run() {
  const connection = new Connection();
  const client = new WorkflowClient(connection.service);
  const handle = await client.start('exampleWorkflow', { taskQueue: 'example' });
  console.log(`Started workflow with ID: ${handle.workflowId}`);
}

run().catch(err => console.error(err));

Querying a Workflow

This feature allows you to query the state of a running workflow. The code sample shows how to get a handle to a workflow using its ID and perform a query on it.

const { Connection, WorkflowClient } = require('@temporalio/client');

async function run() {
  const connection = new Connection();
  const client = new WorkflowClient(connection.service);
  const handle = client.getHandle('exampleWorkflowId');
  const result = await handle.query('exampleQuery');
  console.log(`Query result: ${result}`);
}

run().catch(err => console.error(err));

Cancelling a Workflow

This feature allows you to cancel a running workflow. The code sample demonstrates how to get a handle to a workflow using its ID and cancel it.

const { Connection, WorkflowClient } = require('@temporalio/client');

async function run() {
  const connection = new Connection();
  const client = new WorkflowClient(connection.service);
  const handle = client.getHandle('exampleWorkflowId');
  await handle.cancel();
  console.log('Workflow cancelled');
}

run().catch(err => console.error(err));