cookiezzz v1.1.4

Cookiezzz

A simple & lightweight library for working with cookies written on pure JavaScript. Supports simple working with json objects.

Why us?

• Simple & lightweight
• Works with JSON from the box (returns JSON object if necessary, sets JSON cookie automatically)
• You can specify any parameter while setting cookie
• Works with all browsers (Including ES6!)
• Written on pure JS (no dependencies)
• Has minified version
• Can be installed by npm

Note:

This is a fork of cookie.js project (https://github.com/UnSstrennen/cookie.js) for publish workful version to npm registry. The only reason to create this fork is that original repository`s author does not publish actual version to npm registry for long time. It is impossible to use original with webpack due to module.exports bug. Hope that https://github.com/UnSstrennen will improve this soon.

Installation

1. npm package manager

npm i cookiez

2. Build from source

Go to /src folder of GitHub page and download main or minified version of script. Then, include script to your HTML page using

<script src="../path/to/your/scripts/folder/cookie.min.js"></script>

Usage

Import functions:

import {setCookie, getCookie, deleteCookie} from 'cookiez';

Create a session cookie:

setCookie('name', 'value');  // string cookie
setCookie('name', {key: 'value'});  // json cookie

Create an expiring cookie:

setCookie('name', 'value', {expires: new Date('2020-10-10 03:00:00')});  // string
setCookie('name', {key: 'value'}, {expires: new Date('2020-10-10 03:00:00')});  // json

Don't forget that JSON format supports only double quotes.

With setCookie() function, you can specify any cookie options you want. You can find options table there.

Get a cookie:

getCookie('name')  // string cookies
getCookie('name', true)  // json cookie, returns json object

Delete a cookie:

deleteCookie('name');  // json or string cookie: no matter!

Setting cookie options

For setting a cookie option, call setCookie(name, value, dict) function filling dict parameter as dictionary.

Keys & values list:

• path (str) - URL, for which this cookie is available (must be absolute!)
• domain (str) - domain, for which this cookie is available
• expires (Date object) - expiration date&time of cookie
• max-age (int) - cookie lifetime in seconds (alternative for expires option)
• secure (bool) - if true, cookie will be available only for HTTPS. IT CAN'T BE FALSE
• samesite (str) - XSRF protection setting. Can be strict or lax. Read this article for details.
• httpOnly (bool) - if true, cookie won't be available for using in JavaScript. IT CAN'T BE FALSE