How to: Manage configuration with the Dapr JavaScript SDK

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

Use DaprClient.configuration to read application settings and react to changes without calling the configuration store directly. This guide uses Redis for local development.

Prerequisites

Dapr CLI and an initialized Dapr environment
Node.js 18 or later
The @dapr/dapr package, version 3.19.0 or later
Docker, for the Redis example below

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

npm init -y
npm install @dapr/dapr@3.19.0

The examples use JavaScript ES modules saved as .mjs files and do not require a TypeScript compiler. The same APIs are available in TypeScript.

Configuration client usage

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

Configuration is available through DaprClient.configuration. This guide targets @dapr/dapr 3.19.0 or later and describes the implementation details and limitations to account for when using this release.

Client lifetime and configuration

Reuse a long-lived DaprClient for configuration operations rather than creating one for each read or subscription. Configuration requires gRPC; the SDK’s default protocol is HTTP and is not supported for these methods.

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

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

Port values are strings. When you omit explicit host and port options, the SDK can resolve the sidecar address from DAPR_GRPC_ENDPOINT. Otherwise, it falls back to the configured host and port, with defaults of 127.0.0.1 and DAPR_GRPC_PORT (or 50001). Explicit host and port options take precedence over endpoint settings.

Dapr Configuration JavaScript SDK on Dapr Docs

How to: Manage configuration with the Dapr JavaScript SDK

Prerequisites

Configuration client usage

Client lifetime and configuration