Brownies
Tastier cookies
, local
, session
, and db
storage in a tiny package:
import { cookies, local, db } from 'brownies';
cookies.token = 42;
let t = cookies.token;
delete cookies.token;
local.token = 42;
let t = local.token;
delete local.token;
db.token = 42;
let t = await db.token;
delete db.token;
Subscribe to changes in any of the objects:
import { session, subscribe } from 'brownies';
subscribe(session, 'token', value => {
console.log(value);
});
session.token = 42;
session.token = 'Hello';
delete session.token;
You can also iterate them as expected with Object.keys()
, Object.values()
, etc:
cookies.token = 42;
cookies.name = 'Francisco';
console.log(Object.keys(cookies));
for (let val of cookies) {
console.log(val);
}
Getting started
Install it with npm:
npm install brownies
Then import the different parts:
import { cookies, local, ... } from 'brownies';
const { cookies, local, ... } = require('brownies');
Or use a CDN for the browser:
<script src="https://cdn.jsdelivr.net/npm/brownies"></script>
<script>
const { cookies, local, ... } = brownies;
</script>
If you just want to play, go to the JSFiddle playground.
Cookies
Manipulate cookies with the simple getter/setter interface:
import { cookies } from 'brownies';
cookies.token = 42;
const res = cookies.token;
delete cookies.token;
Cookies will retain the types that is set. This is possible thanks to the underlying library:
cookies.id = 1;
cookies.accepted = true;
cookies.name = 'Francisco';
cookies.friends = [3, 5];
cookies.user = { id: 1, accepted: true, name: 'Francisco' };
console.log(typeof cookies.id);
console.log(typeof cookies.accepted);
console.log(typeof cookies.name);
console.log(Array.isArray(cookies.friends));
console.log(typeof cookies.user);
Warning: Manually setting cookies with document.cookie
or server-side [click for details]
Values are encoded first with JSON.stringify()
to allow for different types, and then with encodeURIComponent()
to remain RFC 6265 compliant. See the details in the underlying library. If you are setting cookies manually, you'll have to follow the same process:
import { cookies } from 'brownies';
document.cookie = `name=${encodeURIComponent(JSON.stringify('Francisco'))}`
console.log(cookies.name);
To delete a item, you have to call delete
on it as you would normally do with object properties:
console.log(cookies.id);
cookies.id = 1;
console.log(cookies.id);
delete cookies.id;
console.log(cookies.id);
Note: the default value for deleted cookies is set to null
to be consistent with other local storage technologies.
You can iterate over the cookies in many different standard ways as normal:
Object.keys(cookies);
Object.values(cookies);
Object.entries(cookies);
for (let key in cookies) {}
for (let val of cookies) {}
Options
You can change the cookies options globally:
import { cookies, options } from 'brownies';
cookies[options] = {
expires: 100 * 24 * 3600,
domain: false,
path: '/',
secure: https ? true : false
};
cookies.token = 24;
WARNING: you should import options
and then use it as a variable like cookies[options]
. You CANNOT do cookies.options
nor cookies['options']
.
LocalStorage
For localStorage
, we define local
to simplify the interface:
import { local } from 'brownies';
local.token = 42;
const res = local.token;
delete local.token;
localStorage items can be set to many different standard values, and they will retain the types:
local.id = 1;
local.accepted = true;
local.name = 'Francisco';
local.friends = [3, 5];
local.user = { id: 1, accepted: true, name: 'Francisco' };
console.log(typeof local.id);
console.log(typeof local.accepted);
console.log(typeof local.name);
console.log(Array.isArray(local.friends));
console.log(typeof local.user);
Since 2.0 we are using custom data storage to keep the types consistent, but this means that you cannot read items that were set by brownies
like localStorage.getItem(KEY)
. Please use the local.KEY
provided by brownies
API instead.
To delete a item, you have to call delete
on it as you would normally do with object properties:
console.log(local.id);
local.id = 1;
console.log(local.id);
delete local.id;
console.log(local.id);
You can iterate over the items in many different standard ways as normal:
Object.keys(local);
Object.values(local);
Object.entries(local);
for (let key in local) {}
for (let val of local) {}
So if you wanted to delete them all, you can do so by looping them easily:
for (let key in local) {
console.log('Deleting:', key, local[key]);
delete local[key];
}
SessionStorage
For the sessionStorage
, we define session
to simplify the interface:
import { session } from 'brownies';
session.token = 42;
const res = session.token;
delete session.token;
sessionStorage items can be set to many different standard values, and they will retain the types:
session.id = 1;
session.accepted = true;
session.name = 'Francisco';
session.friends = [3, 5];
session.user = { id: 1, accepted: true, name: 'Francisco' };
console.log(typeof session.id);
console.log(typeof session.accepted);
console.log(typeof session.name);
console.log(Array.isArray(session.friends));
console.log(typeof session.user);
Since 2.0 we are using custom data storage to keep the types consistent, but this means that you cannot read items that were set by brownies
like localStorage.getItem(KEY)
. Please use the local.KEY
provided by brownies
API instead.
To delete a item, you have to call delete
on it as you would normally do with object properties:
console.log(session.id);
session.id = 1;
console.log(session.id);
delete session.id;
console.log(session.id);
You can iterate over the items in many different standard ways as normal:
Object.keys(session);
Object.values(session);
Object.entries(session);
for (let key in session) {}
for (let val of session) {}
So if you wanted to delete them all, you can do so by looping them easily:
for (let key in session) {
console.log('Deleting:', key, session[key]);
delete session[key];
}
Subscribe
Subscribe allows you to listen to changes to any object, including yours:
import { local, subscribe } from 'brownies';
subscribe(local, 'token', value => {
console.log(value);
});
local.token = 42;
delete local.token;
local.token = 'Hello';
Warning: subscribe()
cannot guarantee being sync, so the above might not trigger if the end value is the same as the initial value or middle steps might not be shown.
Changes work even if you use the native API to change the values, or even if the changes happen on another tab:
import { local, subscribe } from 'brownies';
subscribe(local, 'token', value => {
console.log(value);
});
localStorage.setItem('token', 'abc');
To unsubscribe, store the value returned by subscribe()
and then use it with unsubscribe()
:
import { cookies, subscribe, unsubscribe } from 'brownies';
const id = subscribe(cookies, 'token', token => {
console.log(token);
});
unsubscribe(id);
You can also unsubscribe by the callback, which is very useful in a React context:
import { cookies, subscribe, unsubscribe } from 'brownies';
const cb = token => console.log('NEW TOKEN:', token);
subscribe(cookies, 'token', cb);
unsubscribe(cb);
For instance, if you want to keep the user points synced across tabs with localStorage:
import { local, subscribe, unsubscribe } from 'brownies';
export default class extends React.Component {
constructor (props) {
super(props);
this.state = { points: local.points };
this.updatePoints = this.updatePoints.bind(this);
subscribe(local, 'points', this.updatePoints);
}
updatePoints (points) {
this.setState({ points });
}
componentWillUnmount () {
unsubscribe(this.updatePoints);
}
render () {
return <div>Points: {this.state.points}</div>;
}
}
Warning: try to keep the number of subscriptions low since each will incur in a performance cost.
Trivia
My former coworker made delicious brownies when leaving the company and asked me to name a library brownies. I thought it was a fantastic idea, since brownies are tastier cookies after all 🙂.
This library was previously named clean-store
, but I never really liked that name. The stars in this repository were transferred from the previous repository.