/http/mod.ts | std@0.211.0

Deprecated

(will be removed after 0.212.0) Use https://deno.land/std/http/cookie.ts and https://deno.land/std/http/unstable_signed_cookie.ts instead.

import * as mod from "https://deno.land/std@0.211.0/http/mod.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.211.0/http/unstable_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.211.0/http/unstable_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.211.0/http/unstable_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 Server deprecated
c ServerSentEventStream	Transforms server-sent message objects into strings for the client.
c UserAgent

Variables

v CookieMap deprecated	Provides a way to manage cookies in a request and response on the server as a single iterable collection.
v cookieMapHeadersInitSymbol deprecated	Symbol which is used in mergeHeaders to extract a `[string \| string][]` from an instance to generate the final set of headers.
v mergeHeaders deprecated	Allows merging of various sources of headers into a final set of headers which can be used in a `Response`.
v SecureCookieMap deprecated
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
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
f serveListener deprecated
f serveTls deprecated
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
I ConnInfo deprecated
I Cookie
I Cpu
I Device
I Engine
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 Os
I ServeInit deprecated
I ServeListenerOptions deprecated
I ServerInit deprecated
I ServerSentEventMessage
I ServeTlsInit deprecated

Type Aliases

T ClientErrorStatus	An HTTP status that is a client error (4XX).
T CookieMapOptions deprecated
T CookieMapSetDeleteOptions deprecated
T Data deprecated	Types of data that can be signed cryptographically.
T ErrorStatus	An HTTP status that is an error (4XX and 5XX).
T Handler deprecated
T Headered deprecated
T InformationalStatus	An HTTP status that is a informational (1XX).
T KeyRing deprecated	An interface which describes the methods that `SecureCookieMap` uses to sign and verify cookies.
T Mergeable deprecated
T RedirectStatus	An HTTP status that is a redirect (3XX).
T Request
T SecureCookieMapGetOptions deprecated
T SecureCookieMapOptions deprecated
T SecureCookieMapSetDeleteOptions deprecated
T ServerErrorStatus	An HTTP status that is a server error (5XX).
T StatusCode
T StatusText
T SuccessfulStatus	An HTTP status that is a success (2XX).