English | 中文

cookie-utils-js

A simple JavaScript API for handling cookies.

Install

$ npm i cookie-utils-js
# or
$ yarn add cookie-utils-js

Usage

import Cookie from 'cookie-utils-js';

Cookie.set('foo', 'bar');

API & Example

1. Create cookies: Cookie.set(...)

• Create a cookie:

  Cookie.set('foo', 'bar');
  // or
  Cookie.set({ name: 'foo', value: 'bar', ... });

• Batch creation:

  Cookie.set([
    { name: 'foo1', value: 'bar1' },
    { name: 'foo2', value: 'bar2' }
  ]);

• Set expires for cookie: Date | number(ms), you can also set other options like: path, domain ... :

  Cookie.set('foo', 'bar', { expires: 7 * 1000, path: '/' });
  // or
  Cookie.set({ name: 'foo', value: 'bar', expires: 7 * 1000, path: '/' });

2. Get cookies: Cookie.get(...)

• Get all cookies with current path and return them as json:

  Cookie.get(); // => { foo: 'bar' }

• Get value by name:

  Cookie.get('foo'); // => 'bar'

• Get values by names and return them as json:

  Cookie.get(['foo1', 'foo2']); // => { foo1: 'bar1', foo2: 'bar2' }

• Get cookies and return a json, alias will replace name as new key:

  Cookie.get([
    { name: 'foo1' }, 
    { name: 'foo2', alias: 'FOO2' } // set alias
  ]); // => { foo1: 'bar1', FOO2: 'bar2' }

3. Remove cookies: Cookie.remove(...)

• Remove a cookie:

  Cookie.remove('foo');
  // or
  Cookie.remove('foo', '/'); // remove with path: Cookie.remove(name, path)

• Batch remove:

  Cookie.remove(['foo1', 'foo2']);
  // or
  Cookie.remove([
    { name: 'foo1' },
    { name: 'foo2', path: '/' } // remove with path
  ]);

4. Clear cookies: Cookie.clear()

Clear all cookies (attn: only cookies with current path(default: '/') are supported).

5. Browser settings: Cookie.browserEnabled

Whether the browser has enabled cookies. (true/false)