apache
Apache OpenDAL™ Node.js Binding
Useful Links
Installation
npm install opendalDocs
To build the docs locally, please run the following commands:
# Only need to run once unless you want to update the docs theme
pnpm run build:theme
# Build the docs
pnpm run docsTests
Services behavior tests read necessary configs from env vars or the .env file.
You can copy .env.example to $(pwd)/.env and change the values on need, or directly set env vars with export KEY=VALUE.
Take fs for example, we need to enable bench on fs on /tmp:
OPENDAL_TEST=fs
OPENDAL_FS_ROOT=/tmpYou can run service behavior tests of enabled with the following command:
pnpm build && pnpm testUsage
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();Contributing
- Start with Contributing Guide.
- Submit Issues for bug report or feature requests.
- Asking questions in the Discussions.
- Talk to community at 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.