imagineeasy-angular-http-watcher

imagineasy-angular-http-watcher

HTTP Watcher Module

This is initially based on the concept described in Authentication in AngularJS (or similar) based application and - https://github.com/witoldsz/angular-http-auth

But we extended it to be a general notification (and buffering) system for all http requests an angular app does via the $http service.

Usage

• Install via npm: npm install --save imagineeasy-angular-http-watcher
• Include as a dependency in your app: angular.module('myApp', ['http-watch'])

Manual

This module installs $http interceptor and provides the httpWatcher service.

The $http interceptor does the following:

If an HTTP request fails, the event network:http-error is broadcasted with the configuration object (this is the requested URL, payload and parameters) of said request. If the HTTP Error-Code is in the bufferList, it will be buffered and can be replayed at any given time using the continue() method of the httpWatcher service.

You are responsible to invoke this method after you handled the error. Example:

/** @ngInject */
return function(httpWatcher) {
    httpWatcher.continue();
};

Ignoring the interceptor

Sometimes you might not want the interceptor to intercept a request even if one returns a http error code. In a case like this you can add ignoreHttpWatcher: true to the request config.

Disabling the buffering of requests

If needed, you can also add saveOnHttpError: false|true to the request config to specifically say you want to allow/disallow buffering a request regardless of the response code.

Specifing custom default values

If you need a custom event name oder you want to change the defaults which http statuses are saved and which not in your app, you can do this easily by using the httpWatcherConfig provider in your app. On initialization this will be used by the interceptor.

Currently support are these values, shown with their default values, all optional:

angular.module('your-app', []).config(function(httpWatcherConfigProvider) {
  httpWatcherConfigProvider.setConfig({
    eventNames: {
      error: 'network:http-error',
      continue: 'network:continue',
      reject: 'network:reject'
    },
    status: {
      0: true,
      408: true,
      401: true
    }
  });
});