e2ed/types/http/cookie.d.ts

E2E testing framework over Playwright

import type { Brand } from '../brand';
/**
 * Cookie parameters object.
 */
export type Cookie = Readonly<{
    domain?: string;
    expires?: number;
    httpOnly?: boolean;
    name: string;
    path?: string;
    sameSite?: SameSite;
    secure?: boolean;
    value: string;
}>;
/**
 * Cookie's sameSite property.
 */
export type SameSite = 'Lax' | 'None' | 'Strict';
/**
 * Value of `cookie` (request) header for one or several cookies.
 * @example
 * maps_los=1; _ge=GA1.2.1967685687
 */
export type CookieHeaderString = Brand<string, 'CookieHeaderString'>;
/**
 * Value of `set-cookie` (response) header for single cookie.
 * @example
 * maps_los=1; expires=Tue, 07-Nov-2023 00:20:49 GMT; path=/; domain=.example.com; Secure; HttpOnly; SameSite=none
 */
export type SetCookieHeaderString = Brand<string, 'SetCookieHeaderString'>;