/logni-cookie.js

Cookie javascript library for work with cookies (supporting LogNI logger)

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

npm version Codacy Badge Github Releases Build Status License: GPL v3

logni-cookie.js

Cookie javascript library for work with cookies (supporting LogNI logger)

How to install?

  • git (github)
  • node package manager

Install from Github

$ git clone https://github.com/erikni/logni-cookie.js.git
$ cd logni-cookie.js
$ npm install
$ npm run build

Install from Node package manager

$ npm i logni-cookie.js

Usage:

Add the local javascript file to head of HTML page:

<head>
  <script src="build/js/logni-cookie.min.js" type="text/javascript"></script>
</head>

ES5 support:

<head>
  <script src="build/js/logni-cookie-es5.min.js" type="text/javascript"></script>
</head>

or from Cloudflare CDN:

<head>
  <script src="https://live-jslib.logni.net/js/logni-cookie.min.js" type="text/javascript"></script>
</head>

Initialization

<script type="text/javascript">
  logniCookie.path = '/'; // set cookie path (optimal)
  logniCookie.domain = '.yourdomain.com'; // set cookie (sub)domain (optimal)
  logniCookie.expires = '10M'; // 10min expired (optimal)
</script>

Expired format:

You can specify a time unit after a time value 'X', such as XY, Xm, Xw, Xd, XH, XM or XS to represent:

  • Y: years
  • m: months
  • W: weeks
  • d: days
  • H: hours
  • M: minutes
  • S: seconds

Set cookie

<script type="text/javascript">
  cookieName = 'TEST1';
  cookieValue = 'AbC' + Math.random();

  logniCookie.set(cookieName, cookieValue, '2H', 'differentdomain.com'); // 2hour
  logniCookie.set(cookieName, cookieValue, '3w'); // 3 week
  logniCookie.set(cookieName, cookieValue, '10S'); // 10 second
  logniCookie.set(cookieName, cookieValue, 10); // 10 second (alias for '10s')
</script>

Read / remove cookie

<script type="text/javascript">
  logniCookie.get(cookieName);
  
  logniCookie.del(cookieName);
</script>

Test

test/cookie.html

Contribution

Pull Requests are very welcome.

Licence

GNU General Public License v3.0