Bun proporciona APIs nativas para trabajar con cookies HTTP a través de Bun.Cookie y Bun.CookieMap. Estas APIs ofrecen métodos rápidos y fáciles de usar para analizar, generar y manipular cookies en solicitudes y respuestas HTTP.

Clase CookieMap

Bun.CookieMap proporciona una interfaz tipo Map para trabajar con colecciones de cookies. Implementa la interfaz Iterable, lo que te permite usarla con bucles for...of y otros métodos de iteración.

cookies.ts

// Mapa de cookies vacío
const cookies = new Bun.CookieMap();

// Desde una cadena de cookie
const cookies1 = new Bun.CookieMap("name=value; foo=bar");

// Desde un objeto
const cookies2 = new Bun.CookieMap({
  session: "abc123",
  theme: "dark",
});

// Desde un array de pares nombre/valor
const cookies3 = new Bun.CookieMap([
  ["session", "abc123"],
  ["theme", "dark"],
]);

En servidores HTTP

En el servidor HTTP de Bun, la propiedad cookies en el objeto de solicitud (en routes) es una instancia de CookieMap:

server.ts

const server = Bun.serve({
  routes: {
    "/": req => {
      // Acceder a las cookies de la solicitud
      const cookies = req.cookies;

      // Obtener una cookie específica
      const sessionCookie = cookies.get("session");
      if (sessionCookie != null) {
        console.log(sessionCookie);
      }

      // Verificar si existe una cookie
      if (cookies.has("theme")) {
        // ...
      }

      // Establecer una cookie, se aplicará automáticamente a la respuesta
      cookies.set("visited", "true");

      return new Response("Hello");
    },
  },
});

console.log("Servidor escuchando en: " + server.url);

Métodos

get(name: string): string | null

Recupera una cookie por nombre. Devuelve null si la cookie no existe.

get-cookie.ts

// Obtener por nombre
const cookie = cookies.get("session");

if (cookie != null) {
  console.log(cookie);
}

has(name: string): boolean

Verifica si existe una cookie con el nombre dado.

has-cookie.ts

// Verificar si existe la cookie
if (cookies.has("session")) {
  // La cookie existe
}

set(name: string, value: string): void

set(options: CookieInit): void

set(cookie: Cookie): void

Agrega o actualiza una cookie en el mapa. Las cookies tienen por defecto { path: "/", sameSite: "lax" }.

set-cookie.ts

// Establecer por nombre y valor
cookies.set("session", "abc123");

// Establecer usando objeto de opciones
cookies.set({
  name: "theme",
  value: "dark",
  maxAge: 3600,
  secure: true,
});

// Establecer usando instancia de Cookie
const cookie = new Bun.Cookie("visited", "true");
cookies.set(cookie);

delete(name: string): void

delete(options: CookieStoreDeleteOptions): void

Elimina una cookie del mapa. Cuando se aplica a una Response, esto agrega una cookie con un valor de cadena vacía y una fecha de expiración en el pasado. Una cookie solo se eliminará correctamente en el navegador si el dominio y la ruta son los mismos que cuando se creó la cookie.

delete-cookie.ts

// Eliminar por nombre usando dominio y ruta predeterminados.
cookies.delete("session");

// Eliminar con opciones de dominio/ruta.
cookies.delete({
  name: "session",
  domain: "example.com",
  path: "/admin",
});

toJSON(): Record<string, string>

Convierte el mapa de cookies a un formato serializable.

cookie-to-json.ts

const json = cookies.toJSON();

toSetCookieHeaders(): string[]

Devuelve un array de valores para encabezados Set-Cookie que se pueden usar para aplicar todos los cambios de cookies.

Cuando usas Bun.serve(), no necesitas llamar a este método explícitamente. Cualquier cambio realizado en el mapa req.cookies se aplica automáticamente a los encabezados de respuesta. Este método es principalmente útil cuando trabajas con otras implementaciones de servidores HTTP.

node-server.js

import { CookieMap } from "bun";

