Directus / @directus/sdk / realtime / WebSocketClient

Interface: WebSocketClient<Schema> ​

Defined in: realtime/types.ts:29

Type Parameters ​

• Schema

Methods ​

connect() ​

connect(): Promise<WebSocketInterface>

Defined in: realtime/types.ts:30

Returns ​

Promise<WebSocketInterface>

disconnect() ​

disconnect(): void

Defined in: realtime/types.ts:31

Returns ​

void

onWebSocket() ​

Call Signature ​

onWebSocket(event, callback): RemoveEventHandler

Defined in: realtime/types.ts:32

Parameters ​

event ​

"open"

callback ​

(this, ev) => any

Returns ​

RemoveEventHandler

Call Signature ​

onWebSocket(event, callback): RemoveEventHandler

Defined in: realtime/types.ts:33

Parameters ​

event ​

"error"

callback ​

(this, ev) => any

Returns ​

RemoveEventHandler

Call Signature ​

onWebSocket(event, callback): RemoveEventHandler

Defined in: realtime/types.ts:34

Parameters ​

event ​

"close"

callback ​

(this, ev) => any

Returns ​

RemoveEventHandler

Call Signature ​

onWebSocket(event, callback): RemoveEventHandler

Defined in: realtime/types.ts:35

Parameters ​

event ​

"message"

callback ​

(this, ev) => any

Returns ​

RemoveEventHandler

Call Signature ​

onWebSocket(event, callback): RemoveEventHandler

Defined in: realtime/types.ts:36

Parameters ​

event ​

WebSocketEvents

callback ​

WebSocketEventHandler

Returns ​

RemoveEventHandler

sendMessage() ​

sendMessage(message): void

Defined in: realtime/types.ts:37

Parameters ​

message ​

string | Record<string, any>

Returns ​

void

subscribe() ​

subscribe<Collection, Options>(collection, options?): Promise<{ subscription: AsyncGenerator<SubscriptionOutput<Schema, Collection, Options["query"], Fallback<Options["event"], SubscriptionOptionsEvents> | "init", Options["query"] extends Query<Schema, Schema[Collection]> ? IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<(...), (...)> extends FF ? MapFlatFields<(...), (...), (...)> : never, PickRelationalFields<(...)> extends never ? never : { [Field in (...)]: (...) }>[K] }> : Partial<Schema[Collection]>>, void, unknown>; unsubscribe: void; }>

Defined in: realtime/types.ts:38

Type Parameters ​

• Collection extends string | number | symbol

• Options extends SubscribeOptions<Schema, Collection>

Parameters ​

collection ​

Collection

options? ​

Options

Returns ​

Promise<{ subscription: AsyncGenerator<SubscriptionOutput<Schema, Collection, Options["query"], Fallback<Options["event"], SubscriptionOptionsEvents> | "init", Options["query"] extends Query<Schema, Schema[Collection]> ? IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<(...), (...)> extends FF ? MapFlatFields<(...), (...), (...)> : never, PickRelationalFields<(...)> extends never ? never : { [Field in (...)]: (...) }>[K] }> : Partial<Schema[Collection]>>, void, unknown>; unsubscribe: void; }>