@brighter/storage

@brighter/storage is a JavaScript object storage library that:

• enables local development,
• has a simple, concise API and,
• is tested against real infrastructure.

Why is local development important? Most of today's software talks directly to the cloud, even in local environments. This extends the feedback loop and creates a cloud provider dependency.

This library offers a different approach. It introduces a common interface that enables seamless switching between providers and a local implementation that can be used during local development.

A list of supported providers:

• local (for local development),
• s3 (AWS) and
• r2 (Cloudflare).

Quick Start

Installation, using npm:

npm i @brighter/storage

Usage:

const { Storage } = require('@brighter/storage')

const storage = Storage({
  storage: {
    type: 'local',
    path: '/tmp/storage'
  }
})

const main = async () => {
  await storage.write('msg', 'hi')
  const msg = await storage.read('msg')
  console.log(msg)
}

main().catch(console.error)

For more information, see the documentation.

API

The library aims to provide a simple, concise API that's easy to use and remember.

Constructors:

• Storage

Properties:

• config

Methods:

• copy
• exists
• list
• read
• remove
• stat
• uri
• write

It knows how to handle:

• different content encodings (via iconv-lite),
• recursive operations and
• throttling of concurrent operations.

For more information, see the documentation.