Skip to main content
Module

x/cav/endpoint.ts>ResolveArg

A server framework for Deno
connorlogin/cav
Go to Latest
interface ResolveArg
import { type ResolveArg } from "https://deno.land/x/cav@0.2.3/endpoint.ts";

Arguments available to the resolve of an endpoint.

Type Parameters

optional
ParamOut = ParamRecord
optional
CtxOut = undefined
optional
QueryOut = QueryRecord
optional
BodyOut = undefined

Properties

req: Request

The Request being handled.

headers: Headers

Headers that'll be appended to the returned response after processing has finished.

url: URL

new URL(req.url)

conn: http.ConnInfo

Connection information provided by Deno.

path: string

The path that matched the endpoint's path schema option.

param: ParamOut

The parsed path parameters captured while routing the request.

ctx: CtxOut

The context created after the endpoint matched the Request.

query: QueryOut

The parsed query string parameters.

body: BodyOut

The parsed Request body, if any.

res: packResponse

Packs a given body into a Response before resolving, which can be useful if you want to set the response status or in cases where the deserialized value doesn't match the body type because of explicit content-type headers. Be sure to declare the headers init option as const.

bundle: (opt: ServeBundleOptions) => Promise<Response>

Returns a TypeScript/JavaScript bundle as a response. The bundle is cached into memory and, if possible, watched and rebundled whenever updated.

asset: (opt?: ServeAssetOptions) => Promise<Response>

Returns a Response created using an asset from an assets directory.

redirect: (to: string, status?: number) => Response

Returns a redirect Response. If the redirect path doesn't specify an origin, the origin of the current request is used. If the path starts with a ".", it is joined with the pathname of the Request url to get the final redirect path. The default status is 302.