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.

Open the Spanish original

SocketUpgradeOptions

interfaz

Opciones de createSocketUpgradeHandler.

ts
import type { SocketUpgradeOptions } from "@meekojs/meeko/server";

Source code src/server/runtime/upgrade.ts:20

Declaración #

ts
interface SocketUpgradeOptions {
	hub: SocketHub
	publicOrigin: string
	pathnamePrefix?: string
	maxPendingBytes?: number
	onError?(error: unknown): void
}

Example #

ts
import type { SocketUpgradeOptions } from "@meekojs/meeko/server";

const options: SocketUpgradeOptions = {
  hub: app.socket!.hub,
  publicOrigin: "https://example.com",
  onError: (error) => app.reportError(error, crypto.randomUUID()),
};

Miembros #

hub #

propiedad 

hub: SocketHub

Hub de la aplicación.

publicOrigin #

propiedad 

publicOrigin: string

Origen público fijo; la política de seguridad nunca se deduce de una cabecera Host no confiable.

pathnamePrefix #

propiedad opcional 

pathnamePrefix?: string

Prefijo de los canales, servidos en <prefix>/<nombre>. Por defecto, /_meeko/socket.

maxPendingBytes #

propiedad opcional 

maxPendingBytes?: number

Bytes entrantes retenidos mientras el hub autoriza una conexión nueva. Por defecto, 64 KiB.

onError #

método opcional 

onError?(error: unknown): void

Observador de los fallos del transporte y de las sesiones.

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/server/runtime/upgrade.ts