JavaScript Cookie

🍪 A simple, lightweight JavaScript API for handling browser cookies, it is easy to pick up and use, has a reasonable footprint (~2kb) (gzipped: 0.84kb), and has no dependencies. It should not interfere with any JavaScript libraries or frameworks.

Features:

🚀 Has no dependencies
🌱 Works in all browsers
🍁 Support TypeScript, including d.ts definition
🔥 Heavily tested
📦 Supports AMD/CommonJS
💥 cookie.min.js 2.01kb(gzipped: 0.84kb)

Usage

Installed via npm. You will need Node.js installed on your system.

$ npm install cookiejs --save

import cookie from 'cookiejs';

cookie("test", "tank", 1)

Or manually download and link cookiejs in your HTML, It can also be downloaded via UNPKG or jsDelivr CDN:

<script src="https://unpkg.com/cookiejs/dist/cookie.min.js"></script>
<script type="text/javascript">
  cookie("test", "tank", 1);
</script>

Basic Usage

cookie(key, value, num)

key cookie name
value cookie value
num expires time

cookie('test', 'tank', 1)    // Create a cookie that expires 1 days from now
cookie('test')               // Create a cookie, valid across the entire site
cookie('test', null)         // Delete cookie `test`
cookie()                     // Get all cookie

cookie.set('test', 'tank', 1) // ====cookie('test', 'tank', 1)
cookie.get('test')            // ====cookie('test')
cookie.remove('test')         // ====cookie('test',null)
cookie.remove('test3', 'test4') // Delete cookie `test3` and `test4`

cookie.clear()                // Clean all cookie
cookie.all()                  // Get all cookie

Set Cookie

cookie.set(name, value, options)
The same effect cookie(name, value, options)

Set the value of the cookie in batches

cookie.set({
  name1: 'value1',
  name2: 'value2'
});

Create cookie that expires 30 days from now

cookie('test', 'tank', 30);  // Create a cookie that expires 30 days from now

cookie({ 'test':'123', 'test2':'456' }, { // 批量设置
  'expires': 30,
  'path': '/',
  'domain':''
});

Create cookie that expires 30 days from now，and set cookie attributes

cookie('test', '123', { 'expires': 30, 'path': '/', 'domain':'' });

Cookie Attributes

individually for each call to cookie.set(...) by passing a plain object in the last argument. Per-call attributes override the default attributes.

Examples:

cookie('name', 'value', { 'expires': 30, 'path': '/', 'domain':'' });
cookie.get('name')
cookie.remove('name')

expires

Define when the cookie will be removed. Value can be a Number which will be interpreted as days from time of creation or a Date instance. If omitted, the cookie becomes a session cookie.

cookie('name', 'value', { 'expires': 30 });

path

Default: /

A String indicating the path where the cookie is visible.

cookie.set('name', 'value', { path: '' });
cookie.get('name'); // => 'value'

domain

Default: Cookie is visible only to the domain or subdomain of the page where the cookie was created, except for Internet Explorer (see: Note regarding Internet Explorer default behavior).
⚠️If you omit the domain attribute, it will be visible for a subdomain in IE.

A String indicating a valid domain where the cookie should be visible. The cookie will also be visible to all subdomains.

Examples:

cookie.set('name', 'value', { domain: 'subdomain.website.com' });
cookie.get('name'); // => undefined (need to read at 'subdomain.website.com')

secure

Default: No secure protocol requirement.

Either true or false, indicating if the cookie transmission requires a secure protocol (https).

Examples:

cookie.set('name', 'value', { secure: true });
cookie.get('name'); // => 'value'
cookie.remove('name');

License

Licensed under the MIT License.