Interface SocketLike

Minimal Socket.IO socket shape used by socketIoTransport().

interface SocketLike {
    disconnect(): void;
    emit(event: "kkrpc:message", message: RPCMessage): void;
    off(event: "kkrpc:message", listener: (message: RPCMessage) => void): void;
    on(event: "kkrpc:message", listener: (message: RPCMessage) => void): void;
}

Index

Methods

disconnect? emit off on

Methods

`Optional`disconnect

disconnect(): void
Optionally disconnect the socket when the transport closes.

Returns void
- Defined in packages/kkrpc/src/transports/socketio.ts:24

emit

emit(event: "kkrpc:message", message: RPCMessage): void
Emit one RPC message on the kkrpc event.
Parameters
- event: "kkrpc:message"
- message: RPCMessage
Returns void
- Defined in packages/kkrpc/src/transports/socketio.ts:18

off

off(event: "kkrpc:message", listener: (message: RPCMessage) => void): void
Remove a listener for incoming RPC messages.
Parameters
- event: "kkrpc:message"
- listener: (message: RPCMessage) => void
Returns void
- Defined in packages/kkrpc/src/transports/socketio.ts:22

on

on(event: "kkrpc:message", listener: (message: RPCMessage) => void): void
Attach a listener for incoming RPC messages.
Parameters
- event: "kkrpc:message"
- listener: (message: RPCMessage) => void
Returns void
- Defined in packages/kkrpc/src/transports/socketio.ts:20