Node.js bindings for s3z — a lightweight, high-throughput S3 library built in Rust.

Install

npm install @jae_aeich/s3z   # npm
pnpm add @jae_aeich/s3z      # pnpm
yarn add @jae_aeich/s3z      # yarn
bun add @jae_aeich/s3z       # bun

Quick start

import { S3Client } from "@jae_aeich/s3z";

const client = await S3Client.create({ region: "us-east-1" });

// Upload
const uploaded = await client.upload({
  sources: ["./data"],
  bucket: "my-bucket",
  prefix: "uploads/",
});

// Download
const downloaded = await client.download({
  bucket: "my-bucket",
  prefix: "uploads/",
  destDir: "./out",
});

// List
const objects = await client.list({
  bucket: "my-bucket",
  prefix: "uploads/",
});

S3-compatible backends

const client = await S3Client.create({
  region: "us-east-1",
  accessKey: "access-key",
  secretKey: "secret-key",
  endpoint: "http://localhost:9000", // MinIO, SeaweedFS, Garage, etc.
});

License

MIT