IOP-CookieMaster.js

A simple and concise library for working with Cookies in JavaScript. Now with JSON's supporting!

Why us?

• Easy to install and use
• 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
• Written on pure JS (no dependencies)
• Has minified version
• Can be installed by npm or used by unpkg CDN

Installations

1. NPM package manager

Through the terminal, run the following command in the root folder of the project:

npm i iop-cookiemaster

In .js files, use import with the desired module path:

import {Cookie} from './node_modules/iop-cookiemaster.js/src/iop-cookiemaster.js';

Don't forget that the .js file must be included as a module:

<script src="index.js" type="module"></script>

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/iop-cookiemaster.js"></script>

Usage

Create a session Cookie:

Cookie.set('cookieName', 'cookieValue');  // string Cookie
Cookie.set('user', {name: 'Alex', age: 18});  // JSON Cookie

Create a Cookie with options:

// Expiring string Cookie
Cookie.set('cookieName', 'cookieValue', {expires: new Date('2020-10-10 03:00:00')});
// Expiring JSON Cookie
Cookie.set('cookieName', {key: 'value'}, {expires: new Date('2020-10-10 03:00:00')});

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

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

Get a cookie:

Cookie.get('cookieName')  // string cookies
Cookie.get('cookieName', true)  // JSON cookie, returns json object

Delete a cookie:

Cookie.delete('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 (string) - URL prefix of the path, Cookies will be available for pages under this path;
• domain (string) - the domain determines where the Cookie is available;
• expires (Date or string) - the exact expiration date of the cookie when the browser will delete it automatically;
• max-age (number) - The expires alternative specifies the cookie's expiration date in seconds from the current moment;
• secure (none) - if set, disables the use of Cookies on alternative connection protocols;
• samesite (string) - security setting used to protect against the so-called XSRF attack;
• httpOnly (bool) - prevents any access to cookies from JavaScript.

License

This library is distributed under the ISC license. License text:

Copyright (c) 2024, IOPjolnir <[email protected]>.

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.