Skip to content
Meeko
Type to search the guides and the API reference. Open it from any page with / or Ctrl K; move with the arrow keys and open a result with Enter.
Get started

Contents

On this page

Not translated yet

This page has not been translated into English yet, so it is shown in Spanish.

BunWebSocketHandler

interfaz

Opciones y handlers WebSocket para Bun.serve({ websocket }), con los límites ya resueltos.

ts
import type { BunWebSocketHandler } from "@meekojs/meeko/bun";

Source code src/bun.ts:67

Declaración #

ts
interface BunWebSocketHandler {
	open(socket: BunServerWebSocket): void
	message(socket: BunServerWebSocket, message: string | Uint8Array): void
	close(socket: BunServerWebSocket, code: number, reason: string): void
	readonly maxPayloadLength: number
	readonly backpressureLimit: number
	readonly closeOnBackpressureLimit: boolean
	readonly idleTimeout: number
	readonly sendPings: boolean
	readonly perMessageDeflate: boolean
}

Example #

ts
const { websocket } = createBunServer(app);
console.log(websocket.maxPayloadLength, websocket.idleTimeout);

Miembros #

open #

método

open(socket: BunServerWebSocket): void

Conecta el peer al hub.

message #

método

message(socket: BunServerWebSocket, message: string | Uint8Array): void

Entrega un mensaje al hub.

close #

método

close(socket: BunServerWebSocket, code: number, reason: string): void

Informa al hub del cierre.

maxPayloadLength #

propiedad sólo lectura

readonly maxPayloadLength: number

Frame entrante más grande.

backpressureLimit #

propiedad sólo lectura

readonly backpressureLimit: number

Bytes salientes en cola por peer.

closeOnBackpressureLimit #

propiedad sólo lectura

readonly closeOnBackpressureLimit: boolean

Cierra el peer al superar backpressureLimit.

idleTimeout #

propiedad sólo lectura

readonly idleTimeout: number

Segundos sin tráfico antes de cerrar un peer.

sendPings #

propiedad sólo lectura

readonly sendPings: boolean

Envía pings a los peers inactivos.

perMessageDeflate #

propiedad sólo lectura

readonly perMessageDeflate: boolean

Compresión por mensaje; siempre desactivada.

See also #

Was this page helpful?

Add a comment

It is sent when you choose “Yes” or “No”. Only the page, your answer and the comment are stored: no cookies and no personal data.

0 of 2000 characters

Edit on GitHub: packages/meeko/src/bun.ts