Module websocket/utils

Index

Functions

Functions

Const createEvent

createEvent<User>(value: EventInput, channel: WebSocketConnection, user: User): any

- Defined in packages/websocket/src/utils/createEvent.ts:8
Type parameters
- User: null | SociablyUser
Parameters
- value: EventInput
- channel: WebSocketConnection
- user: User
Returns any

Const createJobs

createJobs(channel: DispatchTarget, segments: DispatchableSegment<EventInput>[]): WebSocketJob[]

- Defined in packages/websocket/src/utils/createJobs.ts:4
Parameters
- channel: DispatchTarget
- segments: DispatchableSegment<EventInput>[]
Returns WebSocketJob[]

Const createWsServer

createWsServer(): WsServer

- Defined in packages/websocket/src/utils/createWsServer.ts:3
Returns WsServer

Const createWsSocket

createWsSocket(wsServer: WsServer, req: IncomingMessage, ns: Socket, head: Buffer): Promise<WebSocket>

- Defined in packages/websocket/src/utils/createWsSocket.ts:6
Parameters
- wsServer: WsServer
- req: IncomingMessage
- ns: Socket
- head: Buffer
Returns Promise<WebSocket>

Const rejectUpgrade

rejectUpgrade(ns: Socket, code: number, message?: string): void

- Defined in packages/websocket/src/utils/rejectUpgrade.ts:4
Parameters
- ns: Socket
- code: number
- Optional message: string
Returns void

Generated using TypeDoc