tough-cookie

Synopsis

Installation

Node.js Version Support

API

tough

`parseDate(string)`

`formatDate(date)`

`canonicalDomain(str)`

`domainMatch(str, domStr[, canonicalize=true])`

`defaultPath(path)`

`pathMatch(reqPath, cookiePath)`

`parse(cookieString[, options])`

`fromJSON(string)`

`getPublicSuffix(hostname)`

`cookieCompare(a, b)`

`permuteDomain(domain)`

`permutePath(path)`

Cookie

`Cookie.parse(cookieString[, options])`

Properties

`new Cookie([properties])`

`.toString()`

`.cookieString()`

`.setExpires(string)`

`.setMaxAge(number)`

`.expiryDate([now=Date.now()])`

`.TTL([now=Date.now()])`

`.canonicalizedDomain()`

`.cdomain()`

`.toJSON()`

`Cookie.fromJSON(strOrObj)`

`.clone()`

`.validate()`

CookieJar

`CookieJar([store][, options])`

`.setCookie(cookieOrString, currentUrl[, options][, callback(err, cookie)])`

`.setCookieSync(cookieOrString, currentUrl[, options])`

`.getCookies(currentUrl[, options][, callback(err, cookies)])`

`.getCookiesSync(currentUrl, [{options}])`

`.getCookieString(...)`

`.getCookieStringSync(...)`

`.getSetCookieStrings(...)`

`.getSetCookieStringsSync(...)`

`.serialize([callback(err, serializedObject)])`

`.serializeSync()`

`.toJSON()`

`CookieJar.deserialize(serialized[, store][, callback(err, object)])`

`CookieJar.deserializeSync(serialized[, store])`

`CookieJar.fromJSON(string)`

`.clone([store][, callback(err, cloned))`

`.cloneSync([store])`

`.removeAllCookies([callback(err)])`

`.removeAllCookiesSync()`

Store

Store API

`store.findCookie(domain, path, key, callback(err, cookie))`

`store.findCookies(domain, path, allowSpecialUseDomain, callback(err, cookies))`

`store.putCookie(cookie, callback(err))`

`store.updateCookie(oldCookie, newCookie, callback(err))`

`store.removeCookie(domain, path, key, callback(err))`

`store.removeCookies(domain, path, callback(err))`

`store.removeAllCookies(callback(err))`

`store.getAllCookies(callback(err, cookies))`

MemoryCookieStore

Community Cookie Stores

Serialization Format

RFC 6265bis

Leave Secure Cookies Alone

SameSite Cookies

Cookie Prefixes

Copyright and License