const server = createServer((req, res) => {
  const cookieHeader = req.headers.cookie || "";
  const cookies = new CookieMap(cookieHeader);

  cookies.set("view-count", Number(cookies.get("view-count") || "0") + 1);
  cookies.delete("session");

  res.writeHead(200, {
    "Content-Type": "text/plain",
    "Set-Cookie": cookies.toSetCookieHeaders(),
  });
  res.end(`Encontradas ${cookies.size} cookies`);
});

server.listen(3000, () => {
  console.log("Servidor ejecutándose en http://localhost:3000/");
});

Iteración

CookieMap proporciona varios métodos para iteración:

iterate-cookies.ts

// Iterar sobre entradas [nombre, cookie]
for (const [name, value] of cookies) {
  console.log(`${name}: ${value}`);
}

// Usando entries()
for (const [name, value] of cookies.entries()) {
  console.log(`${name}: ${value}`);
}

// Usando keys()
for (const name of cookies.keys()) {
  console.log(name);
}

// Usando values()
for (const value of cookies.values()) {
  console.log(value);
}

// Usando forEach
cookies.forEach((value, name) => {
  console.log(`${name}: ${value}`);
});

Propiedades

size: number

Devuelve el número de cookies en el mapa.

cookie-size.ts

console.log(cookies.size); // Número de cookies

Clase Cookie

Bun.Cookie representa una cookie HTTP con su nombre, valor y atributos.

cookie-class.ts

import { Cookie } from "bun";

// Crear una cookie básica
const cookie = new Bun.Cookie("name", "value");

// Crear una cookie con opciones
const secureSessionCookie = new Bun.Cookie("session", "abc123", {
  domain: "example.com",
  path: "/admin",
  expires: new Date(Date.now() + 86400000), // 1 día
  httpOnly: true,
  secure: true,
  sameSite: "strict",
});

// Analizar desde una cadena de cookie
const parsedCookie = new Bun.Cookie("name=value; Path=/; HttpOnly");

// Crear desde un objeto de opciones
const objCookie = new Bun.Cookie({
  name: "theme",
  value: "dark",
  maxAge: 3600,
  secure: true,
});

Constructores

constructors.ts

// Constructor básico con nombre/valor
new Bun.Cookie(name: string, value: string);

// Constructor con nombre, valor y opciones
new Bun.Cookie(name: string, value: string, options: CookieInit);

// Constructor desde una cadena de cookie
new Bun.Cookie(cookieString: string);

// Constructor desde un objeto de cookie
new Bun.Cookie(options: CookieInit);

Propiedades

cookie-properties.ts

cookie.name; // string - Nombre de la cookie
cookie.value; // string - Valor de la cookie
cookie.domain; // string | null - Ámbito de dominio (null si no se especifica)
cookie.path; // string - Ámbito de ruta URL (por defecto "/")
cookie.expires; // number | undefined - Marca de tiempo de expiración (ms desde epoch)
cookie.secure; // boolean - Requiere HTTPS
cookie.sameSite; // "strict" | "lax" | "none" - Configuración SameSite
cookie.partitioned; // boolean - Si la cookie está particionada (CHIPS)
cookie.maxAge; // number | undefined - Edad máxima en segundos
cookie.httpOnly; // boolean - Accesible solo vía HTTP (no JavaScript)

Métodos

isExpired(): boolean

Verifica si la cookie ha expirado.

is-expired.ts

// Cookie expirada (fecha en el pasado)
const expiredCookie = new Bun.Cookie("name", "value", {
  expires: new Date(Date.now() - 1000),
});
console.log(expiredCookie.isExpired()); // true

// Cookie válida (usando maxAge en lugar de expires)
const validCookie = new Bun.Cookie("name", "value", {
  maxAge: 3600, // 1 hora en segundos
});
console.log(validCookie.isExpired()); // false

// Cookie de sesión (sin expiración)
const sessionCookie = new Bun.Cookie("name", "value");
console.log(sessionCookie.isExpired()); // false

serialize(): string

toString(): string

Devuelve una representación en cadena de la cookie adecuada para un encabezado Set-Cookie.

serialize-cookie.ts

