https://github.com/auth0/angular-storage
A storage library for AngularJS done right
https://github.com/auth0/angular-storage
angularjs
Last synced: 5 months ago
JSON representation
A storage library for AngularJS done right
- Host: GitHub
- URL: https://github.com/auth0/angular-storage
- Owner: auth0
- License: mit
- Archived: true
- Created: 2014-10-02T15:35:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-09-15T07:45:06.000Z (almost 3 years ago)
- Last Synced: 2024-10-25T22:53:27.715Z (8 months ago)
- Topics: angularjs
- Language: JavaScript
- Homepage:
- Size: 90.8 KB
- Stars: 642
- Watchers: 126
- Forks: 89
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
> **Warning**
> This repository has been archived, the libaray has been deprecated, but remains available on NPM.
# angular-storage [](https://travis-ci.org/auth0/angular-storage)
A Storage done right for AngularJS.
## Sponsor
|||
|-|-|
||If you want to quickly add secure token-based authentication to your Angular projects, feel free to check Auth0's Angular SDK and free plan at [auth0.com/developers](https://auth0.com/developers?utm_source=GHsponsor&utm_medium=GHsponsor&utm_campaign=angular-storage&utm_content=auth)|
## 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: Install with either bower or npm and link to the installed file from html using script tag.
````bash
bower install a0-angular-storage
````
````bash
npm install angular-storage
````
## Using it
````js
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
````js
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
```js
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](https://github.com/auth0/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](https://auth0.com/whitehat) details the procedure for disclosing security issues.
## Author
[Auth0](auth0.com)
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.