import HttpCookies from 'ievv_jsbase/lib/http/HttpCookies'

public class | source

HttpCookies

Makes working with document.cookie easy.

Example:

Get a cookie named "name"

import HttpCookies from 'ievv_jsbase/http/HttpCookies';
let cookies = HttpCookies();
let name = cookies.get('name');

Get a cookie named "pageurl", with a fallback

import HttpCookies from 'ievv_jsbase/http/HttpCookies';
let cookies = HttpCookies();
let name = cookies.get('pageurl', 'http://example.com');

Get a cookie named "name" in strict mode

import HttpCookies from 'ievv_jsbase/http/HttpCookies';
import {HttpCookieNotFoundError} from 'ievv_jsbase/http/HttpCookies';
let cookies = HttpCookies();
try {
    let name = cookies.getStrict('name');
} catch(e) {
    if(e instanceof HttpCookieNotFoundError) {
        console.error('Cookie not found', e);
    } else {
        throw e;
    }
}

Constructor Summary

Public Constructor
public	constructor(rawCookies: string)

Member Summary

Public Members
public	cookies: *
public	rawCookies: *

Method Summary

Public Methods
public	contains(cookieName: string): boolean Check if a cookie is among the parsed cookies.
public	get(cookieName: string, fallback: *): string Get cookie value.
public	getStrict(cookieName: string): string Get cookie value and throw exception if it is not found.

Public Constructors

public constructor(rawCookies: string) source

Params:

Name	Type	Attribute	Description
rawCookies	string		Raw cookies string. This is optional - it defaults to `document.cookie`.

Public Members

public cookies: * source

public rawCookies: * source

Public Methods

public contains(cookieName: string): boolean source

Check if a cookie is among the parsed cookies.

Params:

Name	Type	Attribute	Description
cookieName	string		The name of the cookie to look for.

Return:

boolean

true if the cookie is among the parsed cookies.

public get(cookieName: string, fallback: *): string source

Get cookie value.

Params:

Name	Type	Attribute	Description
cookieName	string		The name of the cookie.
fallback	*		Fallback value if the cookie with the provided `cookieName` does not exist. Defaults to `undefined`.

Return:

string

The cookie value, or the fallback value if no cookie with the provided cookieName is found.

public getStrict(cookieName: string): string source

Get cookie value and throw exception if it is not found.

Params:

Name	Type	Attribute	Description
cookieName	string		The name of the cookie.

Return:

string

The cookie value.

Throw:

HttpCookieNotFoundError

If no cookie named cookieName is found.