tiny-cookie

English | 简体中文

A tiny cookie manipulation plugin for browser.

Upgrade from 1.x to 2.x: You can check the CHANGELOG.md

If you're used tiny-cookie, then you may be interest in micell, a collection of functions focusing on web development.

Install

NPM:

1npm install tiny-cookie

Usage

ES2015 (recommended)

1// You can import all methods.
2import * as Cookies from 'tiny-cookie'
3
4// Or, you can import the methods as needed.
5import { isEnabled, get, set, remove } from 'tiny-cookie'
6
7// No alias required, just imports.
8import { isCookieEnabled, getCookie, setCookie, removeCookie } from 'tiny-cookie'

The tiny-cookie will expose an object Cookie on the global scope. Also, it can be as a CommonJS/AMD module (recommended).

APIs

isEnabled()

Alias: isCookieEnabled

Check if the cookie is enabled.

get(key)

Alias: getCookie

Get the cookie value with decoding, using decodeURIComponent.

getRaw(key)

Alias: getRawCookie

Get the cookie value without decoding.

getAll()

Alias: getAllCookies

Get all cookies with decoding, using decodeURIComponent.

set(key, value, options)

Alias: setCookie

Set a cookie with encoding the value, using encodeURIComponent. The options parameter is an object. And its property can be a valid cookie option, such as path(default: root path /), domain, expires/max-age, samesite or secure (Note: the secure flag will be set if it is an truthy value, such as true, or it will be not set). For example, you can set the expiration:

1import { setCookie } from 'tiny-cookie';
2
3const now = new Date;
4now.setMonth(now.getMonth() + 1);
5
6setCookie('foo', 'Foo', { expires: now.toGMTString() });

The expires property value can accept a Date object, a parsable date string (parsed by Date.parse()), an integer (unit: day) or a numeric string with a suffix character which specifies the time unit.

Unit suffix	Representation
Y	One year
M	One month
D	One day
h	One hour
m	One minute
s	One second

Examples:

1import { setCookie } from 'tiny-cookie';
2const date = new Date;
3
4date.setDate(date.getDate() + 21);
5
6setCookie('dateObject', 'A date object', { expires: date });
7setCookie('dateString', 'A parsable date string', { expires: date.toGMTString() });
8setCookie('integer', 'Seven days later', { expires: 7 });
9setCookie('stringSuffixY', 'One year later', { expires: '1Y' });
10setCookie('stringSuffixM', 'One month later', { expires: '1M' });
11setCookie('stringSuffixD', 'One day later', { expires: '1D' });
12setCookie('stringSuffixh', 'One hour later', { expires: '1h' });
13setCookie('stringSuffixm', 'Ten minutes later', { expires: '10m' });
14setCookie('stringSuffixs', 'Thirty seconds later', { expires: '30s' });

setRaw(key, value, options)

Alias: setRawCookie

Set a cookie without encoding.

remove(key, options)

Alias: removeCookie

Remove a cookie on the current domain. If you want to remove the parent domain's cookie, you can use the options parameter, such as remove('cookieName', { domain: 'parentdomain.com' }).

FAQ

1. How to use JSON as the encoder/decoder?

You can write your cookie get and set methods with JSON support easily:

1import { getCookie, setCookie } from 'tiny-cookie';
2
3export const getJSON = (key) => getCookie(key, JSON.parse);
4export const setJSON = (key, value, options) => setCookie(key, value, JSON.stringify, options);

License

MIT.