Classes

• _global_
• atropa
• atropa.ArgsInfo
• atropa.arrays
• atropa.Babbler
• atropa.CookieMonster
• atropa.CreateHtmlDocumentsFromXmlhttp
• atropa.customErrors
• atropa.customErrors.InvalidArgumentTypesError
• atropa.data
• atropa.HTMLParser
• atropa.inject
• atropa.inquire
• atropa.objects
• atropa.random
• atropa.regex
• atropa.regex.patterns
• atropa.Requester
• atropa.SerialActor
• atropa.string
• atropa.TextAnalyzer
• atropa.url
• atropa.waitFor
• atropa.wtf
• atropa.xpath

Class atropa.CookieMonster

Version 20130223.
This represents a cookie handler
Defined in: <node_modules/atropa-CookieMonster/src/atropa-CookieMonster.js>.

// cookie object
var cookieObj = {"key" : "cookieName", "val" : "cookieVal"}
// cookie string 
var cookieString = cookieName=cookieVal;

var cookieMonster = new atropa.CookieMonster();
// creating a cookie
cookieMonster.setCookie('atropa', 'hial atropa!!');
console.log(document.cookie);

// getting a cookie object
var cookieObj = cookieMonster.getCookie('atropa');
console.log(cookieObj);

// convert the cookie object to a string
console.log(cookieMonster.bakeCookie(cookieObj));

Parameters:

{Object} cookieObj

A cookie object

Returns:

{String} Returns a cookie string.

var cookieMonster = new atropa.CookieMonster();
var cookieObj = cookieMonster.cookie2obj('atropa=hial atropa!!;');
console.log(cookieObj);

Parameters:

{String} cookie

A cookie represented as a string cookieName=cookieVal;

Returns:

{cookieObj} Returns a cookie object.

var cookieMonster = new atropa.CookieMonster();
// creating the cookie to delete
cookieMonster.setCookie('atropa', 'hial atropa!!');
console.log(document.cookie);
// delete a cookie
cookieMonster.deleteCookie('atropa');
console.log(document.cookie);

Parameters:

{String} whichKey

The cookies key (name) that will be deleted.

var cookieMonster = new atropa.CookieMonster();
// creating the cookie to delete
cookieMonster.setCookie('atropa', 'hial atropa!!');
console.log(document.cookie);
// delete a cookie
cookieMonster.deleteCookieObj(
    {key : 'atropa', val : 'does not matter'});
console.log(document.cookie);

Parameters:

{cookieObj} cookieObj

A cookie object.

var cookieMonster = new atropa.CookieMonster();
// creating a cookie
cookieMonster.setCookie('atropa', 'hial atropa!!');
console.log(document.cookie);
// get a specific cookie
var cookieObj = cookieMonster.getCookie('atropa');
console.log(cookieObj.key);
console.log(cookieObj.val);

Parameters:

{String} whichKey

The cookies key (name)

Returns:

{cookieObj|false} Returns a cookie object if a cookie with the specified key is found or false if it is not found.

var cookieMonster = new atropa.CookieMonster();
// creating a cookie
cookieMonster.setCookie('atropa', 'hial atropa!!');
// get all cookie objects in an array
console.log(cookieMonster.getCookies());

Returns:

{Array} An array whose elements are cookie objects.

var cookieMonster = new atropa.CookieMonster();
// creating a few cookies
cookieMonster.setCookie('atropa', 'hial atropa!!');
cookieMonster.setCookie('katjii', 'munching');
console.log(document.cookie);

// filter cookies
function cookieFilter(cookieObj, cookieValue) {
    if(cookieObj.val === cookieValue) {
        return true;
    } else {
        return false;
    }
}
var cookieObjArray = cookieMonster.inspectCookies(
    cookieFilter, 'munching');
console.log(cookieObjArray);

Parameters:

{function} callback

The callback function will be passed two arguments. The first is a cookie object from the current document. The second argument is the value supplied for args if the callback function returns true then the cookie object will be included in the return results.

{Array} args

Arguments to pass to the callback function.

Returns:

{Array} An array of cookie objects.

var cookieMonster = new atropa.CookieMonster();
// set a cookie
cookieMonster.setCookie('atropa', 'hial');
console.log(document.cookie);

Parameters:

{String} whichKey

The key (name) of the new cookie

{String} setTo

The value of the new cookie.

var cookieMonster = new atropa.CookieMonster();
// set a cookie
cookieMonster.setCookieObj({key : 'atropa', val : 'hial atropa!!'});
console.log(document.cookie);

Parameters:

{cookieObj} cookieObj

A cookie object.