How to: Manage binary files with the Dapr JavaScript SDK

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

Use DaprClient.binaryStore to store and retrieve files through a Dapr binary store component. The client supports binary streams so you can transfer large files without loading the entire file into your application’s memory. This guide covers component configuration, uploads, downloads, overwrites, and deletes.

Prerequisites

Dapr CLI
An initialized Dapr environment with Dapr runtime 1.19 or later
Node.js 18 or later
The @dapr/dapr package, version 3.19.0 or later
A configured binary store component, such as the in-memory component below

In your application directory, initialize an npm project if you do not already have one, then install the SDK:

Binary Store client usage

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

Binary Store is available through DaprClient.binaryStore in JavaScript SDK 3.19.0 or later and requires Dapr runtime 1.19 or later. Both HTTP and gRPC use the alpha Binary Store API.

Client lifetime and configuration

Reuse a long-lived DaprClient rather than creating a client for each operation. Await outstanding operations before calling await client.stop() during application shutdown.

The default protocol is HTTP. To explicitly configure a gRPC connection:

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,
});

Use CommunicationProtocolEnum.HTTP and the sidecar’s HTTP port (by default "3500") for HTTP. Supply port values as strings.

Dapr Binary Store JavaScript SDK on Dapr Docs

How to: Manage binary files with the Dapr JavaScript SDK

Prerequisites

Binary Store client usage

Client lifetime and configuration