DeltaBase

@delta-base/server

---

Class: DeltaBase

DeltaBase client for interacting with the Delta-Base platform.

This is the main entry point for the SDK that provides access to:

• Management operations (create/delete event stores)
• Event store operations (append/read events)
• Event bus functionality (subscriptions and real-time updates)

Example

// Initialize the client
const client = new DeltaBase({
  apiKey: "your-api-key"
});

// Access various functionality
const management = client.getManagement();
const eventStore = client.getEventStore("my-store");
const eventBus = client.getEventBus("my-store");

Constructors

Constructor

new DeltaBase(config): DeltaBase

Creates a new DeltaBase client instance.

Parameters

config

DeltaBaseConfig

Configuration options for connecting to the Delta-Base platform

Returns

DeltaBase

Throws

If neither apiKey nor headers are provided in the configuration

Example

// Create with API key (standard authentication)
const client = new DeltaBase({ apiKey: "your-api-key" });

// Create with custom URL (production)
const prodClient = new DeltaBase({
  baseUrl: "https://api.delta-base.com",
  apiKey: "your-api-key"
});

// Create with custom headers (internal service authentication)
const internalClient = new DeltaBase({
  baseUrl: "https://api.delta-base.com",
  headers: {
    'X-Deltabase-Internal-Service': 'auth-service',
    'X-Deltabase-Internal-Token': 'internal-token'
  }
});

Methods

getEventBus()

getEventBus(eventStoreName): EventBus

Get an EventBus client for a specific event store

Parameters

eventStoreName

string

The name of the event store to manage subscriptions for

Returns

EventBus

An EventBus client instance configured for the specified event store

Example

const eventBus = client.getEventBus("my-event-store");
const subscription = await eventBus.createSubscription({
  name: "user-events",
  eventFilter: "user.*"
});

---

getEventStore()

getEventStore(eventStoreName): EventStore

Get an EventStore client for a specific event store

Parameters

eventStoreName

string

The name of the event store to connect to

Returns

EventStore

An EventStore client instance configured for the specified event store

Example

const eventStore = client.getEventStore("my-event-store");
await eventStore.appendToStream("user-123", [
  { type: "UserCreated", data: { userId: "123", name: "John" } }
]);

---

getManagement()

getManagement(): ManagementClient

Get a ManagementClient for managing event stores

Returns

ManagementClient

A ManagementClient instance for creating and managing event stores

Example

const management = client.getManagement();
const eventStore = await management.createEventStore({
  name: "my-event-store"
});