crumble

Crumble

A simple utility that abstracts the legacy API that is document.cookie.

Usage

Boolean Crumble.isEnabled()

Determines whether the client has cookies enabled.

Boolean Crumble.has(string name)

Determines if a cookie exists.

String Crumble.get(string name)

Retrieves the value of a cookie. null will be returned if the cookie does not exist.

void Crumble.set(Object crumbs [, string value])

Sets a cookie.

The cookie crumbs you can provide are:

• name (String, required) - The name of the cookie.
• value (String, optional) - The value of the cookie. If set to undefined or null the cookie will be removed by forcing it to immediately expire, ignoring any age or expires crumb that may be provided.
• expires (Date|String|Number, optional) - The expiry date of the cookie, if omitted, the cookie will expire at the end of the session. You can provide a date object, date string or a timestamp. If provided a timestamp equivalent to Infinity the cookie will be set to expire with date: 31 Dec 9999 23:59:59 GMT.
• age (Number, optional) - The duration (in minutes) of which the cookie can live. When defined, any provided expiry date is ignored. If set to Infinity the cookie will be set to expire with date: 31 Dec 9999 23:59:59 GMT.
• path (String, optional) - The path of which the cookie will be sent. Defaults to /.
• domain (String, optional) - The (sub)domain of which the cookie will be sent. The domain can only be a domain that the current document is in, however cookies can cross subdomains. If set to . the domain will be set to the root domain of the document. Defaults to the domain of the document (i.e. the value of document.cookie).
• secure (Boolean, optional) - Indicates whether the cookie should only be passed over HTTPS connections. Defaults to false.

Example usage:

Crumble.set(
{
	name : 'name',
	value : 'value',
	domain : 'a.domain.com',
	path : '/a/document/path',
	secure : false
});

Alternatively you can separate the value from the cookie crumbs, like so:

Crumble.set(
{
	name : 'name',
	domain : 'a.domain.com',
	path : '/a/document/path',
	secure : false

}, 'value');

This is useful as the value is usually the variable when setting a cookie whereas the other cookie crumbs are usually fixed.

void Crumble.remove(Object crumbs)

Removes a cookie by forcing it to immediately expire.

The cookie crumbs you can provide are:

• name (String, required) - The name of the cookie.
• path (String, optional) - The path of which the cookie will be sent. Defaults to /.
• domain (String, optional) - The (sub)domain of which the cookie will be removed from. The domain can only be a domain that the current document is in, however cookies can cross subdomains. If set to . the cookie will be removed from the root domain of the document. Defaults to the domain of the document (i.e. the value of document.cookie).
• secure (Boolean, optional) - Indicates whether the cookie should only be removed over HTTPS connections. Defaults to false.

Example usage:

Crumble.remove(
{
	name : 'name'
});

The above is just a more expressive way of doing the following:

Crumble.set(
{
	name : 'name',
	value : null
});

Getting started

To use Crumble, just use a script tag like so:

<script type="text/javascript" src="path/to/Crumble.js"></script>

To remove Crumble from the global namespace, you can use Crumble.noConflict(), like so:

Namespace.Crumble = Crumble.noConflict();

Crumble is wrapped using the Universal Module Definition (UMD), so it also works in both CommonJS and AMD environments. It's also available through the Node Package Manage, so you can install Crumble like so:

npm install crumble

Development

Grunt is used to handle the build process for Crumble. To perform a full build, use the build task:

grunt build

which is just an alias for the default task:

grunt

To only check code quality and/or run unit tests use the test task:

grunt test

License

Crumble is released under the MIT License.