socket | /endpoints.ts | cav@0.0.24

Module

x/cav/endpoints.ts>socket

A server framework for Deno

connorlogin/cav

Go to Latest

test

mod.ts (default module)

function socket

import { socket } from "https://deno.land/x/cav@0.0.24/endpoints.ts";

socket<Schema extends SocketSchema | null, Setup extends ((x: SetupArg<Schema>) => any) = () => Omitted>(schema?: (Schema & SocketSchema) | null, setup?: Setup & ((x: SetupArg<Schema>) => Promise<void> | void)): Socket<[K in keyof Schema | "setup"in keyof (K extends "setup" ? (Setup extends () => Omitted ? never : K) : K)]: (K extends "setup" ? Setup : K extends keyof Schema ? Schema[K] : never)>

Constructs a new Socket request handler using the provided schema and setup function. The schema properties will be assigned to the returned socket endpoint function, with the setup argument available as the "setup" property.

socket<Setup extends (x: SetupArg<{ }>) => any = () => Omitted>(setup?: Setup): Socket<Setup extends () => Omitted ? { } : { setup: Setup; }>

Type Parameters

Schema extends SocketSchema | null

optional

Setup extends ((x: SetupArg<Schema>) => any) = () => Omitted

Parameters

optional

schema: (Schema & SocketSchema) | null

optional

setup: Setup & ((x: SetupArg<Schema>) => Promise<void> | void)

Returns

Socket<[K in keyof Schema | "setup"in keyof (K extends "setup" ? (Setup extends () => Omitted ? never : K) : K)]: (K extends "setup" ? Setup : K extends keyof Schema ? Schema[K] : never)>

Type Parameters

optional

Setup extends (x: SetupArg<{ }>) => any = () => Omitted

Parameters

optional

setup: Setup

Returns

Socket<Setup extends () => Omitted ? { } : { setup: Setup; }>