/http/mod.ts | std@0.224.0

import * as mod from "https://deno.land/std@0.224.0/http/mod.ts";

Contains the STATUS_CODE object which contains standard HTTP status codes and provides several type guards for handling status codes with type safety.

Examples

Example 1

import {
  STATUS_CODE,
  STATUS_TEXT,
} from "https://deno.land/std@0.224.0/http/status.ts";

console.log(STATUS_CODE.NotFound); // Returns 404
console.log(STATUS_TEXT[STATUS_CODE.NotFound]); // Returns "Not Found"

Example 2

import { isErrorStatus } from "https://deno.land/std@0.224.0/http/status.ts";

const res = await fetch("https://example.com/");

if (isErrorStatus(res.status)) {
  // error handling here...
}

Classes

c Server deprecated	Used to construct an HTTP server.
c ServerSentEventStream	Transforms server-sent message objects into strings for the client.
c UserAgent	A representation of user agent string, which can be used to determine environmental information represented by the string. All properties are determined lazily.

Variables

v STATUS_CODE	Contains the `STATUS_CODE` object which contains standard HTTP status codes and provides several type guards for handling status codes with type safety.
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 calculate	Calculate an ETag for an entity. When the entity is a specific set of data it will be fingerprinted as a "strong" tag, otherwise if it is just file information, it will be calculated as a weak tag.
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 ifMatch	A helper function that takes the value from the `If-Match` header and a calculated etag for the target. By using strong comparison, return `true` if the values match, otherwise `false`.
f ifNoneMatch	A helper function that takes the value from the `If-None-Match` header and a calculated etag for the target entity and returns `false` if the etag for the entity matches the supplied value, otherwise `true`.
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 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 isStatus	Returns whether the provided number is a valid HTTP status code.
f isSuccessfulStatus	A type guard that determines if the status code is successful.
f parseSignedCookie	Parses a signed cookie to get its value.
f serve deprecated	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 deprecated	Constructs a server, accepts incoming connections on the given listener, and handles requests on these connections with the given handler.
f serveTls deprecated	Serves HTTPS requests with the given handler.
f setCookie	Set the cookie header properly in the headers
f signCookie	Returns a promise with the signed cookie value from the given cryptographic key.
f verifyCookie	Returns a promise of a boolean indicating whether the signed cookie is valid.

Interfaces

I Browser	The browser as described by a user agent string.
I ConnInfo deprecated	Information about the connection a request arrived on.
I Cookie	Represents an HTTP Cookie.
I Cpu	The CPU information as described by a user agent string.
I Device	The device as described by a user agent string.
I Engine	The browser engine as described by a user agent string.
I ETagOptions	Options for `calculate`.
I FileInfo	Just the part of `Deno.FileInfo` that is required to calculate an `ETag`, so partial or user generated file information can be passed.
I Os	The OS as described by a user agent string.
I ServeDirOptions	Interface for serveDir options.
I ServeFileOptions	Interface for serveFile options.
I ServeInit deprecated	Additional serve options.
I ServeListenerOptions deprecated	Additional serve listener options.
I ServerInit deprecated	Options for running an HTTP server.
I ServerSentEventMessage	Represents a message in the Server-Sent Event (SSE) protocol.
I ServeTlsInit deprecated	Initialization parameters for `serveTls`.

Type Aliases

T ClientErrorStatus	An HTTP status that is a client error (4XX).
T Entity	Represents an entity that can be used for generating an ETag.
T ErrorStatus	An HTTP status that is an error (4XX and 5XX).
T Handler deprecated	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	Loose copy of `Request`.
T ServerErrorStatus	An HTTP status that is a server error (5XX).
T StatusCode	An HTTP status code.
T StatusText	An HTTP status text.
T SuccessfulStatus	An HTTP status that is a success (2XX).