@my-swu/simulator-client / EngineWebSocket
Interface: EngineWebSocket
Defined in: packages/ts-sdk/src/internal/transport.ts:31
Minimal WebSocket shape required by the SDK.
This intentionally matches the browser event-listener style used by WebSocket and common Node adapters.
Example:
import type { EngineWebSocket } from '@my-swu/simulator-client'
// A `WebSocketFactory` returns this DOM-compatible socket subset.
export function inspectEngineWebSocket(engineWebSocket: EngineWebSocket) {
console.log(engineWebSocket)
}See
https://simulator-sdk.my-swu.com/guide/runtime-adapters
Methods
addEventListener()
Example:
import type { EngineWebSocket } from '@my-swu/simulator-client'
// A `WebSocketFactory` returns this DOM-compatible socket subset.
export function inspectEngineWebSocket(engineWebSocket: EngineWebSocket) {
const { addEventListener } = engineWebSocket
console.log(addEventListener)
}addEventListener(
type,listener):void
Defined in: packages/ts-sdk/src/internal/transport.ts:35
Registers one DOM-style event listener.
Parameters
type
"open" | "error" | "message" | "close"
listener
(event) => void
Returns
void
close()
Example:
import type { EngineWebSocket } from '@my-swu/simulator-client'
// A `WebSocketFactory` returns this DOM-compatible socket subset.
export function inspectEngineWebSocket(engineWebSocket: EngineWebSocket) {
const { close } = engineWebSocket
console.log(close)
}close(
code?,reason?):void
Defined in: packages/ts-sdk/src/internal/transport.ts:56
Closes the socket.
Parameters
code?
number
reason?
string
Returns
void
removeEventListener()
Example:
import type { EngineWebSocket } from '@my-swu/simulator-client'
// A `WebSocketFactory` returns this DOM-compatible socket subset.
export function inspectEngineWebSocket(engineWebSocket: EngineWebSocket) {
const { removeEventListener } = engineWebSocket
console.log(removeEventListener)
}removeEventListener(
type,listener):void
Defined in: packages/ts-sdk/src/internal/transport.ts:43
Unregisters one DOM-style event listener.
Parameters
type
"open" | "error" | "message" | "close"
listener
(event) => void
Returns
void
send()
Example:
import type { EngineWebSocket } from '@my-swu/simulator-client'
// A `WebSocketFactory` returns this DOM-compatible socket subset.
export function inspectEngineWebSocket(engineWebSocket: EngineWebSocket) {
const { send } = engineWebSocket
console.log(send)
}send(
data):void
Defined in: packages/ts-sdk/src/internal/transport.ts:51
Sends one text frame.
Parameters
data
string
Returns
void