global-storage

Simple JavaScript Object for global variables management

GlobalStorage is a lightweight library (~1kb when minified) designed for simple variable management. It can be used by passing variables to JavaScript from backend languages like PHP. You can set/get objects, arrays, numbers or other data types, accessible via a Redis-like API.

How to use GlobalStorage

It can by downloaded manually from here and add then in your HTML.

<script src="/path/to/global-storage.js" type="text/javascript"></script>

Or can be downloaded via bower.

bower install global-storage

---

You can pass variables collected from backend to frontend via JSON

<script>
    GlobalStorage.fromJSON('{"user_id":123,"env":"dev","session":{"is_logged":true,"is_admin":false,"avatar":{"min":"http://...jpg"}}}');
</script>

and in other files of your app, you have easily access to your backend variables.

Example

...
if ( GlobalStorage.get('env') == 'dev' ) {
   // code for dev environment
}
...

if ( GlobalStorage.get('session.is_logged') ) {
   // code for logged user
}
...

// <img id="some-img-id" src="" />
$('some-img-id').attr('src', GlobalStorage.get('session.avatar.min', 'http://...default-avatar.jpg'));
...

API reference

/**
 * @param {String} key
 * @param {Mixed} value
 */
GlobalStorage.set(key, value)

Set a key to a particular value or a object.

Example

// Saved as number
GlobalStorage.set('book_id', 123);
// Saved as string
GlobalStorage.set('book_title', 'JavaScript for dummies');
// Saved as array
GlobalStorage.set('books', [{title: 'JavaScript', iban: 12345}, {title: 'Html5', iban: 56789}]);
// Saved as object
GlobalStorage.set('session', {user_id: 12, avatar: {min: 'http://...min.jpg', max: 'http://...max.jpg'}});

---

/**
 * @param {String} key
 * @param {Mixed} defaultValue
 */
GlobalStorage.get(key, defaultValue)

Returns the saved value for given key, even if the saved value is an object. If value is null or undefined it returns a default value.

Example

GlobalStorage.get('book_title');
> "JavaScript for dummies"

GlobalStorage.get('book_id');
> 123

GlobalStorage.get('books');
>  [{title: 'JavaScript for dummies', iban: 12345}, {titile: 'Html5', iban: 56789}]

GlobalStorage.get('session');
>  {user_id: 12, avatar: {min: 'http://...min.jpg', max: 'http://...max.jpg'}}

GlobalStorage.get('session.user_id');
>  12

GlobalStorage.get('session.avatar');
>  {min: 'http://...min.jpg', max: 'http://...max.jpg'}

GlobalStorage.get('session.avatar.min');
>  'http://...min.jpg'

GlobalStorage.get('session.avatar.mid', 'mid.jpg');
>  'mid.jpg'

GlobalStorage.get('not-exists-key', 55):
> 55

GlobalStorage.set('foo', 11):
GlobalStorage.get('foo', 55):
> 11

Running Tests

To execute all unit tests, use:

grunt test

License

MIT