@zero-transfer/s3

S3-compatible storage with SigV4, multipart upload, and resume.

Install

npm install @zero-transfer/s3

Overview

S3-compatible object storage provider with SigV4 signing, multipart upload, and cross-process multipart resume. Supports AWS S3, MinIO, R2, Wasabi, Backblaze B2 S3, DigitalOcean Spaces, and any custom endpoint that speaks the S3 API. Includes the in-memory resume store; persistent stores can be swapped in.

Usage

import {
  createTransferClient,
  uploadFile,
  downloadFile,
  createS3ProviderFactory,
} from "@zero-transfer/s3";

Public surface

This package publishes a narrowed surface of 8 exports. These symbols are also available from @zero-transfer/sdk; the table below links into the full API reference:

| Symbol | Kind | Notes | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------ | | createS3ProviderFactory | Function | See API reference. | | createMemoryS3MultipartResumeStore | Function | See API reference. | | S3ProviderOptions | Interface | See API reference. | | S3MultipartOptions | Interface | See API reference. | | S3MultipartResumeStore | Interface | See API reference. | | S3MultipartResumeKey | Interface | See API reference. | | S3MultipartCheckpoint | Interface | See API reference. | | S3MultipartPart | Interface | See API reference. |

Examples

| Example | What it shows | | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | | examples/s3-compatible-upload.ts | S3-compatible multipart upload example. | | examples/multi-cloud-orchestration.ts | Multi-cloud orchestration showcase. |

Documentation

• Scope page
• Top-level README
• Full API reference
• Capability matrix
• Examples

License

MIT © Tony Wiedman