/dep/std/http.ts | frugal@0.3.0

import * as frugal from "https://deno.land/x/frugal@0.3.0/dep/std/http.ts";

A collection of HTTP errors and utilities.

The export errors contains an individual class that extends HttpError which makes handling HTTP errors in a structured way.

The function createHttpError provides a way to create instances of errors in a factory pattern.

The function isHttpError is a type guard that will narrow a value to an HttpError instance.

Examples

import { errors, isHttpError } from "https://deno.land/std@0.224.0/http/http_errors.ts";

try {
  throw new errors.NotFound();
} catch (e) {
  if (isHttpError(e)) {
    const response = new Response(e.message, { status: e.status });
  } else {
    throw e;
  }
}

import { createHttpError } from "https://deno.land/std@0.224.0/http/http_errors.ts";
import { Status } from "https://deno.land/std@0.224.0/http/http_status.ts";

try {
  throw createHttpError(
    Status.BadRequest,
    "The request was bad.",
    { expose: false }
  );
} catch (e) {
  // handle errors
}

Classes

c CookieMap	Provides an way to manage cookies in a request and response on the server as a single iterable collection.
c HttpError	The base class that all derivative HTTP extend, providing a `status` and an `expose` property.
c SecureCookieMap	Provides an way to manage cookies in a request and response on the server as a single iterable collection, as well as the ability to sign and verify cookies to prevent tampering.
c Server	Used to construct an HTTP server.

Enums

Status

Standard HTTP status codes.

Variables

v cookieMapHeadersInitSymbol	Symbol which is used in mergeHeaders to extract a `[string \| string][]` from an instance to generate the final set of headers.
v errors	A map of HttpErrors that are unique instances for each HTTP error status code.
v STATUS_TEXT	A record of all the status codes text.

Functions

f accepts	Returns an array of media types accepted by the request, in order of preference. If there are no media types supplied in the request, then any media type selector will be returned.
f acceptsEncodings	Returns an array of content encodings accepted by the request, in order of preference. If there are no encoding supplied in the request, then `["*"]` is returned, implying any encoding is accepted.
f acceptsLanguages	Returns an array of languages accepted by the request, in order of preference. If there are no languages supplied in the request, then `["*"]` is returned, imply any language is accepted.
f createHttpError	Create an instance of an HttpError based on the status code provided.
f deleteCookie	Set the cookie header with empty value in the headers to delete it
f getCookies	Parse cookies of a header
f getSetCookies	Parse set-cookies of a header
f isClientErrorStatus	A type guard that determines if the status code is a client error.
f isErrorStatus	A type guard that determines if the status code is an error.
f isHttpError	A type guard that determines if the value is an HttpError or not.
f isInformationalStatus	A type guard that determines if the status code is informational.
f isRedirectStatus	A type guard that determines if the status code is a redirection.
f isServerErrorStatus	A type guard that determines if the status code is a server error.
f isSuccessfulStatus	A type guard that determines if the status code is successful.
f mergeHeaders	Allows merging of various sources of headers into a final set of headers which can be used in a `Response`.
f serve	Serves HTTP requests with the given handler.
f serveDir	Serves the files under the given directory root (opts.fsRoot).
f serveFile	Returns an HTTP Response with the requested file as the body.
f serveListener	Constructs a server, accepts incoming connections on the given listener, and handles requests on these connections with the given handler.
f serveTls	Serves HTTPS requests with the given handler.
f setCookie	Set the cookie header properly in the headers

Interfaces

I ConnInfo	Information about the connection a request arrived on.
I Cookie
I CookieMapOptions	Provides a iterable map interfaces for managing cookies server side.
I CookieMapSetDeleteOptions
I Headered	An object which contains a `headers` property which has a value of an instance of `Headers`, like `Request` and `Response`.
I HttpErrorOptions
I KeyRing	An interface which describes the methods that `SecureCookieMap` uses to sign and verify cookies.
I Mergeable
I SecureCookieMapGetOptions
I SecureCookieMapOptions
I SecureCookieMapSetDeleteOptions
I ServeDirOptions	Interface for serveDir options.
I ServeFileOptions	Interface for serveFile options.
I ServeInit	Additional serve options.
I ServerInit	Options for running an HTTP server.
I ServeTlsInit

Type Aliases

T ClientErrorStatus	An HTTP status that is a client error (4XX).
T Data	Types of data that can be signed cryptographically.
T ErrorStatus	An HTTP status that is an error (4XX and 5XX).
T ErrorStatusKeys
T EtagAlgorithm	Algorithm used to determine etag
T Handler	A handler for HTTP requests. Consumes a request and connection information and returns a response.
T InformationalStatus	An HTTP status that is a informational (1XX).
T RedirectStatus	An HTTP status that is a redirect (3XX).
T Request
T ServerErrorStatus	An HTTP status that is a server error (5XX).
T SuccessfulStatus	An HTTP status that is a success (2XX).