MakeDurableObjectClassOptions

MakeDurableObjectClassOptions = object

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:28

Properties

enabledTransports?

optional enabledTransports: Set<"http" | "ws" | "do-rpc">

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:87

Enabled transports for sync backend

• http: HTTP JSON-RPC
• ws: WebSocket
• do-rpc: Durable Object RPC calls (only works in combination with @livestore/adapter-cf)

Default

Set(['http', 'ws', 'do-rpc'])

---

forwardHeaders?

optional forwardHeaders: ForwardHeadersOption

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:64

Forward request headers to onPush/onPull callbacks for authentication.

This enables cookie-based or header-based authentication patterns where you need access to request headers inside the Durable Object.

Examples

makeDurableObject({
  forwardHeaders: ['cookie', 'authorization'],
  onPush: async (message, { headers }) => {
    const cookie = headers?.get('cookie')
    const session = await validateSession(cookie)
  },
})

makeDurableObject({
  forwardHeaders: (request) => ({
    'x-user-id': request.headers.get('x-user-id') ?? '',
    'x-session': request.headers.get('cookie')?.split('session=')[1]?.split(';')[0] ?? '',
  }),
  onPush: async (message, { headers }) => {
    const userId = headers?.get('x-user-id')
  },
})

---

http?

optional http: object

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:105

Custom HTTP response headers for HTTP transport These headers will be added to all HTTP RPC responses (Pull, Push, Ping)

responseHeaders?

optional responseHeaders: Record<string, string>

Example

{
  http: {
    responseHeaders: {
      'Access-Control-Allow-Origin': '*',
      'Cache-Control': 'no-cache'
    }
  }
}

---

onPull()?

optional onPull: (message, context) => Effect.SyncOrPromiseOrEffect<void>

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:31

Parameters

message

SyncMessage.PullRequest

context

CallbackContext

Returns

Effect.SyncOrPromiseOrEffect<void>

---

onPullRes()?

optional onPullRes: (message) => Effect.SyncOrPromiseOrEffect<void>

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:32

Parameters

message

SyncMessage.PullResponse | InvalidPullError

Returns

Effect.SyncOrPromiseOrEffect<void>

---

onPush()?

optional onPush: (message, context) => Effect.SyncOrPromiseOrEffect<void>

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:29

Parameters

message

SyncMessage.PushRequest

context

CallbackContext

Returns

Effect.SyncOrPromiseOrEffect<void>

---

onPushRes()?

optional onPushRes: (message) => Effect.SyncOrPromiseOrEffect<void>

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:30

Parameters

message

SyncMessage.PushAck | InvalidPushError

Returns

Effect.SyncOrPromiseOrEffect<void>

---

otel?

optional otel: object

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:109

baseUrl?

optional baseUrl: string

serviceName?

optional serviceName: string

---

storage?

optional storage: { _tag: "do-sqlite"; } | { _tag: "d1"; binding: string; }

Defined in: packages/@livestore/sync-cf/src/cf-worker/shared.ts:77

Storage engine for event persistence.

• Default: { _tag: 'do-sqlite' } (Durable Object SQLite)
• D1: { _tag: 'd1', binding: string } where binding is the D1 binding name in wrangler.toml.

If omitted, the runtime defaults to DO SQLite. For backwards-compatibility, if an env binding named DB exists and looks like a D1Database, D1 will be used.

Trade-offs:

• DO SQLite: simpler deploy, data co-located with DO, not externally queryable
• D1: centralized DB, inspectable with DB tools, extra network hop and JSON size limits