const cookie = new Bun.Cookie("session", "abc123", {
  domain: "example.com",
  path: "/admin",
  expires: new Date(Date.now() + 86400000),
  secure: true,
  httpOnly: true,
  sameSite: "strict",
});

console.log(cookie.serialize());
// => "session=abc123; Domain=example.com; Path=/admin; Expires=Sun, 19 Mar 2025 15:03:26 GMT; Secure; HttpOnly; SameSite=strict"
console.log(cookie.toString());
// => "session=abc123; Domain=example.com; Path=/admin; Expires=Sun, 19 Mar 2025 15:03:26 GMT; Secure; HttpOnly; SameSite=strict"

toJSON(): CookieInit

Convierte la cookie a un objeto simple adecuado para serialización JSON.

cookie-json.ts

const cookie = new Bun.Cookie("session", "abc123", {
  secure: true,
  httpOnly: true,
});

const json = cookie.toJSON();
// => {
//   name: "session",
//   value: "abc123",
//   path: "/",
//   secure: true,
//   httpOnly: true,
//   sameSite: "lax",
//   partitioned: false
// }

// Funciona con JSON.stringify
const jsonString = JSON.stringify(cookie);

Métodos estáticos

Cookie.parse(cookieString: string): Cookie

Analiza una cadena de cookie en una instancia Cookie.

parse-cookie.ts

const cookie = Bun.Cookie.parse("name=value; Path=/; Secure; SameSite=Lax");

console.log(cookie.name); // "name"
console.log(cookie.value); // "value"
console.log(cookie.path); // "/"
console.log(cookie.secure); // true
console.log(cookie.sameSite); // "lax"

Cookie.from(name: string, value: string, options?: CookieInit): Cookie

Método de fábrica para crear una cookie.

cookie-from.ts

const cookie = Bun.Cookie.from("session", "abc123", {
  httpOnly: true,
  secure: true,
  maxAge: 3600,
});

Tipos

types.ts

interface CookieInit {
  name?: string;
  value?: string;
  domain?: string;
  /** Por defecto '/'. Para permitir que el navegador establezca la ruta, usa una cadena vacía. */
  path?: string;
  expires?: number | Date | string;
  secure?: boolean;
  /** Por defecto `lax`. */
  sameSite?: CookieSameSite;
  httpOnly?: boolean;
  partitioned?: boolean;
  maxAge?: number;
}

interface CookieStoreDeleteOptions {
  name: string;
  domain?: string | null;
  path?: string;
}

interface CookieStoreGetOptions {
  name?: string;
  url?: string;
}

type CookieSameSite = "strict" | "lax" | "none";

class Cookie {
  constructor(name: string, value: string, options?: CookieInit);
  constructor(cookieString: string);
  constructor(cookieObject?: CookieInit);

  readonly name: string;
  value: string;
  domain?: string;
  path: string;
  expires?: Date;
  secure: boolean;
  sameSite: CookieSameSite;
  partitioned: boolean;
  maxAge?: number;
  httpOnly: boolean;

  isExpired(): boolean;

  serialize(): string;
  toString(): string;
  toJSON(): CookieInit;

  static parse(cookieString: string): Cookie;
  static from(name: string, value: string, options?: CookieInit): Cookie;
}

class CookieMap implements Iterable<[string, string]> {
  constructor(init?: string[][] | Record<string, string> | string);

  get(name: string): string | null;

  toSetCookieHeaders(): string[];

  has(name: string): boolean;
  set(name: string, value: string, options?: CookieInit): void;
  set(options: CookieInit): void;
  delete(name: string): void;
  delete(options: CookieStoreDeleteOptions): void;
  delete(name: string, options: Omit<CookieStoreDeleteOptions, "name">): void;
  toJSON(): Record<string, string>;

  readonly size: number;

  entries(): IterableIterator<[string, string]>;
  keys(): IterableIterator<string>;
  values(): IterableIterator<string>;
  forEach(callback: (value: string, key: string, map: CookieMap) => void): void;
  [Symbol.iterator](): IterableIterator<[string, string]>;
}