JavaScript Cookie

A simple, lightweight JavaScript API for handling browser cookies

Utils
js-cookie/js-cookiejs-cookie

README


JavaScript Cookie CI BrowserStack JavaScript Style Guide Code Climate npm size jsDelivr Hits


A simple, lightweight JavaScript API for handling cookies

- Works in all browsers
- Accepts any character
- Heavily tested
- No dependency
- Supports ES modules
- Supports AMD/CommonJS
- RFC 6265 compliant
- Useful Wiki
- Enable custom encoding/decoding
- < 800 bytes gzipped!

👉👉 If you're viewing this at https://github.com/js-cookie/js-cookie, you're reading the documentation for the master branch.
View documentation for the latest release. 👈👈

Installation


NPM


JavaScript Cookie supports npm under the namejs-cookie.

  1. ```
  2. $ npm i js-cookie
  3. ```

The npm package has a module field pointing to an ES module variant of the library, mainly to provide support for ES module aware bundlers, whereas its browser field points to an UMD module for full backward compatibility.

Direct download


Starting with version 3 releases are distributed with two variants of this library, an ES module as well as an UMD module.

Note the different extensions: .mjs denotes the ES module, whereas .js is the UMD one.

Example for how to load the ES module in a browser:

  1. ``` html
  2. <script type="module" src="/path/to/js.cookie.mjs"></script>
  3. <script type="module">
  4.   import Cookies from '/path/to/js.cookie.mjs'
  6.   Cookies.set('foo', 'bar')
  7. </script>
  8. ```

_Not all browsers support ES modules natively yet_. For this reason the npm package/release provides both the ES and UMD module variant and you may want to include the ES module along with the UMD fallback to account for this:

  1. ``` html
  2. <script type="module" src="/path/to/js.cookie.mjs"></script>
  3. <script nomodule defer src="/path/to/js.cookie.js"></script>
  4. ```

Here we're loading the nomodule script in a deferred fashion, because ES modules are deferred by default. This may not be strictly necessary depending on how you're using the library.

CDN


Alternatively, include it via jsDelivr CDN.

ES Module


Example for how to import the ES module from another module:

  1. ``` js
  2. import Cookies from 'js-cookie'

  4. Cookies.set('foo', 'bar')
  5. ```

Basic Usage


Create a cookie, valid across the entire site:

  1. ``` js
  2. Cookies.set('name', 'value')
  3. ```

Create a cookie that expires 7 days from now, valid across the entire site:

  1. ``` js
  2. Cookies.set('name', 'value', { expires: 7 })
  3. ```

Create an expiring cookie, valid to the path of the current page:

  1. ``` js
  2. Cookies.set('name', 'value', { expires: 7, path: '' })
  3. ```

Read cookie:

  1. ``` js
  2. Cookies.get('name') // => 'value'
  3. Cookies.get('nothing') // => undefined
  4. ```

Read all visible cookies:

  1. ``` js
  2. Cookies.get() // => { name: 'value' }
  3. ```

_Note: It is not possible to read a particular cookie by passing one of the cookie attributes (which may or may not
have been used when writing the cookie in question):_

  1. ``` js
  2. Cookies.get('foo', { domain: 'sub.example.com' }) // `domain` won't have any effect...!
  3. ```

The cookie with the name foo will only be available on .get() if it's visible from where the
code is called; the domain and/or path attribute will not have an effect when reading.

Delete cookie:

  1. ``` js
  2. Cookies.remove('name')
  3. ```

Delete a cookie valid to the path of the current page:

  1. ``` js
  2. Cookies.set('name', 'value', { path: '' })
  3. Cookies.remove('name') // fail!
  4. Cookies.remove('name', { path: '' }) // removed!
  5. ```

_IMPORTANT! When deleting a cookie and you're not relying on the default attributes, you must pass the exact same path and domain attributes that were used to set the cookie:_

  1. ``` js
  2. Cookies.remove('name', { path: '', domain: '.yourdomain.com' })
  3. ```

_Note: Removing a nonexistent cookie neither raises any exception nor returns any value._

Namespace conflicts


If there is any danger of a conflict with the namespace Cookies, the noConflict method will allow you to define a new namespace and preserve the original one. This is especially useful when running the script on third party sites e.g. as part of a widget or SDK.

  1. ``` js
  2. // Assign the js-cookie api to a different variable and restore the original "window.Cookies"
  3. var Cookies2 = Cookies.noConflict()
  4. Cookies2.set('name', 'value')
  5. ```

_Note: The .noConflict method is not necessary when using AMD or CommonJS, thus it is not exposed in those environments._

Encoding


This project is RFC 6265 compliant. All special characters that are not allowed in the cookie-name or cookie-value are encoded with each one's UTF-8 Hex equivalent using percent-encoding.
The only character in cookie-name or cookie-value that is allowed and still encoded is the percent % character, it is escaped in order to interpret percent input as literal.  
Please note that the default encoding/decoding strategy is meant to be interoperable only between cookies that are read/written by js-cookie. To override the default encoding/decoding strategy you need to use a converter.

_Note: According to RFC 6265, your cookies may get deleted if they are too big or there are too many cookies in the same domain, more details here._

