tough-cookie.cookie.parse.md

Home > tough-cookie > Cookie > parse

Cookie.parse() method

Parses a string into a Cookie object.

Signature:

static parse(str: string, options?: ParseCookieOptions): Cookie | undefined;

Parameters

Parameter	Type	Description
str	string	The Set-Cookie header or a Cookie string to parse.
options	ParseCookieOptions	(Optional) Configures strict or loose mode for cookie parsing

Returns:

Cookie | undefined

Remarks

Note: when parsing a Cookie header it must be split by ';' before each Cookie string can be parsed.

Example 1

// parse a `Set-Cookie` header
const setCookieHeader = 'a=bcd; Expires=Tue, 18 Oct 2011 07:05:03 GMT'
const cookie = Cookie.parse(setCookieHeader)
cookie.key === 'a'
cookie.value === 'bcd'
cookie.expires === new Date(Date.parse('Tue, 18 Oct 2011 07:05:03 GMT'))

Example 2

// parse a `Cookie` header
const cookieHeader = 'name=value; name2=value2; name3=value3'
const cookies = cookieHeader.split(';').map(Cookie.parse)
cookies[0].name === 'name'
cookies[0].value === 'value'
cookies[1].name === 'name2'
cookies[1].value === 'value2'
cookies[2].name === 'name3'
cookies[2].value === 'value3'