@ducktors/storagebus-abstract

Abstract base class for Storagebus storage adapters. This package provides the foundation for creating storage adapters that work with the Storagebus ecosystem.

Installation

npm install @ducktors/storagebus-abstract
# or
pnpm add @ducktors/storagebus-abstract
# or
yarn add @ducktors/storagebus-abstract

Usage

This package is intended to be used as a base class for implementing custom storage adapters. If you're looking to use a storage solution directly, check out the available adapters:

• @ducktors/storagebus-local - Local filesystem storage
• @ducktors/storagebus-s3 - AWS S3 storage
• @ducktors/storagebus-gcs - Google Cloud Storage
• @ducktors/storagebus-memory - In-memory storage

Creating a Custom Adapter

import { Readable } from 'node:stream'
import { Storage, AbstractStorageOptions } from '@ducktors/storagebus-abstract'

interface MyStorageOptions extends AbstractStorageOptions {
  // Add your custom options here
}

class MyStorage extends Storage {
  constructor(opts: MyStorageOptions) {
    super(opts)
  }

  async write(fileName: string, fileReadable: Readable): Promise<string> {
    // Implement write logic
  }

  async exists(fileName: string): Promise<boolean> {
    // Implement exists logic
  }

  async read(fileName: string): Promise<Readable> {
    // Implement read logic
  }

  async remove(fileName: string): Promise<void> {
    // Implement remove logic
  }

  async copy(key: string, destKey: string): Promise<string> {
    // Implement copy logic
  }

  async move(key: string, destKey: string): Promise<string> {
    // Implement move logic
  }
}

API

Constructor Options

Abstract Methods

All storage adapters must implement these methods:

Helper Methods

License

MIT