ws-asyncapi API / core / WebSocketImplementation

Abstract Class: WebSocketImplementation<WebsocketData, Topics>

Defined in: .api-entries/core/index.d.ts:15

Type Parameters

WebsocketData

WebsocketData extends WebsocketDataType

Topics

Topics

Constructors

Constructor

new WebSocketImplementation<WebsocketData, Topics>(): WebSocketImplementation<WebsocketData, Topics>

Returns

WebSocketImplementation<WebsocketData, Topics>

Properties

id

abstract readonly id: string

Defined in: .api-entries/core/index.d.ts:30

Connection-unique socket id (used for room membership / presence).

Methods

send()

abstract send<T>(type, ...data): void

Defined in: .api-entries/core/index.d.ts:16

Type Parameters

T

T extends string | number | symbol

Parameters

type

T

data

...WebsocketData["server"][T] extends never ? [] : [WebsocketData["server"][T]]

Returns

void

---

sendFrame()

abstract sendFrame(frame): void

Defined in: .api-entries/core/index.d.ts:18

Low-level: encode and send any wire frame (used by the dispatcher).

Parameters

frame

any

Returns

void

---

sendRaw()

abstract sendRaw(data): void

Defined in: .api-entries/core/index.d.ts:20

Low-level: send already-encoded bytes (used to replay buffered frames).

Parameters

data

string | Uint8Array<ArrayBufferLike>

Returns

void

---

request()

abstract request<Name>(name, input, options?): Promise<NonNullable<WebsocketData["serverRpc"]>[Name]["output"]>

Defined in: .api-entries/core/index.d.ts:26

Server→client RPC: ask this client and await its typed reply. Mirrors the client's request() in the other direction. Rejects with an RpcError on the client throwing, a timeout, or disconnect.

Type Parameters

Name

Name extends string | number | symbol

Parameters

name

Name

input

NonNullable<WebsocketData["serverRpc"]>[Name]["input"]

options?

timeout?

number

Returns

Promise<NonNullable<WebsocketData["serverRpc"]>[Name]["output"]>

---

subscribe()

abstract subscribe(topic): void

Defined in: .api-entries/core/index.d.ts:31

Parameters

topic

Topics

Returns

void

---

unsubscribe()

abstract unsubscribe(topic): void

Defined in: .api-entries/core/index.d.ts:32

Parameters

topic

Topics

Returns

void

---

isSubscribed()

abstract isSubscribed(topic): boolean

Defined in: .api-entries/core/index.d.ts:33

Parameters

topic

Topics

Returns

boolean

---

publish()

abstract publish<T>(topic, type, ...data): void

Defined in: .api-entries/core/index.d.ts:34

Type Parameters

T

T extends string | number | symbol

Parameters

topic

Topics

type

T

data

...WebsocketData["server"][T] extends never ? [] : [WebsocketData["server"][T]]

Returns

void

---

broadcast()

abstract broadcast<T>(topic, type, ...data): void

Defined in: .api-entries/core/index.d.ts:39

Like publish, but excludes this socket from delivery — the Socket.IO socket.broadcast.to(topic).emit(...) equivalent.

Type Parameters

T

T extends string | number | symbol

Parameters

topic

Topics

type

T

data

...WebsocketData["server"][T] extends never ? [] : [WebsocketData["server"][T]]

Returns

void

---

roomMembers()

abstract roomMembers(topic): Promise<string[]>

Defined in: .api-entries/core/index.d.ts:41

Cluster-wide socket ids currently in topic (presence / fetchSockets).

Parameters

topic

Topics

Returns

Promise<string[]>

---

close()

abstract close(code?, reason?): void

Defined in: .api-entries/core/index.d.ts:42

Parameters

code?

number

reason?

string

Returns

void