/deps/std/http.ts | capi@v0.1.1-beta.1

import * as capi from "https://deno.land/x/capi@v0.1.1-beta.1/deps/std/http.ts";

Provides a iterable map interfaces for managing cookies server side.

Examples

To access the keys in a request and have any set keys available for creating a response:

import {
  CookieMap,
  mergeHeaders
} from "https://deno.land/std@0.224.0/http/cookie_map.ts";

const request = new Request("https://localhost/", {
  headers: { "cookie": "foo=bar; bar=baz;"}
});

const cookies = new CookieMap(request, { secure: true });
console.log(cookies.get("foo")); // logs "bar"
cookies.set("session", "1234567", { secure: true });

const response = new Response("hello", {
  headers: mergeHeaders({
    "content-type": "text/plain",
  }, cookies),
});

To have automatic management of cryptographically signed cookies, you can use the SecureCookieMap instead of CookieMap. The biggest difference is that the methods operate async in order to be able to support async signing and validation of cookies:

import {
  SecureCookieMap,
  mergeHeaders,
  type KeyRing,
} from "https://deno.land/std@0.224.0/http/cookie_map.ts";

const request = new Request("https://localhost/", {
  headers: { "cookie": "foo=bar; bar=baz;"}
});

// The keys must implement the `KeyRing` interface.
declare const keys: KeyRing;

const cookies = new SecureCookieMap(request, { keys, secure: true });
console.log(await cookies.get("foo")); // logs "bar"
// the cookie will be automatically signed using the supplied key ring.
await cookies.set("session", "1234567");

const response = new Response("hello", {
  headers: mergeHeaders({
    "content-type": "text/plain",
  }, cookies),
});

In addition, if you have a Response or Headers for a response at construction of the cookies object, they can be passed and any set cookies will be added directly to those headers:

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

const request = new Request("https://localhost/", {
  headers: { "cookie": "foo=bar; bar=baz;"}
});

const response = new Response("hello", {
  headers: { "content-type": "text/plain" },
});

const cookies = new CookieMap(request, { response });
console.log(cookies.get("foo")); // logs "bar"
cookies.set("session", "1234567");

Classes

c CookieMap	Provides a 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.
c ServerSentEvent	An event which contains information which will be sent to the remote connection and be made available in an `EventSource` as an event. A server creates new events and dispatches them on the target which will then be sent to a client.
c ServerSentEventStreamTarget	An implementation of `ServerSentEventTarget` that provides a readable stream as a body of a response to establish a connection to a client.

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 namespace that contains each error constructor. Each error extends `HTTPError` and provides `.status` and `.expose` properties, where the `.status` will be an error `Status` value and `.expose` indicates if information, like a stack trace, should be shared in the response.
v HTTP_METHODS	A constant array of common HTTP methods.
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 createHttpError	A factory function which provides a way to create errors. It takes up to 3 arguments, the error `Status`, an message, which defaults to the status text and error options, which incudes the `expose` property to set the `.expose` value on the error.
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 isHttpError	A type guard that determines if the value is an HttpError or not.
f isHttpMethod	A type guard that determines if a value is a valid HTTP method.
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 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 ETagOptions
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 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 ServeInit	Additional serve options.
I ServerInit	Options for running an HTTP server.
I ServerSentEventInit
I ServerSentEventTarget
I ServerSentEventTargetOptions
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 Handler	A handler for HTTP requests. Consumes a request and connection information and returns a response.
T HttpMethod	A type representing string literals of each of the common HTTP method.
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).