Skip to main content

Class: CookieHelper

Class to help with cookie operations.

Constructors​

Constructor​

new CookieHelper(): CookieHelper

Returns​

CookieHelper

Properties​

CLASS_NAME​

readonly static CLASS_NAME: string

Runtime name for the class.

Methods​

createCookie()​

static createCookie(cookieName, cookieValue, options?): string

Create a cookie string.

Parameters​

cookieName​

string

The name of the cookie.

cookieValue​

string

The value of the cookie.

options?​

Additional cookie options.

secure?​

boolean

Should this be a secure cookie.

httpOnly?​

boolean

Should this be an http only cookie.

sameSite?​

"Strict" | "Lax" | "None"

The same site option for the cookie.

path?​

string

The path for the cookie.

Returns​

string

The created cookie string.

deleteCookie()​

static deleteCookie(cookieName, options?): string

Create a cookie string which will delete a cookie.

Parameters​

cookieName​

string

The name of the cookie.

options?​

Additional cookie options.

secure?​

boolean

Should this be a secure cookie.

httpOnly?​

boolean

Should this be an http only cookie.

sameSite?​

"Strict" | "Lax" | "None"

The same site option for the cookie.

path?​

string

The path for the cookie.

Returns​

string

The created cookie string.

getCookieFromHeaders()​

static getCookieFromHeaders(headers, cookieName): string | undefined

Get cookies from headers.

Parameters​

headers​

string | string[] | undefined

The headers to get cookies from.

cookieName​

string

The name of the cookie to get.

Returns​

string | undefined

The cookies found in the headers.