ng-http-sw-proxy
TypeScript icon, indicating that this package has built-in type declarations

2.1.1 • Public • Published

npm version Build Status

ng-http-sw-proxy

This service proxies Angular http traffic via service worker. It is collecting sent http requests in IndexedDB and providing them to service-worker 'sync' job.

Workflow

ng-http-sw-proxy flowchart

Installation

npm install --save ng-http-sw-proxy
cp -r node_modules/ng-http-sw-proxy/service-worker ./src

Compilation

When compilation of your project is done, you need to combine service worker script. Rollup will automatically move it to your dist folder.

node src/service-worker/rollup.js

Usage

in your main module:

import { HttpSwProxyModule } from 'ng-http-sw-proxy';

@NgModule({
  imports: [
    HttpSwProxyModule,
    /* other modules*/
  ],
})
export class AppModule {
}

After importing HttpSwProxyModule @angular http service is shadowed with the new one, from ng-http-sw-proxy. component/services looks like previous:

import { Http } from '@angular/http';

@Component({
/* component setup*/
})
export class HttpProxyDemoComponent {

    public response: Observable<any>;

    constructor(private http: Http) {}

    public sendPost():void {
        this.response = this.http.post("testPost", {exampleKey: "exampleValue"}).map(res => res.json());
    }
}

Finally initialize service worker in your main file:

platformBrowserDynamic().bootstrapModule(BrowserAppModule).then(() => {
    if (process.env.NODE_ENV == 'production' && 'serviceWorker' in navigator)
        navigator.serviceWorker.register('./worker-basic.min.js').then(() => navigator.serviceWorker.ready);
});

Examples

Something missing? More documentation? Bug fixes? All PRs welcome at https://github.com/maciejtreder/ng-http-sw-proxy

Package Sidebar

Install

npm i ng-http-sw-proxy

Weekly Downloads

7

Version

2.1.1

License

MIT

Last publish

Collaborators

  • maciejtreder