@angular-cool/storage

Cool Storage wrapper for angular.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
63Jan 21, 2021May 9, 2018Minified + gzip package size for @angular-cool/storage in KB

Readme

@angular-cool/storage NPM version Downloads Total Downloads

Cool angular wrapper for LocalStorage and SessionStorage with Universal support

Install

npm install --save @angular-cool/storage

Setup

import { NgModule } from '@angular/core';
import { CoolStorageModule } from '@angular-cool/storage';

@NgModule({
    imports: [
        CoolStorageModule.forRoot(),
    ]
})
export class MyAppModule {}

Features

  • LocalStorage support
  • SessionStorage support
  • Universal support

API

  • getItem(key)
  • setItem(key, value)
  • removeItem(key)
  • length
  • clear()
  • key(index)
  • itemSetObservable
  • itemRemovedObservable
  • getObject(key)
  • tryGetObject(key)
  • setObject(key, value)
import { Component, OnInit } from '@angular/core';

import { CoolLocalStorage } from '@angular-cool/storage';

@Component({
  selector: 'my-app'
})
export class AppComponent implements OnInit { 
    localStorage: CoolLocalStorage;
    
    constructor(localStorage: CoolLocalStorage) {
        this.localStorage = localStorage;   
    }
    
    ngOnInit() {
        this.localStorage.setItem('itemKey', 'itemValue');
        
        console.log(this.localStorage.getItem('itemKey'));
        
        this.localStorage.setObject('itemKey', {
            someObject: 3
        });
        
        console.log(this.localStorage.getObject('itemKey'));
    }
}

License

The MIT License (MIT)

Copyright (c) 2018 Hacklone https://github.com/Hacklone

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.