Class: CookieJar

Methods

add(data, url, options)

Add a cookie to the cookie jar

Parameters:

Name	Type	Description
data	String | Object	can be a Cookie|json object or a set-cookie header string
url	String
options	Object	[optional]

Source:

• cookie-jar.js

getCookieHeaderString(url, options) → {String}

Get HTTP Cookie header string

Parameters:

Name	Type	Description
url	String
options	Object	[optional]

Source:

• cookie-jar.js

Returns:

HTTP Cookie header string

Type

String

getCookies(url, options) → {Array}

Get cookies that match the given properties

Parameters:

Name	Type	Description
url	String
options	Object	[optional]

Source:

• cookie-jar.js

Returns:

array of Cookie objects

Type

Array

remove(url, key)

Remove a cookie by name for a given domain. If the key then all cookies for the given domain and path (if given) will be removed. Note: when cookies are added without a path specified the default path is "/" in accordance with http://tools.ietf.org/search/rfc6265#section-5.1.4 - so you should use that for the path param when appropriate.

Parameters:

Name	Type	Description
url	String
key	String

Source:

• cookie-jar.js

toJSON() → {Object}

Get cookie jar as a JSON object

Source:

• cookie-jar.js

Returns:

Type

Object