Skip to main content

Filter object whose properties will be matched against all cookies to be retrieved.

Properties (6)

Property Type Default Required Description
domain⚓︎ string x x

Retrieves the cookies whose domains match or are subdomains of the specified domain.

name⚓︎ string x x

Filters the cookies by name.

path⚓︎ string x x

Retrieves the cookies whose paths match the specified path.

secure⚓︎ boolean x x

Filters cookies by their Secure attribute.

session⚓︎ boolean x x

If true, will return only the session cookies. If false, will return only the persistent cookies.

url⚓︎ string x x

Retrieves the cookies which are associated with the specified URL. If not specified, will retrieve the cookies for all URLs.