ng-store

AngularJS store service base on store.js

origin store.js

How to User it

bower

bower install ng-store --save

and insert in HTML

npm

npm install ng-store --save

and then require it in you project

require('ng-store');

the mose important is require this module in Angular

angular
  .module('angularTApp', [
    'ngStore'
  ])

Provider

provider 2 method to config storage prefix and expiration

ngStoreProvider.prefix('test').exp(1000 * 5);

prefix

default:'st'

exp

default:3600 * 24 * 7

Document

ngStore.set('user', {name: 'marcus', likes: 'javascript',1000 * 60}); // store a object in 1 min
ngStore.get('user');    // {name: 'marcus', likes: 'javascript',1000 * 60}
ngStore.remove('user'); // marcus   return the key which been delete
ngStore.clear();        // [{key:'marcus'},value:{name: 'marcus', likes: 'javascript',1000 * 60}]     return a list which been delete
...

allmost like store.js's api

• set(key,value,exp)
  • key{string}
  • value{any}
  • exp:[number],if no fill this argument,user default exp 3600 * 24 * 7

store the cache,accept and value except the function

• get(key)
  • key{string}

return {value} or nuill

get the store ignore which not you store like some Google analysis and Baidu analysis

• remove(key)
  • key{string}

return {object} which been delete

remove the cache

• has(key)
  • key{string}

return {boolean}

check the cache exsit or not,ignore which not you store

• forEach(func)
  • func{function}

like angular.forEach

• getAll()

return the all key you own

• clear()

clear the all cache ignore which not you store

Referrence

store.js

Additional method

$watch

watch a store and do some action when the value change lick $scope.$watch

only for communicate between the diffrent page (cros)

listen the onStorage Event that mean not work for store cookie

and there is a bug in IE:

IE will trigger the target window and it self,and chrome and firefox just trigger the target window

ngStore.$watch(key,watcher,[$scope])

var watcher = ngStore.$watch('user', function (newVal, oldVal) {
  console.log(newVal, oldVal);
}, $scope);

arguments

• key{string}

the store key you want to watch

• watcher{function}

a function,when the store change and run,the first arguments is old value,2nd is new value

• $scope[Optional parameters]

if afferent this argument,it will automatically canceled when $scope $destroy I don't suggest you use this method in controller but in service

return{function}

return a function which can cancel this watcher like $scope.$watch

Build

grunt build