Saltar al contenido
Meeko
Escribe para buscar en las guías y en la referencia de la API. Ábrela desde cualquier página con / o Ctrl K; muévete con las flechas y entra con Intro.
Empezar

Contenidos

En esta página

SocketClientOptions

interfaz

Opciones de createSocketClient y useSocketClient.

ts
import type { SocketClientOptions } from "@meekojs/meeko/framework";

Código fuente src/app/runtime/socket.ts:129

Declaración #

ts
interface SocketClientOptions {
	readonly retryMs?: number
	readonly maxRetryMs?: number
	readonly maxMessageBytes?: number
	readonly webSocketFactory?: (url: string) => WebSocket
	readonly onError?: (error: unknown) => void
}

Ejemplo #

ts
import type { SocketClientOptions } from "@meekojs/meeko/framework";

const options: SocketClientOptions = { retryMs: 1_000, maxRetryMs: 10_000, onError: (error) => console.warn(error) };

Propiedades #

retryMs #

propiedad sólo lectura opcional

readonly retryMs?: number

Primer retraso de reconexión en milisegundos, que se duplica en cada intento; 500 por defecto.

maxRetryMs #

propiedad sólo lectura opcional

readonly maxRetryMs?: number

Retraso máximo de reconexión; 30 000 por defecto.

maxMessageBytes #

propiedad sólo lectura opcional

readonly maxMessageBytes?: number

Tamaño máximo de un mensaje entrante en bytes; 64 KiB por defecto.

webSocketFactory #

propiedad sólo lectura opcional

readonly webSocketFactory?: (url: string) => WebSocket

Crea el WebSocket; útil en pruebas o fuera del navegador.

onError #

propiedad sólo lectura opcional

readonly onError?: (error: unknown) => void

Recibe los mensajes entrantes inválidos y los fallos de los listeners; sin él, la consola.

¿Te sirvió esta página?

Añadir un comentario

Se envía al elegir «Sí» o «No». Solo se guardan la página, tu respuesta y el comentario: ni cookies ni datos tuyos.

0 de 2000 caracteres

Editar en GitHub: packages/meeko/src/app/runtime/socket.ts