Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bjarneo/cookiejs
CookieJS framework. No jQuery needed.
https://github.com/bjarneo/cookiejs
Last synced: 3 days ago
JSON representation
CookieJS framework. No jQuery needed.
- Host: GitHub
- URL: https://github.com/bjarneo/cookiejs
- Owner: bjarneo
- Created: 2013-09-10T19:11:28.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-09-19T09:31:07.000Z (about 6 years ago)
- Last Synced: 2024-11-05T11:58:20.206Z (8 days ago)
- Language: JavaScript
- Homepage:
- Size: 60.5 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CookieJS
========
CookieJS - Just another small JavaScript library. Use this if you need to set/get/delete cookies.
This library is now pushed to NPM, and is available as an UMD build.
```
$ npm i --save cookie-micro
```
UNPKG
---
```
```
**No jQuery needed.**
How to use:
* name = cookie name
* value = value of the cookie
* expire = days before it expires
* path = path of the website. '/' for whole site.
* (Optional) domain = ex: domain.com. If not set, it would be available for all subdomains.
* (Optional) secure = Use SSL while transferring cookie to server
* (Optional) httpOnly - Using the HttpOnly flag when generating a cookie helps mitigate the risk of client side script accessing the protected cookie (if the browser supports it). (https://www.owasp.org/index.php/HttpOnly)
CookieJS.set({name: '', value: '', expires: '', path: '', domain: '', secure: true/false, httpOnly: true/false});
---
```javascript
CookieJS.set({
name: 'mycookie',
value:'myvalue',
expires: 30, // x Days
path: '/', // Website path
domain: 'domain.com', // Optional
secure: true, // Optional
httpOnly: false // Optional
});
```
No return value.
---
CookieJS.get(name);
---
```javascript
CookieJS.get('mycookie');
```
Returns the value of the stored cookie, or undefined if the cookies key does not exist.
---
CookieJS.getAll(void); Return all cookies.
---
```javascript
//Example:
var cookies = CookieJS.getAll();
console.log(cookies.mycookie);
// Output: myvalue
```
Returns a key-value hash of available cookies on the document. If there are no available cookies, an empty hash is returned.
---
CookieJS.keys(void); Return all cookie keys.
---
```javascript
//Example:
var cookies = CookieJS.keys();
console.log(cookies[0]);
// Output: mycookie
```
---
Returns an array of keys of set cookies. If no cookies have been set, `CookieJS.keys()` returns an empty array.
CookieJS.has(name);
---
```javascript
CookieJS.has('mycookie');
//Output: returns true or false
```
Returns true if `name` is the key of a cookie, otherwise returns false.
---
CookieJS.delete({name: '', path: '', domain: ''});
---
```javascript
CookieJS.delete({
name: 'mycookie',
path: '/'
});
```
No return value.