Code Monkey home page Code Monkey logo

ngx-reactive-webstorage's Introduction

Reactive WebStorage for Angular 4 / 5

RxJS powered Reactive storage with the feature of synchronization between LocalStorage API.

This library is inspired by the idea from @ngrx/store. The scope of the @ngrx/store has been narrowed to simple add/remove operations for the sake of the quick implementation and less boilerplate. All the methods from WebStorage API has been preserved within the library. (setItem,getItem,removeItem)

Setup

Install via npm :

npm install ngx-reactive-webstorage --save

ReactiveWebStorageModule should be imported in app.module.ts.

import { ReactiveWebStorageModule } from 'ngx-reactive-webstorage';

@NgModule({
  imports: [
    BrowserModule,
    ReactiveWebStorageModule,
    ...
  ]
  ...
})
export class AppModule {}

If LocalStorage are to be used, localstorage keys that will be used should be defined to synchronize localstorage and reactive Store at startup.

import { ReactiveWebStorageModule } from 'ngx-reactive-webstorage';

// set localstorage keys to sync with at startup
export const storageKeys = ["user", "token"];

@NgModule({
  imports: [
    BrowserModule,
    ReactiveWebStorageModule.setLocalStorageKeys(keys),
    ...
  ]
  ...
})
export class AppModule {}

Usage

Now you just have to inject the service where you need it :

import { LocalStorage, SessionStorage } from 'ngx-reactive-webstorage';

@Component({
...
})
export class AppComponent {
  user: Observable<string>;
  constructor(private localStorage: LocalStorage, private sessionStorage: SessionStorage) {
    this.user = this.localStorage.getItem("user"); // { name:"Thomas", surname: "Anderson" }
  }
  
  saveUser(user: any) {
    this.localStorage.setItem("user", user);
  }
  
  removeUser() {
    this.localStorage.removeItem("user");
  }
  
}
<p *ngIf="user | async as user">Welcome {{ user.name }}</p>

ngx-reactive-webstorage's People

Contributors

denizcoskun avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

teebo ippatev

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.