Git Product home page Git Product logo

angular-storage's Introduction

angular-storage Build Status

A Storage done right for AngularJS.

Key Features

  • Uses localStorage or sessionStorage by default but if it's not available, it uses ngCookies.
  • Lets you save JS Objects
  • If you save a Number, you get a Number, not a String
  • Uses a caching system so that if you already have a value, it won't get it from the store again.

Installing it

You have several options:

bower install a0-angular-storage
npm install angular-storage
<script type="text/javascript" src="https://cdn.rawgit.com/auth0/angular-storage/master/dist/angular-storage.js"></script>

Using it

angular.module('app', ['angular-storage'])
.controller('Controller', function(store) {
  var myObj = {
    name: 'mgonto'
  };

  store.set('obj', myObj);

  var myNewObject = store.get('obj');

  angular.equals(myNewObject, myObj); // return true

  store.remove('obj');

  store.set('number', 2);

  typeof(store.get('number')) === 'number'
});

Namespaced Storages

You can also create namespaced storages if you want

angular.module('app', ['angular-storage'])
.factory('Auth0Store', function(store) {
  return store.getNamespacedStore('auth0');
})
.controller('Controller', function(Auth0Store) {

  var myObj = {
    name: 'mgonto'
  };

  // This will be saved in localStorage as auth0.obj
  Auth0Store.set('obj', myObj);

  // This will look for auth0.obj
  var myNewObject = Auth0Store.get('obj');

  angular.equals(myNewObject, myObj); // return true
});

Changing storage type

angular.module('app', ['angular-storage'])
  .config(function(storeProvider) {
    // Store defaults to localStorage but we can set sessionStorage or cookieStorage.
    storeProvider.setStore('sessionStorage');
  })
  .controller('Controller', function(store) {

  var myObj = {
    name: 'mgonto'
  };

  // This will be saved in sessionStorage as obj
  store.set('obj', myObj);

  // This will look for obj in sessionStorage
  var myNewObject = store.get('obj');

  angular.equals(myNewObject, myObj); // return true
});

API

storeProvider.setStore(storageName)

Sets the underlying store for the store service. It can be localStorage, sessionStorage or cookieStorage. Defaults to localStorage

store.set(name, value)

Sets a new value to the storage with the key name. It can be any object.

store.get(name)

Returns the saved value with they key name. If you saved an object, you get an object.

store.remove(name)

Deletes the saved value with the key name

store.getNamespacedStore(namespace, delimiter)

Returns a new store service that will use the namespace and delimiter when saving and getting values like the following namespace[delimiter]key. For example auth0.object considering auth0 as namespace and . as a delimiter

Usages

This library is used in auth0-angular

Contributing

Just clone the repo, run npm install, bower install and then gulp to work :).

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.

angular-storage's People

Contributors

mgonto avatar chenkie avatar ntotten avatar kildareflare avatar tomcrhak-bb avatar patrickjs avatar aaronroberson avatar aguspina avatar pose avatar den-t avatar schmooie avatar jercoh avatar mehreencs87 avatar

Watchers

James Cloos avatar Nagendra B avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.