<p align="center"> <img src="https://cloud.githubusercontent.com/assets/835857/14581711/ba623018-0436-11e6-8fce-d2ccd4d379c9.gif"> </p> # JavaScript Cookie [](https://travis-ci.org/js-cookie/js-cookie) [](https://codeclimate.com/github/js-cookie/js-cookie) A simple, lightweight JavaScript API for handling cookies 用于处理cookie的简单、轻量级的JavaScript API * Works in [all](https://saucelabs.com/u/js-cookie) browsers * Accepts [any](#encoding) character * [Heavily](test) tested * No dependency * [Unobtrusive](#json) JSON support * Supports AMD/CommonJS * [RFC 6265](https://tools.ietf.org/html/rfc6265) compliant * Useful [Wiki](https://github.com/js-cookie/js-cookie/wiki) * Enable [custom encoding/decoding](#converters) * **~900 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.](https://github.com/js-cookie/js-cookie/tree/latest#readme)** ## 构建状态矩阵Build Status Matrix [](https://saucelabs.com/u/js-cookie) ## 安装Installation ### 存储空间Direct download 下载该脚本 [这里](https://github.com/js-cookie/js-cookie/blob/latest/src/js.cookie.js) 并且包含它 (除非你把脚本打包在别的地方): ```html <script src="/path/to/js.cookie.js"></script> ``` **不要直接从GitHub中直接包含脚本Do not include the script directly from GitHub (http://raw.github.com/...).** 文件被当作文本/普通文件，并且被阻塞 in Internet Explorer on Windows 7 for instance (because of the wrong MIME type). Bottom line: GitHub is not a CDN. ### 软件包管理器Package Managers JavaScript Cookie supports [npm](https://www.npmjs.com/package/js-cookie) and [Bower](http://bower.io/search/?q=js-cookie) under the name `js-cookie`. ### 模块加载器Module Loaders JavaScript Cookie can also be loaded as an AMD, CommonJS or [ES6](https://github.com/js-cookie/js-cookie/issues/233#issuecomment-233187386) module. ## 基本用法Basic Usage 创建一个cookie，在整个站点中有效: ```javascript Cookies.set('name', 'value'); ``` 创建一个从现在起7天过期的cookie，在整个网站上有效: ```javascript Cookies.set('name', 'value', { expires: 7 }); ``` 创建一个过期的cookie，对当前页面的路径有效: ```javascript Cookies.set('name', 'value', { expires: 7, path: '' }); ``` 读取 cookie: ```javascript Cookies.get('name'); // => 'value' Cookies.get('nothing'); // => undefined ``` 阅读所有可见的 cookies: ```javascript Cookies.get(); // => { name: 'value' } ``` 删除 cookie: ```javascript Cookies.remove('name'); ``` 删除一个 cookie 有效期至当前页的路径: ```javascript Cookies.set('name', 'value', { path: '' }); Cookies.remove('name'); // fail! Cookies.remove('name', { path: '' }); // removed! ``` *重要提示! 在删除cookie时，您必须传递与设置cookie相同的路径和域属性，除非您依赖于 [默认属性](#cookie-attributes).* *注意: 删除未存在的cookie不会引发任何异常，也不会返回任何值 ## 命名空间冲突 Namespace conflicts 如果存在与名称空间`Cookies`发生冲突的危险, 无冲突 `noConflict` 方法将允许您定义一个新的名称空间并保留原来的名称空间。 当在第三方站点上运行脚本时，这一点特别有用。e.g. 作为小部件的一部分SDK. ```javascript // 将js-cookie api分配给一个不同的变量，并恢复原来的“windows.cookie”。 var Cookies2 = Cookies.noConflict(); Cookies2.set('name', 'value'); ``` *注意: The `.noConflict` method is not necessary when using AMD or CommonJS, thus it is not exposed in those environments.* ## JSON js-cookie provides unobtrusive JSON storage for cookies. When creating a cookie you can pass an Array or Object Literal instead of a string in the value. If you do so, js-cookie will store the string representation of the object according to `JSON.stringify`: ```javascript Cookies.set('name', { foo: 'bar' }); ``` When reading a cookie with the default `Cookies.get` api, you receive the string representation stored in the cookie: 当读取cookie缺省的`Cookies.get` api时候，您接收存储在cookie中的字符串表示: ```javascript Cookies.get('name'); // => '{"foo":"bar"}' ``` ```javascript Cookies.get(); // => { name: '{"foo":"bar"}' } ``` When reading a cookie with the `Cookies.getJSON` api, you receive the parsed representation of the string stored in the cookie according to `JSON.parse`: ```javascript Cookies.getJSON('name'); // => { foo: 'bar' } ``` ```javascript Cookies.getJSON(); // => { name: { foo: 'bar' } } ``` *Note: To support IE6-7 ([and IE 8 compatibility mode](http://stackoverflow.com/questions/4715373/json-object-undefined-in-internet-explorer-8)) you need to include the JSON-js polyfill: https://github.com/douglascrockford/JSON-js* ## 编码Encoding This project is [RFC 6265](http://tools.ietf.org/html/rfc6265#section-4.1.1) 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](http://en.wikipedia.org/wiki/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](https://github.com/js-cookie/js-cookie/pull/200#discussion_r63270778). To override the default encoding/decoding strategy you need to use a [converter](#converters). ## Cookie Attributes属性 Cookie attributes defaults can be set globally by setting properties of the `Cookies.defaults` object or individually for each call to `Cookies.set(...)` by passing a plain object in the last argument. Per-call attributes override the default attributes. ### 有效期expires Define when the cookie will be removed. Value can 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](https://github.com/js-cookie/js-cookie/wiki/Frequently-Asked-Questions#expire-cookies-in-less-than-a-day). **Default:** Cookie is removed when the user closes the browser. **例子Examples:** ```javascript Cookies.set('name', 'value', { expires: 365 }); Cookies.get('name'); // => 'value' Cookies.remove('name'); ``` ### 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:** ```javascript Cookies.set('name', 'value', { path: '' }); Cookies.get('name'); // => 'value' Cookies.remove('name', { path: '' }); ``` **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)](http://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx)) This means one cannot set a path using `path: window.location.pathname` in case such pathname contains a filename like so: `/check.html` (or at least, such cookie cannot be read correctly). ### 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`: ```javascript Cookies.set('name', 'value', { domain: 'subdomain.site.com' }); Cookies.get('name'); // => undefined (need to read at 'subdomain.site.com') ``` **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)](http://blogs.msdn.com/b/ieinternals/archive/2009/08/20/wininet-ie-cookie-internals-faq.aspx)) 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:** ```javascript Cookies.set('name', 'value', { secure: true }); Cookies.get('name'); // => 'value' Cookies.remove('name', { secure: true }); ``` ## 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 converter first for each cookie. The returning String will be used as the cookie value. Example from reading one of the cookies that can only be decoded using the `escape` function: ```javascript document.cookie = 'escaped=%u5317'; document.cookie = 'default=%E5%8C%97'; var cookies = Cookies.withConverter(function (value, name) { if ( name === 'escaped' ) { return unescape(value); } }); cookies.get('escaped'); // 北 cookies.get('default'); // 北 cookies.get(); // { escaped: '北', default: '北' } ``` ### Write Create a new instance of the api that overrides the default encoding implementation: ```javascript Cookies.withConverter({ read: function (value, name) { // Read converter }, write: function (value, name) { // Write converter } }); ``` ## Server-side integration Check out the [Servers Docs](SERVER_SIDE.md) ## Contributing Check out the [Contributing Guidelines](CONTRIBUTING.md) ## Security For vulnerability reports, send an e-mail to `jscookie at gmail dot com` ## Manual release steps * Increment the "version" attribute of `package.json` * Increment the version number in the `src/js.cookie.js` file * Commit with the message "Release version x.x.x" * Create version tag in git * Create a github release and upload the minified file * Change the `latest` tag pointer to the latest commit * `git tag -f latest` * `git push <remote> :refs/tags/latest` * `git push origin master --tags` * Release on npm ## Authors * [Klaus Hartl](https://github.com/carhartl) * [Fagner Brack](https://github.com/FagnerMartinsBrack) * And awesome [contributors](https://github.com/js-cookie/js-cookie/graphs/contributors)