@meanie/angular-storage
Version:
An Angular service for interacting with local storage, session storage and cookie storage
105 lines (70 loc) • 3.78 kB
Markdown
# @meanie/angular-storage
[](https://www.npmjs.com/package/@meanie/angular-storage)
[](https://david-dm.org/meanie/angular-storage)
[](https://github.com/meanie/angular-storage/issues)
[](https://www.codacy.com/app/meanie/angular-storage)
An Angular service for interacting with local storage, session storage and cookie storage
The storage service automatically parses objects or arrays to and from JSON, and preserves numbers and integers as well.
## Installation
You can install this package using `yarn` or `npm`:
```shell
#yarn
yarn add @meanie/angular-storage
#npm
npm install @meanie/angular-storage --save
```
Include the script `node_modules/@meanie/angular-storage/release/angular-storage.js` in your build process, or add it via a `<script>` tag to your `index.html`:
```html
<script src="node_modules/@meanie/angular-storage/release/angular-storage.js"></script>
```
Add `Storage.Service` as a dependency for your app.
## Configuration
```js
angular.module('App', [
'Storage.Serice'
]).config(function($storageProvider, App) {
//Set global prefix for stored keys
$storageProvider.setPrefix(App.name.toLowerCase());
//Change the default storage engine
//Defaults to 'local'
$storageProvider.setDefaultStorageType('session');
//Change the enabled storage engines
//Defaults to ['memory', 'cookie', 'session', 'local']
$storageProvider.setEnabledStorageEngines(['local', 'session', 'custom']);
});
```
## Usage
```js
angular.module('App.MyModule').controller('MyController', function($storage) {
//Set item in storage
$storage.set('user', user); //Set in default storage
$storage.local.set('user', user); //Set in local storage
$storage.session.set('user', user); //Set in session storage
//Get item from storage
$storage.get('user'); //Get from default storage
$storage.local.get('user'); //Get from local storage
$storage.session.get('user'); //Get from session storage
//Get with default value in case requested value is not set or null
$storage.get('user', defaultUser);
//Remove an item from storage
$storage.remove('user'); //Remove from default storage
$storage.local.remove('user'); //Remove from local storage
$storage.session.remove('user'); //Remove from session storage
//Clear items from storage
$storage.clear(); //Clear default storage
$storage.local.clear(); //Clear local storage
$storage.session.clear(); //Clear session storage
//Clear items with a certain prefix only
$storage.clear('defaults.');
});
```
## Issues & feature requests
Please report any bugs, issues, suggestions and feature requests in the [@meanie/angular-storage issue tracker](https://github.com/meanie/angular-storage/issues).
## Contributing
Pull requests are welcome! If you would like to contribute to Meanie, please check out the [Meanie contributing guidelines](https://github.com/meanie/meanie/blob/master/CONTRIBUTING.md).
## Sponsor
This package has been kindly sponsored by [Hello Club](https://helloclub.com?source=meanie), an [all in one club and membership management solution](https://helloclub.com?source=meanie) complete with booking system, automated membership renewals, online payments and integrated access and light control. Check us out if you happen to belong to any kind of club or if you know someone who helps run a club!
## License
(MIT License)
Copyright 2015-2020, Adam Reis