@types/set-cookie-parser

Parsing Set-Cookie headers

This feature allows you to parse the content of Set-Cookie headers from an HTTP response and convert them into an array of cookie objects with TypeScript type definitions.

import setCookieParser from 'set-cookie-parser';
import { Cookie } from 'set-cookie-parser';

const setCookieHeader = 'sessionToken=abc123; Path=/; HttpOnly';
const cookies: Cookie[] = setCookieParser.parse(setCookieHeader);

Parsing Set-Cookie headers with options

This feature allows you to parse the Set-Cookie headers with additional options, such as mapping the resulting array into an object keyed by cookie names, while maintaining TypeScript type safety.

import setCookieParser from 'set-cookie-parser';
import { Cookie } from 'set-cookie-parser';

const setCookieHeader = 'sessionToken=abc123; Path=/; HttpOnly';
const options = { map: true };
const cookies: { [cookieName: string]: Cookie } = setCookieParser.parse(setCookieHeader, options);

Splitting Set-Cookie headers

This feature allows you to split a Set-Cookie header string or an array of Set-Cookie header strings into an array of individual cookie strings.

import setCookieParser from 'set-cookie-parser';

const setCookieHeaders = [
  'sessionToken=abc123; Path=/; HttpOnly',
  'userId=12345; Path=/; Secure'
];
const splitCookies: string[] = setCookieParser.splitCookiesString(setCookieHeaders);