Lupa API Reference / commands/types / Cookie

Interface: Cookie

Defined in: src/commands/types.ts:135

Shape of a cookie matching Playwright's format.

Use-when

Use when adding cookies via cookies.add or retrieving them via cookies.getAll.

Dont-use-when

Do not use for other storage mechanisms such as LocalStorage or SessionStorage.

Properties

domain?

optional domain?: string

Defined in: src/commands/types.ts:154

The domain of the cookie. Either url or both domain and path must be specified.

---

expires?

optional expires?: number

Defined in: src/commands/types.ts:164

Unix time in seconds representing the cookie's expiration.

---

httpOnly?

optional httpOnly?: boolean

Defined in: src/commands/types.ts:169

Whether the cookie is HTTP-only.

---

name

name: string

Defined in: src/commands/types.ts:139

The name of the cookie.

---

path?

optional path?: string

Defined in: src/commands/types.ts:159

The path of the cookie. Either url or both domain and path must be specified.

---

sameSite?

optional sameSite?: "Lax" | "Strict" | "None"

Defined in: src/commands/types.ts:179

SameSite attribute value.

---

secure?

optional secure?: boolean

Defined in: src/commands/types.ts:174

Whether the cookie is secure (HTTPS-only).

---

url?

optional url?: string

Defined in: src/commands/types.ts:149

The URL associated with the cookie. Either url or both domain and path must be specified.

---

value

value: string

Defined in: src/commands/types.ts:144

The value of the cookie.