Skip to main content
Version: Next

Class: SyncRoom

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:7

SyncRoom Durable Object Manages WebSocket connections and broadcasts change notifications

Extends​

  • DurableObject

Constructors​

Constructor​

new SyncRoom(ctx, env): SyncRoom

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:10

Parameters​

ctx​

DurableObjectState

env​

any

Returns​

SyncRoom

Overrides​

DurableObject.constructor

Properties​

__DURABLE_OBJECT_BRAND​

__DURABLE_OBJECT_BRAND: never

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251221.0/node_modules/@cloudflare/workers-types/index.d.ts:11370

Inherited from​

DurableObject.__DURABLE_OBJECT_BRAND

ctx​

protected ctx: DurableObjectState<{ }>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251221.0/node_modules/@cloudflare/workers-types/index.d.ts:11371

Inherited from​

DurableObject.ctx

env​

protected env: Env

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251221.0/node_modules/@cloudflare/workers-types/index.d.ts:11372

Inherited from​

DurableObject.env

Methods​

alarm()?​

optional alarm(alarmInfo?): void | Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251221.0/node_modules/@cloudflare/workers-types/index.d.ts:11374

Parameters​

alarmInfo?​

AlarmInvocationInfo

Returns​

void | Promise<void>

Inherited from​

DurableObject.alarm

fetch()​

fetch(request): Promise<Response>

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:14

Parameters​

request​

Request

Returns​

Promise<Response>

Overrides​

DurableObject.fetch

webSocketClose()​

webSocketClose(ws, code, reason, wasClean): Promise<void>

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:57

Called when a WebSocket is closed

Parameters​

ws​

WebSocket

code​

number

reason​

string

wasClean​

boolean

Returns​

Promise<void>

Overrides​

DurableObject.webSocketClose

webSocketError()​

webSocketError(ws, error): Promise<void>

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:65

Called when a WebSocket error occurs

Parameters​

ws​

WebSocket

error​

unknown

Returns​

Promise<void>

Overrides​

DurableObject.webSocketError

webSocketMessage()​

webSocketMessage(ws, message): Promise<void>

Defined in: apps/cloudflare-d1-worker/src/SyncRoom.ts:47

Called when a WebSocket message is received

Parameters​

ws​

WebSocket

message​

string | ArrayBuffer

Returns​

Promise<void>

Overrides​

DurableObject.webSocketMessage