Skip to main content
Module

x/aleph/types.ts>APIRequest

The Full-stack Framework in Deno.
Very Popular
Go to Latest
interface APIRequest
implements ServerRequest
import { type APIRequest } from "https://deno.land/x/aleph@v0.3.0-alpha.7/types.ts";

An interface extends the ServerRequest for API requests.

Properties

readonly
pathname: string
readonly
params: Record<string, string>
readonly
query: URLSearchParams
readonly
cookies: ReadonlyMap<string, string>

Methods

status(code: number): this

status sets response status of the request.

addHeader(key: string, value: string): this

addHeader adds a new value onto an existing response header of the request, or adds the header if it does not already exist.

setHeader(key: string, value: string): this

setHeader sets a new value for an existing response header of the request, or adds the header if it does not already exist.

removeHeader(key: string): this

removeHeader removes the value for an existing response header of the request.

send(data: string | Uint8Array | ArrayBuffer, contentType?: string): Promise<void>

send replies to the request with any content with type.

json(data: any): Promise<void>

json replies to the request with a json content.

decodeBody(type: "form-data"): Promise<FormDataBody>

decodeBody will return a string, form-data, or json object.

decodeBody(type: "text"): Promise<string>
decodeBody(type: "json"): Promise<any>