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

SocketContract

interfaz

Contrato público de un canal Socket: los schemas de cada evento en cada dirección. Meeko lo genera a partir de defineSocketChannel sin importar los handlers privados.

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

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

Declaración #

ts
interface SocketContract<ClientToServer extends Events = Events, ServerToClient extends Events = Events> {
	readonly clientToServer: ClientToServer
	readonly serverToClient: ServerToClient
}

Parámetros de tipo #

ClientToServer extends Events = Events
ServerToClient extends Events = Events

Ejemplo #

ts
import * as v from "valibot";
import type { SocketContract } from "@meekojs/meeko/framework";

const chat = {
  clientToServer: { message: v.object({ text: v.string(), roomId: v.string() }) },
  serverToClient: { message: v.object({ text: v.string() }) },
} satisfies SocketContract;

Propiedades #

clientToServer #

propiedad sólo lectura

readonly clientToServer: ClientToServer

Eventos que envía el cliente, con su schema.

serverToClient #

propiedad sólo lectura

readonly serverToClient: ServerToClient

Eventos que envía el servidor, con su schema.

¿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