@mherod/get-cookie v4.2.2

---

Function: getCookie()

getCookie(cookieSpec): Promise<ExportedCookie[]>

Defined in: src/core/cookies/getCookie.ts:31

Retrieves browser cookies that match the specified cookie name and domain criteria. This function provides a way to search and filter cookies based on given specifications.

Parameters

cookieSpec

The cookie specification containing search criteria

domain

string = CookieDomainSchema

(optional) The domain to filter cookies by

name

string = CookieNameSchema

The name of the cookie to search for

Returns

Promise<ExportedCookie[]>

An array of ExportedCookie objects that match the specification

Throws

Will catch and handle any errors during cookie querying, logging a warning to the console without throwing to the caller

Example

import { getCookie } from "@mherod/get-cookie";

// Get all cookies named "sessionId"
const cookies = await getCookie({ name: "sessionId" });
// Returns: [{ name: "sessionId", value: "abc123", domain: ".example.com", ... }]

// Get cookies named "userPref" from specific domain
const domainCookies = await getCookie({
  name: "userPref",
  domain: "example.com"
});
// Returns: [{ name: "userPref", value: "darkMode", domain: "example.com", ... }]