Scaleway Object Storage

Scaleway Object Storage via the S3-compatible API. Endpoint derived from the region code (fr-par, nl-ams, pl-waw).

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 { scaleway } from "files-sdk/scaleway";

const files = new Files({
  adapter: scaleway({
    bucket: "uploads",
    region: "fr-par", // or "nl-ams", "pl-waw"
    // accessKeyId / secretAccessKey auto-loaded from
    // SCW_ACCESS_KEY / SCW_SECRET_KEY
  }),
});

Scaleway Object Storage via its S3-compatible API. A thin wrapper around the S3 adapter - endpoint derived from the region code (fr-par, nl-ams, pl-waw), virtual-hosted-style addressing, errors relabelled. Auto-loads from SCW_ACCESS_KEY and SCW_SECRET_KEY. Generate access keys in the Scaleway console under Identity and Access Management -> API Keys.

Options

PropType

bucketstring

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

Typestring

regionstring

Scaleway Object Storage region, e.g. `"fr-par"` (Paris), `"nl-ams"` (Amsterdam), `"pl-waw"` (Warsaw). Drives the endpoint host (`https://s3.<region>.scw.cloud`); there's no env-var fallback. Doubles as the SigV4 region. Buckets live in exactly one region.

Typestring

endpoint?string

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

Typestring

accessKeyId?string

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

Typestring

secretAccessKey?string

Static secret access key. Falls back to `SCW_SECRET_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 Scaleway.

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, the natural value is `https://${bucket}.s3.${region}.scw.cloud`; a custom domain fronting the bucket also works. 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`	✅