Empezar

En esta página

`SocketBroadcaster`

interfaz Desde 1.2.0

Broadcast tipado de un canal Socket desde el servidor, que añade el registro socket de los clientes de servidor generados (desde 1.2).

ts

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

Código fuente src/server/socket/runtime.ts:586

Declaración #

ts

interface SocketBroadcaster<C extends SocketContract> {
	broadcast<K extends keyof C['serverToClient'] & string>(roomId: string, event: K, payload: SchemaInput<C['serverToClient'][K]>): Promise<void>
}

Parámetros de tipo #

C extends SocketContract: Contrato público del canal.

Ejemplo #

ts

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

declare const kitchen: SocketBroadcaster<typeof socketContracts.operations>;
await kitchen.broadcast("store-12", "kitchenChanged", { orderId: "A-31", status: "ready" });

Miembros #

`broadcast` #

método

broadcast<K extends keyof C['serverToClient'] & string>(roomId: string, event: K, payload: SchemaInput<C['serverToClient'][K]>): Promise<void>

Publica event en la sala roomId del canal con las mismas comprobaciones que hub.broadcast: rechaza con UNKNOWN_SOCKET_EVENT (404), INVALID_SOCKET_PAYLOAD (400) o SOCKET_LIMIT_EXCEEDED (413) antes de publicar, y se resuelve cuando el broker acepta el mensaje. Las conexiones sin sala usan "".

Véase también #

Broadcast desde el servidor Framework full-stack

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