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

SocketSchema

interfaz

Subconjunto de Standard Schema v1 que valida los payloads de un evento Socket, como los schemas de Valibot de shared/schemas.

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

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

Declaración #

ts
interface SocketSchema<I = unknown, O = I> {
	readonly '~standard': {
		readonly version: 1
		readonly validate: (value: unknown) => { value: O; issues?: undefined } | { issues: readonly unknown[] } | Promise<{ value: O; issues?: undefined } | { issues: readonly unknown[] }>
		readonly types?: { readonly input: I; readonly output: O } | undefined
	}
}

Parámetros de tipo #

I = unknown

Tipo de entrada.

O = I

Tipo de salida.

Ejemplo #

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

const chatMessage: SocketSchema<{ text: string }> = v.object({ text: v.string() });

Propiedades #

~standard #

propiedad sólo lectura

readonly '~standard': {
	readonly version: 1
	readonly validate: (value: unknown) => { value: O; issues?: undefined } | { issues: readonly unknown[] } | Promise<{ value: O; issues?: undefined } | { issues: readonly unknown[] }>
	readonly types?: { readonly input: I; readonly output: O } | undefined
}

Interfaz Standard Schema v1: validate devuelve el valor de salida o la lista de issues.

¿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