https://github.com/ahmu83/cookie-object-js
https://github.com/ahmu83/cookie-object-js
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ahmu83/cookie-object-js
- Owner: ahmu83
- Created: 2023-03-07T03:24:18.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T13:31:18.000Z (11 months ago)
- Last Synced: 2025-01-25T02:12:40.877Z (4 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JavaScript cookieObject
A JavaScript factory function for storing key:value object data in a cookie
- No dependency
- Supports ES modules
## Installation
### NPM
Cookie Object JS supports [npm](https://www.npmjs.com/package/js-cookie) under the name `cookie-object-js`.
```bash
npm i cookie-object-js
```
### Examples
```html
import { cookieObject } from './cookie-object.esm.js';
// OR import { cookieObject } from 'cookie-object-js';
var data = cookieObject('my_cookie_name');
data.set({
'Full Name': 'Cookie Object JS'
});
data.set('script_type', 'Factory function');
console.log(data.get());
```
```html
```
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.
## Basic Usage
Create a cookie that is valid across the entire site and transform it to a JSON object:
```javascript
cookieObject('my_cookie_name').set('Name', 'The Name...!')
```
Create a cookie that expires 7 days from now, valid across the entire site:
```javascript
cookieObject('my_cookie_name', 7).set('Name', 'The Name...!')
```
Create an expiring cookie, valid to the path of the /page-url/ path:
```javascript
cookieObject('my_cookie_name', 7, '/page-url/').set('Name', 'The Name...!')
```
Get cookie object data:
```javascript
cookieObject('my_cookie_name').get()
cookieObject('my_cookie_name').get('Name')
```
Remove an item from cookie object:
```javascript
cookieObject('my_cookie_name').remove('Name')
```
Reset cookie object to {}:
```javascript
cookieObject('my_cookie_name').reset()
```
Reset cookie object to a default object:
```javascript
cookieObject('my_cookie_name').reset(defaultObject)
```