Dapr Jobs JavaScript SDK on Dapr Docs

How to: Author and manage Dapr Jobs using the JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Let’s register an endpoint to receive a job notification, then schedule the job from the same application. This guide uses DaprServer.jobs for callbacks and its embedded DaprClient.jobs for job management. There is no separate Jobs client package to install.

Prerequisites

Dapr CLI
An initialized Dapr environment with Dapr runtime 1.16 or later and the Scheduler service running
Node.js 18 or later
The @dapr/dapr package, version 3.19.0 or later

In your application directory, initialize an npm project if needed and install the SDK:

Build cron schedules using the JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use a cron schedule for calendar-based jobs, such as a report at 09:30 every weekday. The JavaScript SDK accepts a raw schedule string or a CronExpressionBuilder directly in JobOptions.schedule. These examples target @dapr/dapr 3.19.0 or later.

Provide a schedule string

Dapr cron expressions use six fields, including seconds, not the five fields used by many Unix cron tools:

second minute hour dayOfMonth month dayOfWeek

For example, "0 30 9 * * 1-5" runs at 09:30 on weekdays. Sunday is 0 and Saturday is 6.

JavaScript Jobs client and callback usage

Mon, 01 Jan 0001 00:00:00 +0000

Jobs is part of DaprClient and DaprServer in @dapr/dapr 3.19.0 or later. Use client.jobs to manage scheduled jobs and server.jobs to register callbacks. The how-to guide contains a complete runnable application.

Client configuration and lifetime

Create a long-lived DaprClient rather than a new client for every operation. Jobs uses the client’s existing sidecar connection and API token:

import { CommunicationProtocolEnum, DaprClient } from "@dapr/dapr";

const client = new DaprClient({
 daprHost: "127.0.0.1",
 daprPort: "50001",
 communicationProtocol: CommunicationProtocolEnum.GRPC,
 daprApiToken: process.env.DAPR_API_TOKEN,
});

try {
 await client.start();
 await client.jobs.schedule("cleanup", { dueTime: "1h" });
 const job = await client.jobs.get("cleanup");
 console.log(job);
 await client.jobs.delete("cleanup");
} finally {
 await client.stop();
}

For HTTP, use CommunicationProtocolEnum.HTTP and the sidecar’s HTTP port, normally "3500". Client-only management does not require an app listener, but the target application must expose its callback server when the job fires.