A library of useful functions to ease working with cookies.
JavaScript HTML CSS
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist
src
test
README.md
gulpfile.js
index.html
package.json

README.md

useful.cookies.js: Cookies Library

A library of useful functions to ease working with cookies.

Try the tests.

How to include the script

This include can be added to the header or placed inline before the script is invoked.

<script src="./js/useful-cookies.js"></script>

To enable the use of HTML5 tags in Internet Explorer 8 and lower, include html5.js.

<!--[if lte IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->

How to control the script

load

value = useful.cookies.load(name);

Retrieves a value from a cookie.

name : {string} - Name of a parameter stored as a cookie.

value : {string} - Returned value of the named parameter stored as a cookie.

save

useful.cookies.save(name, value, expires, path, domain, secure);

Saves a name-value pair to a cookie.

name : {string} - Name of a parameter stored as a cookie.

value : {string} - Value to be stored as a cookie.

expires : {object} - A date object setting the expiration date of the cookie.

path : {string} - URL path for which the cookie is valid.

domain : {string} - Domain for which the cookie is valid.

secure : {boolean} - Specifies if the cookie is supposed to be secure.

clear

useful.cookies.clear(name, path, domain);

Clears a name-value pair from a cookie.

name : {string} - Name of a parameter stored as a cookie.

path : {string} - URL path for which the cookie is valid.

domain : {string} - Domain for which the cookie is valid.

How to build the script

This project uses node.js from http://nodejs.org/

This project uses gulp.js from http://gulpjs.com/

The following commands are available for development:

  • npm install - Installs the prerequisites.
  • gulp import - Re-imports libraries from supporting projects to ./src/libs/ if available under the same folder tree.
  • gulp dev - Builds the project for development purposes.
  • gulp prod - Builds the project for deployment purposes.
  • gulp watch - Continuously recompiles updated files during development sessions.
  • gulp serve - Serves the project on a temporary web server at http://localhost:8000/ .

How to test the script

These test uses Selenium from http://docs.seleniumhq.org/

  • npm install webdriverjs - Installs the webdriver prerequisite.
  • npm install mocha -g - Installs the prerequisite test framework.
  • java -jar /Applications/Selenium/selenium-server-standalone-2.42.2.jar - Starts Selenium.
  • mocha - Runs the automated tests.

License

This work is licensed under a Creative Commons Attribution 3.0 Unported License. The latest version of this and other scripts by the same author can be found at http://www.woollymittens.nl/