universal-cookie

Universal cookies for JavaScript

## Integrations - [`react-cookie`](https://www.npmjs.com/package/react-cookie) - Universal cookies for React - [`universal-cookie-express`](https://www.npmjs.com/package/universal-cookie-express) - Hook cookies get/set on Express for server-rendering ## Getting started `npm install universal-cookie` or in the browser (global variable `UniversalCookie`): ```html ``` ## API - Cookies class ### `constructor([cookieHeader], [defaultSetOptions])` Create a cookies context - cookieHeader (string|object): specify the cookie header or object - defaultSetOptions (object): specify the default options when setting cookies - path (string): cookie path, use `/` as the path if you want your cookie to be accessible on all pages - expires (Date): absolute expiration date for the cookie - maxAge (number): relative max age of the cookie from when the client receives it in seconds - domain (string): domain for the cookie (sub.domain.com or .allsubdomains.com) - secure (boolean): Is only accessible through HTTPS? - httpOnly (boolean): Is only the server can access the cookie? **Note: You cannot get or set httpOnly cookies from the browser, only the server.** - sameSite (boolean|none|lax|strict): Strict or Lax enforcement - partitioned (boolean): Indicates that the cookie should be stored using partitioned storage ### `get(name, [options])` Get a cookie value - name (string): cookie name - options (object): - doNotParse (boolean): do not convert the cookie into an object no matter what ### `getAll([options])` Get all cookies - options (object): - doNotParse (boolean): do not convert the cookie into an object no matter what ### `set(name, value, [options])` Set a cookie value - name (string): cookie name - value (string|object): save the value and stringify the object if needed - options (object): Support all the cookie options from RFC 6265 - path (string): cookie path, use `/` as the path if you want your cookie to be accessible on all pages - expires (Date): absolute expiration date for the cookie - maxAge (number): relative max age of the cookie from when the client receives it in seconds - domain (string): domain for the cookie (sub.domain.com or .allsubdomains.com) - secure (boolean): Is only accessible through HTTPS? - httpOnly (boolean): Is only the server can access the cookie? **Note: You cannot get or set httpOnly cookies from the browser, only the server.** - sameSite (boolean|none|lax|strict): Strict or Lax enforcement - partitioned (boolean): Indicates that the cookie should be stored using partitioned storage ### `remove(name, [options])` Remove a cookie - name (string): cookie name - options (object): Support all the cookie options from RFC 6265 - path (string): cookie path, use `/` as the path if you want your cookie to be accessible on all pages - expires (Date): absolute expiration date for the cookie - maxAge (number): relative max age of the cookie from when the client receives it in seconds - domain (string): domain for the cookie (sub.domain.com or .allsubdomains.com) - secure (boolean): Is only accessible through HTTPS? - httpOnly (boolean): Is only the server can access the cookie? **Note: You cannot get or set httpOnly cookies from the browser, only the server.** - sameSite (boolean|none|lax|strict): Strict or Lax enforcement - partitioned (boolean): Indicates that the cookie should be stored using partitioned storage ### `addChangeListener(callback)` Add a listener to when a cookie is set or removed. - callback (function): Call that will be called with the first argument containing `name`, `value` and `options` of the changed cookie. ### `removeChangeListener(callback)` Remove a listener from the change callback. ### `removeAllChangeListeners()` Remove all change listeners that were previously added with `addChangeListener()`. ### `update()` Read back the cookies from the browser and triggers the change listeners. This should normally not be necessary because this library detects cookie changes automatically. ## Browser Example ```js import Cookies from 'universal-cookie'; const cookies = new Cookies(null, { path: '/' }); cookies.set('myCat', 'Pacman'); console.log(cookies.get('myCat')); // Pacman ``` ## Server Example ```js import Cookies from 'universal-cookie'; const cookies = new Cookies(req.headers.cookie, { path: '/' }); console.log(cookies.get('myCat')); // Pacman or undefined if not set yet ```

Package	Téléchargements	Stars	Taille	Issues	Publication	Licence

universal-cookie	1,690,052	191	54.4 kB	16	il y a 2 mois	MIT