endpoint | /endpoints.ts | cav@0.0.24

Module

x/cav/endpoints.ts>endpoint

A server framework for Deno

connorlogin/cav

Go to Latest

test

mod.ts (default module)

function endpoint

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

endpoint<Schema extends EndpointSchema = { }, Resolve extends (x: ResolveArg<Schema>) => any = () => Omitted>(schema?: (Schema & EndpointSchema) | null, resolve?: Resolve & ((x: ResolveArg<Schema>) => any)): Endpoint<[K in keyof Schema | "resolve"in keyof (K extends "resolve" ? (Resolve extends () => Omitted ? never : K) : K)]: (K extends "resolve" ? Resolve : K extends keyof Schema ? Schema[K] : never)>

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

endpoint<Resolve extends (x: ResolveArg<{ }>, ...a: any[]) => any = () => Omitted>(resolve?: Resolve & ((x: ResolveArg<{ }>) => any)): Endpoint<Resolve extends () => Omitted ? { } : { resolve: Resolve; }>

Type Parameters

optional

Schema extends EndpointSchema = { }

optional

Resolve extends (x: ResolveArg<Schema>) => any = () => Omitted

Parameters

optional

schema: (Schema & EndpointSchema) | null

optional

resolve: Resolve & ((x: ResolveArg<Schema>) => any)

Returns

Endpoint<[K in keyof Schema | "resolve"in keyof (K extends "resolve" ? (Resolve extends () => Omitted ? never : K) : K)]: (K extends "resolve" ? Resolve : K extends keyof Schema ? Schema[K] : never)>

Type Parameters

optional

Resolve extends (x: ResolveArg<{ }>, ...a: any[]) => any = () => Omitted

Parameters

optional

resolve: Resolve & ((x: ResolveArg<{ }>) => any)

Returns

Endpoint<Resolve extends () => Omitted ? { } : { resolve: Resolve; }>