0.6.0 • Published 7 years ago
simple-cookies v0.6.0
A very simple utility library for handling cookies in client code (JS or TS)
Install
yarn add simple-cookiesOR
npm install simple-cookiesHow to use
import cookies from 'simple-cookies';
cookies.set('example', 'value' /*, cookieOpts (see below) */); // Return true if cookies are supported
cookies.get('example' /*, cookieOpts (see below) */); // Returns 'value' if cookies are supported
cookies.remove('example' /*, cookieOpts (see below) */); // Returns true if cookies are supportedOptions
For each cookie-method you can pass an optional last argument that is an object with any of the following properties and values:
| Name | Values | Effect | |
|---|---|---|---|
| silent | true | false (default) | Whether to throw an error (false) or not (true) when cookies are not supported |
| days | a number | How long the cookies should be valid (in days) optional | |
| secure | true | false (default) | Whether the cookie should only be transmitted over secure protocols such as https |
| path | a string | Indicates the URL in which the cookie is used | |
| domain | a string | The host(s) to whom the cookie will be sent to |
License
All of the code is licensed under the MIT license