Type Alias WebSocketLike

WebSocket factory — Node + browser default. React Native uses websocket.native.ts (Metro platform resolve) so the Node-only ws package is never pulled into the RN bundle.

type WebSocketLike = {
    readyState: number;
    addEventListener(type: string, listener: (event: unknown) => void): void;
    close(code?: number, reason?: string): void;
    removeEventListener(type: string, listener: (event: unknown) => void): void;
    send(data: string): void;
}

Index

Properties

Methods

addEventListener close removeEventListener send

Properties

readyState

readyState: number

Methods

addEventListener

addEventListener(type: string, listener: (event: unknown) => void): void
Parameters
- type: string
- listener: (event: unknown) => void
Returns void
- Defined in packages/sdk/src/phx_channel/websocket.ts:10

close

close(code?: number, reason?: string): void
Parameters
- Optionalcode: number
- Optionalreason: string
Returns void
- Defined in packages/sdk/src/phx_channel/websocket.ts:9

removeEventListener

removeEventListener(type: string, listener: (event: unknown) => void): void
Parameters
- type: string
- listener: (event: unknown) => void
Returns void
- Defined in packages/sdk/src/phx_channel/websocket.ts:11

send

send(data: string): void
Parameters
- data: string
Returns void
- Defined in packages/sdk/src/phx_channel/websocket.ts:8