/cookie_map.ts | oak_commons@1.0.0

import * as mod from "https://dotland.deno.dev/x/oak_commons@1.0.0/cookie_map.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 "jsr:@oak/commons/cookie_map";

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 "jsr:@oak/commons/cookie_map";

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 {@link Response} or {@link 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 "jsr:@oak/commons/cookie_map";

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 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.

Variables

cookieMapHeadersInitSymbol

Symbol which is used in mergeHeaders to extract a [string | string][] from an instance to generate the final set of headers.

Functions

mergeHeaders

Allows merging of various sources of headers into a final set of headers which can be used in a {@link Response}.

Interfaces

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 {@link `Headers`}, like {@link `Request`} and {@link `Response`}.
I KeyRing	An interface which describes the methods that `SecureCookieMap` uses to sign and verify cookies.
I Mergeable	An object which contains a symbol which indicates that it can be merged with other headers.
I SecureCookieMapGetOptions	Options which can be set when calling the `.get()` method on a `SecureCookieMap`.
I SecureCookieMapOptions	Options which can be set when initializing a `SecureCookieMap`.
I SecureCookieMapSetDeleteOptions	Options which can be set when calling the `.set()` or `.delete()` method on a `SecureCookieMap`.

Type Aliases

Data

Types of data that can be signed cryptographically.