Skip to main content
Module

x/cav/client.ts>EndpointArg

A server framework for Deno
Go to Latest
type alias EndpointArg
import { type EndpointArg } from "https://deno.land/x/cav@0.0.8/client.ts";

Uses the RpcInit type imported from the server to determine what shape the arguments should be in when making requests to a given Rpc.

Type Parameters

Resp
Query
Message
Upgrade
optional
Send = Message extends Parser ? ParserInput<Message> : unknown
optional
Receive = Resp extends SocketResponse<infer R> ? R : unknown
definition: Clean<{ path?: string; query: ParserInput<Query>; message: Upgrade extends true ? never : ParserInput<Message>; packers?: Packers; upgrade: Upgrade extends true ? true : never; onOpen?: Upgrade extends true ? SocketHandler<"open", Send> : never; onClose?: Upgrade extends true ? SocketHandler<"close", Send> : never; onMessage?: Upgrade extends true ? SocketHandler<"message", Send, Parser<unknown, Receive>> : never; onError?: Upgrade extends true ? SocketHandler<"error", Send> : never; }>