Home Reference Source

import Cookie from 'chrome-remote-interface-extra/lib/network/Cookie.js'

public class | since chrome-remote-interface-extra | source

Cookie

An abstraction around using the CDP and Cookies

Static Method Summary

Static Public Methods
public static	fromString(cookieString: string, networkManager: NetworkManager, additionalProps: Object): Cookie Creates a new Cookie from the supplied string

Constructor Summary

Public Constructor
public	constructor(cookie: CDPCookie, networkManager: NetworkManager)

Member Summary

Private Members
private	_cookie: CDPCookie
private	_networkManager: NetworkManager

Method Summary

Public Methods
public	deleteCookie(forURL: string): Promise<void> Deletes this browser cookie by matching name and url or domain/path pair
public	domain(): string Cookie domain
public	expires(): number Cookie expiration date as the number of seconds since the UNIX epox
public	httpOnly(): boolean True if the cookie is http-only
public	async modifyCookie(modifications: CookieParam): Promise<boolean> Modifies this cookie with the given cookie data; may overwrite equivalent cookies if they exist
public	name(): string Cookie name
public	path(): string Cookie path
public	sameSite(): string Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies One of: Strict, Lax
public	secure(): boolean True if the cookie is secure (HTTPS)
public	session(): boolean True in case of session cookie
public	setCookie(): Promise<boolean>
public	size(): number The size of the cookie
public	toJSON(): CDPCookie
public	value(): string Cookie value

Static Public Methods

public static fromString(cookieString: string, networkManager: NetworkManager, additionalProps: Object): Cookie source

Creates a new Cookie from the supplied string

Params:

Name	Type	Attribute	Description
cookieString	string	nullable: false	String representation of a cookie 'name=value'
networkManager	NetworkManager	nullable: false
additionalProps	Object	optional	Additional values for the cookie if any

Return:

Public Constructors

public constructor(cookie: CDPCookie, networkManager: NetworkManager) source

Params:

Name	Type	Attribute	Description
cookie	CDPCookie	nullable: false
networkManager	NetworkManager	nullable: false

Private Members

private _cookie: CDPCookie source

private _networkManager: NetworkManager source

Public Methods

public deleteCookie(forURL: string): Promise<void> source

Deletes this browser cookie by matching name and url or domain/path pair

Params:

Name	Type	Attribute	Description
forURL	string	optional

Return:

See:

https://chromedevtools.github.io/devtools-protocol/tot/Network#method-deleteCookies

public domain(): string source

Cookie domain

Return:

public expires(): number source

Cookie expiration date as the number of seconds since the UNIX epox

Return:

public httpOnly(): boolean source

True if the cookie is http-only

Return:

public async modifyCookie(modifications: CookieParam): Promise<boolean> source

Modifies this cookie with the given cookie data; may overwrite equivalent cookies if they exist

Params:

Name	Type	Attribute	Description
modifications	CookieParam	nullable: false

Return:

Promise<boolean>

public name(): string source

Cookie name

Return:

public path(): string source

Cookie path

Return:

public sameSite(): string source

Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies One of: Strict, Lax

Return:

string (nullable: true)

public secure(): boolean source

True if the cookie is secure (HTTPS)

Return:

public session(): boolean source

True in case of session cookie

Return:

public setCookie(): Promise<boolean> source

Return:

Promise<boolean>

public size(): number source

The size of the cookie

Return:

public toJSON(): CDPCookie source

Return:

public value(): string source

Cookie value

Return: