Wasabi

Wasabi Hot Cloud Storage via its S3-compatible API - a thin wrapper around the S3 adapter with AWS-style region names mapped to Wasabi's own endpoints.

Installation

@aws-sdk/client-s3, @aws-sdk/s3-presigned-post, and @aws-sdk/s3-request-presigner are optional peer dependencies of files-sdk - install alongside the SDK so the adapter’s imports resolve at runtime.

npm install files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

pnpm add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

yarn add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

bun add files-sdk @aws-sdk/client-s3 @aws-sdk/s3-presigned-post @aws-sdk/s3-request-presigner

Usage

import { Files } from "files-sdk";
import { wasabi } from "files-sdk/wasabi";

const files = new Files({
  adapter: wasabi({
    bucket: "uploads",
    region: "us-east-1", // or "eu-central-1", "ap-northeast-1", ...
    // accessKeyId / secretAccessKey auto-loaded from
    // WASABI_ACCESS_KEY_ID / WASABI_SECRET_ACCESS_KEY
  }),
});

Wasabi Hot Cloud Storage via its S3-compatible API. A thin wrapper around the S3 adapter - endpoint derived from the region code (us-east-1, eu-central-1, ap-northeast-1, …), virtual-hosted-style addressing, errors relabelled. Region names mirror AWS but the endpoints are Wasabi’s own. Auto-loads from WASABI_ACCESS_KEY_ID and WASABI_SECRET_ACCESS_KEY. Generate access keys in the Wasabi console under Access Keys.

Options

PropType

bucketstring

Wasabi bucket name. The adapter scopes all operations to it.

Typestring

regionstring

Wasabi storage region, e.g. `"us-east-1"`, `"us-east-2"`, `"us-central-1"`, `"us-west-1"`, `"ca-central-1"`, `"eu-central-1"`, `"eu-central-2"`, `"eu-west-1"`, `"eu-west-2"`, `"ap-northeast-1"`, `"ap-northeast-2"`, `"ap-southeast-1"`, `"ap-southeast-2"`. Drives the endpoint host (`https://s3.<region>.wasabisys.com`); there's no env-var fallback. Doubles as the SigV4 region. The region names mirror AWS but the endpoints are Wasabi's own — buckets live in exactly one region.

Typestring

endpoint?string

Override the Wasabi endpoint. When unset, defaults to `https://s3.${region}.wasabisys.com`. Wasabi routes by Host header — the SDK prepends the bucket subdomain for virtual-hosted style.

Typestring

accessKeyId?string

Static access key ID. Falls back to `WASABI_ACCESS_KEY_ID`; required if that env var isn't set.

Typestring

secretAccessKey?string

Static secret access key. Falls back to `WASABI_SECRET_ACCESS_KEY`; required if that env var isn't set.

Typestring

forcePathStyle?boolean

Use path-style addressing (`/<bucket>/<key>`) rather than virtual-hosted style. Defaults to `false` — virtual-hosted is canonical for Wasabi.

Typeboolean

publicBaseUrl?string

Origin used to build URLs from `url()`. When set, `url(key)` returns `${publicBaseUrl}/${key}` and skips signing — for buckets with public read policy, the natural value is `https://${bucket}.s3.${region}.wasabisys.com`; a custom CNAME fronting the bucket also works. Wasabi has no built-in CDN, so leaving this unset is the common case. When unset, `url()` falls back to a presigned GetObject (default expiry: 1 hour).

Typestring

defaultUrlExpiresIn?number

Default expiry, in seconds, for the presigned URLs returned by `url()` when `publicBaseUrl` is not set. Defaults to 3600 (1 hour).

Typenumber

Compatibility

Method	Status	Notes
`upload`	✅
`download`	✅
`delete`	✅
`list`	✅
`search`	✅
`head`	✅
`exists`	✅
`copy`	✅
`url`	✅
`signedUploadUrl`	✅