package
Parses set-cookie headers into objects
npm install set-cookie-parserGitHub-flavored package documentation.
Across all versions, last 30 days.
383,964,993 in 30 days
Runtime metadata.
Tagged topics.
Estimated unpacked size across 1 packages.
30.7 kB
Includes dependencies.
Parses set-cookie headers into JavaScript objects
Accepts a single set-cookie header value, an array of set-cookie header values, a Node.js response object, or a fetch() Response object that may have 0 or more set-cookie headers.
Returns either an array of cookie objects or a map of name => cookie object with options set to {map: true}. Each cookie object will have name and value properties, and may have additional properties depending on the set-cookie header:
name - cookie name (string)value - cookie value (string)path - URL path to limit the scope to (string or undefined)domain - domain to expand the scope to (string or undefined, may begin with "." to indicate the named domain or any subdomain of it)expires - absolute expiration date for the cookie (Date object or undefined)maxAge - relative expiration time of the cookie in seconds from when the client receives it (integer or undefined)
maxAge by 1000 to convert to milliseconds.secure - indicates cookie should only be sent over HTTPs (true or undefined)httpOnly - indicates cookie should not be accessible to client-side JavaScript (true or undefined)sameSite - indicates if cookie should be included in cross-site requests (more info) (string or undefined)
"Strict", "Lax", and "None", but set-cookie-parser copies the value verbatim and does perform any validation.(The output format is loosely based on the input format of https://www.npmjs.com/package/cookie)
Unknown attributes are added to the object automatically unless there's a conflict, in which case a warning is logged. (See Errors and Warnings section below.)
$ npm install --save set-cookie-parserimport * as http from 'node:http';
import { parseSetCookie } from 'set-cookie-parser';
// or const { parseSetCookie } = require('set-cookie-parser');
http.get('http://example.com', function(res) {
const cookies = parseSetCookie(res, {
decodeValues: true // default: true
});
cookies.forEach(console.log);
}Example output:
[
{
name: 'bam',
value: 'baz'
},
{
name: 'foo',
value: 'bar',
path: '/',
expires: new Date('Tue Jul 01 2025 06:01:11 GMT-0400 (EDT)'),
maxAge: 1000,
domain: '.example.com',
secure: true,
httpOnly: true,
sameSite: 'lax'
}
]import * as http from 'node:http';
import { parseSetCookie } from 'set-cookie-parser';
// or const { parseSetCookie } = require('set-cookie-parser');
http.get('http://example.com', function(res) {
const cookies = parseSetCookie(res, {
decodeValues: true, // default: true
map: true // default: false
});
const desiredCookie = cookies['session'];
console.log(desiredCookie);
});Example output:
{
bam: {
name: 'bam',
value: 'baz'
},
foo: {
name: 'foo',
value: 'bar',
path: '/',
expires: new Date('Tue Jul 01 2025 06:01:11 GMT-0400 (EDT)'),
maxAge: 1000,
domain: '.example.com',
secure: true,
httpOnly: true,
sameSite: 'lax'
}
}This library can be used in conjunction with the cookie library to modify and replace set-cookie headers:
import * as libCookie from 'cookie';
import { parseSetCookie } from 'set-cookie-parser';
// or const { parseSetCookie } = require('set-cookie-parser');
function modifySetCookie(res){
// parse the set-cookie headers with this library
const cookies = parseSetCookie(res);
// modify the cookies here
// ...
// create new set-cookie headers using the cookie library
res.headers['set-cookie'] = cookies.map(function(cookie) {
return libCookie.serialize(cookie.name, cookie.value, cookie);
});
}See a real-world example of this in unblocker
Parses cookies from a string, array of strings, or a http response object.
Always returns an array, regardless of input format. (Unless the map option is set, in which case it always returns an object.)
Also accepts an optional options object. Defaults:
{
decodeValues: true, // Calls decodeURIComponent on each value - default: true
map: false, // Return an object instead of an array - default: false
silent: false, // Suppress various warnings and errors that would otherwise be logged
split: 'auto', // Separate combined cookie headers. Valid options are true/false/'auto'. 'auto' splits strings but not arrays.
}The library detects and logs (via console.warn() and console.error()) a variety of conditions, including:
parseSetCookie on a request object with a Cookie: header rather than a Set-Cookie: header.
decodeURIComponent() on the value fails.
options.decodeValues=false to prevent automatic decoding.__proto__.
name or value (because these would overwrite the actual name and value), or something like __proto__.
expires or max-age time that cannot be parsed
Setting options.silent=true suppresses these and future warnings without changing the behavior of the library.
MIT © Nathan Friedly
partitioned - indicates cookie should be scoped to the combination of 3rd party domain + top page domain (more info) (true or undefined)