Skip to main content
Module

x/cav/client.ts

A server framework for Deno
Go to Latest
import * as cav from "https://deno.land/x/cav@0.2.0-alpha.5/client.ts";

Functions

Constructs a new Client function tied to the base URL. The provided set of serializers will be used everywhere that data is de/serialized when using this client, including web sockets.

Interfaces

A server endpoint handler can use this Request type to ferry type information to the client about what argument types are acceptable and what the Response will deserialize into.

A server router handler can use this Request type to ferry type information to the client about what routes exist and what data they accept/return. The client uses the RouterShape to infer which property accesses are valid and what their response type will be.

Type constraint for the type parameter of a RouterRequest. The shape describes the client property accesses that would result in a valid endpoint call. The endpoints are specified by their handler definitions.

A server socket handler can use this Request type to ferry type information to the client about the valid socket send/receive message types and acceptable query string parameters for the initial request.

A version of the Client type without E2E type safety.

ClientArg but without any type information. These are the arguments when the type for the client function isn't known.

Type Aliases

Client function that wraps a fetch() process tailored for making requests to a Cav handler, complete with serialization and socket support.

Arguments for the client function when its internal path points to an endpoint.

Type constraint for the Client's type parameter.

Generic handler type for server-defined Request handlers.