Installation ​

Sobj features a decoupled architecture made of a tiny core package and provider-specific adapters. This structure keeps your bundle light by only importing code for the backends you actually use.

📦 Core Package ​

To begin, install the core sobj package in your project:

pnpm add sobj

Or using your preferred package manager:

# npm
npm install sobj

# Yarn
yarn add sobj

# Bun
bun add sobj

🔌 Storage Adapters ​

Next, install the adapter corresponding to the storage provider you wish to use. Each provider has its own dedicated package.

For example, to install both the in-memory adapter and Cloudflare R2:

pnpm add @sobj/memory @sobj/r2

🧪 Verify Installation ​

Once packages are installed, verify the setup by importing the client factory and your chosen adapter:

import { sobj } from 'sobj'
import { memory } from '@sobj/memory'

const storage = sobj(memory())

Your environment is now configured. Proceed to the Quick start to run your first storage operations.