Interface BunWebSocketHandlers

The serve-time socket handler object Bun expects under Bun.serve's websocket option.

Since

0.2.0

interface BunWebSocketHandlers {
    close(ws: BunServerWebSocket, code: number, reason: string): void;
    error(ws: BunServerWebSocket, error: unknown): void;
    message(
        ws: BunServerWebSocket,
        message: string | Uint8Array<ArrayBufferLike>,
    ): void;
    open(ws: BunServerWebSocket): void;
}

Index

Methods

close error message open

Methods

close

close(ws: BunServerWebSocket, code: number, reason: string): void
Called once on close.
Parameters
- ws: BunServerWebSocket
  The socket
- code: number
  RFC 6455 close code
- reason: string
  Close reason
Returns void
- Defined in packages/runtime/src/adapters/bun/bun-ws-upgrader.ts:71

error

error(ws: BunServerWebSocket, error: unknown): void
Called on transport error.
Parameters
- ws: BunServerWebSocket
  The socket
- error: unknown
  The error
Returns void
- Defined in packages/runtime/src/adapters/bun/bun-ws-upgrader.ts:78

message

message(
ws: BunServerWebSocket,
message: string | Uint8Array<ArrayBufferLike>,
): void
Called per inbound frame.
Parameters
- ws: BunServerWebSocket
  The socket
- message: string | Uint8Array<ArrayBufferLike>
  The frame payload
Returns void
- Defined in packages/runtime/src/adapters/bun/bun-ws-upgrader.ts:63

open

open(ws: BunServerWebSocket): void
Called once the socket is live.
Parameters
- ws: BunServerWebSocket
  The upgraded socket
Returns void
- Defined in packages/runtime/src/adapters/bun/bun-ws-upgrader.ts:56