jaaulde-cookies

Javascript library for accessing and manipulating HTTP cookies in the web browser

cookies

Javascript library for accessing and manipulating HTTP cookies in the web browser. Get one or a list of cookies, set cookies, delete cookies, test if the browser accepts cookies. When JSON support is available, any JS value can be set to a cookie--it will be automatically serialized before being written, and un-serialzied on read.

<script src="/path/to/jaaulde-cookies.js"></script>
bower install jaaulde-cookies
npm install jaaulde-cookies

This library is intended for use in the browser to access and manipulate cookies. It provides a singleton API, cookies, in the global namespace (window).

/**
 * test - test whether the browser is accepting cookies
 *
 * @access public
 * @static
 * @return {boolean}
 */
testfunction ()
var accepting_cookies = cookies.test(); // returns boolean 
/**
 * set - set or delete a cookie with desired options
 *
 * @access public
 * @static
 * @param {string} n - name of cookie to set
 * @param {mixed} v - Any JS value. If not a string and JSON support present will be JSON encoded
 *                  {null} to delete
 * @param {object} o - optional list of cookie options to specify
 * @return {void}
 */
setfunction (nvo)
// sets cookie by the name of 'myCookie' to value of 'myValue' with default options 
cookies.set('myCookie', 'myValue');
 
// sets cookie by the name of 'myCookie' to value of 'myValue' with path of '/somedir' 
cookies.set('myCookie', 'myValue', {path: '/somedir'});
/**
 * get - get one, several, or all cookies
 *
 * @access public
 * @static
 * @param {mixed} n {string} name of single cookie
 *                  {array} list of multiple cookie names
 *                  {void} if you want all cookies
 * @return {mixed} type/value of cookie as set
 *                 {null} if only one cookie is requested and is not found
 *                 {object} hash of multiple or all cookies (if multiple or all requested)
 */
getfunction (n)
// returns value of myCookie if it is present, null if not 
cookies.get('myCookie');
 
// returns array containing value of each requested cookie if it is present, null if not 
cookies.get(['myCookie', 'myOtherCookie']);
 
// returns array of all cookies from your site 
cookies.get();
/**
 * filter - get array of cookies whose names match the provided RegExp
 *
 * @access public
 * @static
 * @param {RegExp} p The regular expression to match against cookie names
 * @return {object} hash of cookies whose names match the RegExp
 */
filterfunction (p)
// returns list of cookies whose names start with "site" 
cookies.filter( /^site/ );

note: A cookie can only be deleted using the same options with which it was set

/**
 * del - delete a cookie (domain and path options must match those with which the cookie was set; this is really an alias for set() with parameters simplified for this use)
 *
 * @access public
 * @static
 * @param {mixed} n {string} name of cookie to delete
 *                  {boolean} true to delete all
 * @param {object} o optional list of cookie options to specify (path, domain)
 * @return {void}
 */
delfunction (no)
// deletes a cookie, 'myCookie', with default options 
cookies.del('myCookie');
 
// deletes a cookie by the name of 'myCookie' which had been set with a path of '/somedir' 
cookies.del('myCookie', {path: '/somedir'});
 
// deletes all cookies 
cookies.del(true);
OptionDescriptionDefaultNote
domainDomain for which the cookie be availablenull (current domain)
pathPath for which the cookie be available'/'
expiresDate object representing expiration date/time of cookienull (expires when browser closes)Setting a past date/time will delete the cookie
secureShould cookie be sent to server via HTTPS only?false