PlatformSocket
Defined in: platform/types.ts:111
The platform-neutral socket surface (GameSocket / WeChatSocket / a Node ws
wrapper all fit): multicast on(event, fn) → unsubscribe, queues sends
until open, moves string|ArrayBuffer frames.
Properties
Section titled “Properties”delivery
Section titled “delivery”
readonlydelivery:"reliable-ordered"
Defined in: platform/types.ts:115
Every platform socket is a WebSocket (browser, wx.connectSocket, Node
ws), so every one of them delivers in order and loses nothing — which
is what lets a socket be handed straight to replication.
readyState
Section titled “readyState”readyState:
PlatformSocketReadyState
Defined in: platform/types.ts:116
Methods
Section titled “Methods”close()
Section titled “close()”close(
code?,reason?):void
Defined in: platform/types.ts:123
Parameters
Section titled “Parameters”number
reason?
Section titled “reason?”string
Returns
Section titled “Returns”void
connect()
Section titled “connect()”connect():
void
Defined in: platform/types.ts:121
Returns
Section titled “Returns”void
on<
K>(event,handler): () =>void
Defined in: platform/types.ts:117
Type Parameters
Section titled “Type Parameters”K extends keyof PlatformSocketEvents
Parameters
Section titled “Parameters”K
handler
Section titled “handler”(…args) => void
Returns
Section titled “Returns”() => void
send()
Section titled “send()”send(
data):void
Defined in: platform/types.ts:122
Parameters
Section titled “Parameters”string | ArrayBuffer
Returns
Section titled “Returns”void