Apache OpenDAL™ Node.js Binding

A native Node.js binding for Apache OpenDAL: access S3, GCS, Azure Blob, HDFS, the local filesystem, and 50+ more services through one API.

We release the OpenDAL Node.js binding independently of the opendal crate (Rust core). For updates and compatibility, use the Node.js binding version instead of the opendal crate version.

Useful Links

• User guide
• API documentation
• Services & configuration
• Upgrade Guide

Installation

npm install opendal

Quickstart

import { Operator } from "opendal";

async function main() {
  const op = new Operator("fs", { root: "/tmp" });
  await op.write("test", "Hello, World!");
  const bs = await op.read("test");
  console.log(new TextDecoder().decode(bs));
  const meta = await op.stat("test");
  console.log(`contentLength: ${meta.contentLength}`);
}

main();

The API is promise-based; every operation has a synchronous *Sync variant too. For configuring backends, streaming, layers (retry, timeout, logging, throttle, concurrency limits), presigned URLs, and Next.js usage, see the full user guide.

Contributing

• Start with the Contributing Guide.
• Submit Issues for bug reports or feature requests.
• Ask questions in the Discussions.
• Talk to the community on Discord.

License and Trademarks

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

Apache OpenDAL, OpenDAL, and Apache are either registered trademarks or trademarks of the Apache Software Foundation.

Third-party software

Compiled distributions include the following Mozilla Public License 2.0 components. Their source code is available from the linked project pages:

• colored 3.1.1 (source, homepage), licensed under MPL-2.0.
• option-ext 0.2.0 (source, homepage), licensed under MPL-2.0.
• persy 1.8.1 (source, homepage), licensed under MPL-2.0.

The distribution includes the MPL-2.0 text in LICENSE-MPL-2.0.txt.