valkeySubscriber

Workspace API

---

Workspace API / services/valkeySubscriber

services/valkeySubscriber

Classes

ValkeySubscriber

Defined in: services/valkeySubscriber.ts:15

Constructors

Constructor

new ValkeySubscriber(): ValkeySubscriber

Defined in: services/valkeySubscriber.ts:21

Returns

ValkeySubscriber

Methods

connect()

connect(): Promise<void>

Defined in: services/valkeySubscriber.ts:63

Returns

Promise<void>

subscribe()

subscribe(organization_id, document_id, callback): () => void

Defined in: services/valkeySubscriber.ts:122

Register a callback for document status updates.

Parameters

organization_id

string

Organization ID

document_id

string

Document ID

callback

StatusCallback

Callback function to receive status updates

Returns

Unsubscribe function

(): void

Returns

void

isAvailable()

isAvailable(): boolean

Defined in: services/valkeySubscriber.ts:154

Check if Valkey is available and connected.

Returns

boolean

true if Valkey is configured and connected, false otherwise

disconnect()

disconnect(): Promise<void>

Defined in: services/valkeySubscriber.ts:180

Returns

Promise<void>

Type Aliases

StatusCallback()

StatusCallback = (data) => void

Defined in: services/valkeySubscriber.ts:13

Callback function for document status updates via Valkey pub/sub

Parameters

data

Record<string, unknown>

Returns

void

Functions

getValkeySubscriber()

getValkeySubscriber(): ValkeySubscriber

Defined in: services/valkeySubscriber.ts:204

Returns

ValkeySubscriber