Cookie Attributes


Cookie attribute defaults can be set globally by creating an instance of the api via withAttributes(), or individually for each call to Cookies.set(...) by passing a plain object as the last argument. Per-call attributes override the default attributes.

expires


Define when the cookie will be removed. Value must be a [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) which will be interpreted as days from time of creation or a [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance. If omitted, the cookie becomes a session cookie.

To create a cookie that expires in less than a day, you can check the FAQ on the Wiki.

Default: Cookie is removed when the user closes the browser.

Examples:

  1. ``` js
  2. Cookies.set('name', 'value', { expires: 365 })
  3. Cookies.get('name') // => 'value'
  4. Cookies.remove('name')
  5. ```

path


A [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) indicating the path where the cookie is visible.

Default: /

Examples:

  1. ``` js
  2. Cookies.set('name', 'value', { path: '' })
  3. Cookies.get('name') // => 'value'
  4. Cookies.remove('name', { path: '' })
  5. ```

Note regarding Internet Explorer:

Due to an obscure bug in the underlying WinINET InternetGetCookie implementation, IE’s document.cookie will not return a cookie if it was set with a path attribute containing a filename.


(From Internet Explorer Cookie Internals (FAQ))

This means one cannot set a path using window.location.pathname in case such pathname contains a filename like so: /check.html (or at least, such cookie cannot be read correctly).

In fact, you should never allow untrusted input to set the cookie attributes or you might be exposed to a XSS attack.

domain


A [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) indicating a valid domain where the cookie should be visible. The cookie will also be visible to all subdomains.

Default: Cookie is visible only to the domain or subdomain of the page where the cookie was created, except for Internet Explorer (see below).

Examples:

Assuming a cookie that is being created on site.com:

  1. ``` js
  2. Cookies.set('name', 'value', { domain: 'subdomain.site.com' })
  3. Cookies.get('name') // => undefined (need to read at 'subdomain.site.com')
  4. ```

Note regarding Internet Explorer default behavior:

Q3: If I don’t specify a DOMAIN attribute (for) a cookie, IE sends it to all nested subdomains anyway?

A: Yes, a cookie set on example.com will be sent to sub2.sub1.example.com.

Internet Explorer differs from other browsers in this regard.


(From Internet Explorer Cookie Internals (FAQ))

This means that if you omit the domain attribute, it will be visible for a subdomain in IE.

secure


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

Default: No secure protocol requirement.

Examples:

  1. ``` js
  2. Cookies.set('name', 'value', { secure: true })
  3. Cookies.get('name') // => 'value'
  4. Cookies.remove('name')
  5. ```

sameSite


A [String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), allowing to control whether the browser is sending a cookie along with cross-site requests.

Default: not set.

Note that more recent browsers are making "Lax" the default value even without specifiying anything here.

Examples:

  1. ``` js
  2. Cookies.set('name', 'value', { sameSite: 'strict' })
  3. Cookies.get('name') // => 'value'
  4. Cookies.remove('name')
  5. ```

Setting up defaults


  1. ``` js
  2. const api = Cookies.withAttributes({ path: '/', domain: '.example.com' })
  3. ```

Converters


Read


Create a new instance of the api that overrides the default decoding implementation. All get methods that rely in a proper decoding to work, such as Cookies.get() and Cookies.get('name'), will run the given converter for each cookie. The returned value will be used as the cookie value.

Example from reading one of the cookies that can only be decoded using the escape function:

  1. ``` js
  2. document.cookie = 'escaped=%u5317'
  3. document.cookie = 'default=%E5%8C%97'
  4. var cookies = Cookies.withConverter({
  5.   read: function (value, name) {
  6.     if (name === 'escaped') {
  7.       return unescape(value)
  8.     }
  9.     // Fall back to default for all other cookies
  10.     return Cookies.converter.read(value, name)
  11.   }
  12. })
  13. cookies.get('escaped') // 北
  14. cookies.get('default') // 北
  15. cookies.get() // { escaped: '北', default: '北' }
  16. ```

Write


Create a new instance of the api that overrides the default encoding implementation:

  1. ``` js
  2. Cookies.withConverter({
  3.   write: function (value, name) {
  4.     return value.toUpperCase()
  5.   }
  6. })
  7. ```

TypeScript declarations


  1. ```
  2. $ npm i @types/js-cookie
  3. ```

Server-side integration


Check out the Servers Docs

Contributing


Check out the Contributing Guidelines

Security


For vulnerability reports, send an e-mail to js-cookie at googlegroups dot com

Releasing


We are using release-it for automated releasing.

Start a dry run to see what would happen:

  1. ```
  2. $ npm run release minor -- --dry-run
  3. ```

Do a real release (publishes both to npm as well as create a new release on GitHub):

  1. ```
  2. $ npm run release minor
  3. ```

_GitHub releases are created as a draft and need to be published manually!
(This is so we are able to craft suitable release notes before publishing.)_

Supporters



Many thanks to BrowserStack for providing unlimited browser testing free of cost.

Authors


- Klaus Hartl
- Fagner Brack
- And awesome contributors