v1.0.0

Author: Sergio Daniel Xalambrí

.babelrc

@@ -0,0 +1,6 @@
+{
+  "plugins": [
+    "transform-es2015-modules-commonjs",
+    "transform-es2015-arrow-functions"
+  ]
+}

.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "airbnb",
+}

.gitignore

@@ -31,3 +31,5 @@ node_modules
 
 # Optional REPL history
 .node_repl_history
+
+build

.npmignore

@@ -0,0 +1,6 @@
+node_modules
+lib
+test
+logs
+*.log
+.babelrc

README.md

@@ -1,2 +1,19 @@
 # redux-catch
-Error catcher middleware for Redux reducers and middlewares
+Error catcher middleware for Redux reducers and middlewares.
+
+## API
+### Apply middleware
+```javascript
+import { createStore, applyMiddleware } from 'redux';
+
+import reduxCatch from 'redux-catch';
+
+import reducer from './reducer';
+
+const store = createStore(reducer, applyMiddleware(
+  reduxCatch(error => console.error(error))
+));
+```
+- `reduxCatch` receive a function to use when an error happen.
+- The error handler function could be just a `console.error` like the example above or a function to log the error in some kind of error tracking platform.
+- You should use this middleware as the first middleware in the chain, so its allowed to catch all the possible errors in the application.

lib/index.js

@@ -0,0 +1,10 @@
+const catchMiddleware = errorHandler => () => next => action => {
+  try {
+    return next(action);
+  } catch (error) {
+    errorHandler(error);
+    return error;
+  }
+};
+
+export default catchMiddleware;

package.json

@@ -0,0 +1,44 @@
+{
+  "name": "redux-catch",
+  "version": "1.0.0",
+  "description": "Error catcher middleware for Redux reducers and middlewares",
+  "main": "build/index.js",
+  "scripts": {
+    "lint": "eslint lib/index.js",
+    "prebuild": "npm run lint",
+    "build": "babel lib --out-dir build",
+    "pretest": "npm run build",
+    "test": "babel-node test/index.js | tap-spec",
+    "prepublish": "npm run test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sergiodxa/redux-catch.git"
+  },
+  "keywords": [
+    "redux",
+    "error",
+    "catch",
+    "middleware"
+  ],
+  "author": "Sergio Daniel Xalambrí <[email protected]> (http://sergio.xalambri.com.ar/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sergiodxa/redux-catch/issues"
+  },
+  "homepage": "http://sergio.xalambri.com.ar/redux-catch",
+  "devDependencies": {
+    "babel": "6.5.2",
+    "babel-cli": "6.7.5",
+    "babel-core": "6.7.6",
+    "babel-eslint": "6.0.2",
+    "babel-plugin-transform-es2015-arrow-functions": "6.5.2",
+    "babel-plugin-transform-es2015-modules-commonjs": "6.7.4",
+    "eslint": "2.7.0",
+    "eslint-config-airbnb": "7.0.0",
+    "eslint-plugin-jsx-a11y": "0.6.2",
+    "eslint-plugin-react": "4.3.0",
+    "tap-spec": "4.1.1",
+    "tape": "4.5.1"
+  }
+}

test/index.js

@@ -0,0 +1,44 @@
+import test from 'tape';
+
+import middleware from '../build/index.js';
+
+const mockedMiddlewareAPI = {};
+const baseError = new Error('There was an error.');
+
+test('Catch middleware - error case', t => {
+  const mockedNext = () => {
+    throw baseError;
+  };
+
+  t.plan(2);
+
+  function errorHandler(error) {
+    t.ok(
+      error.message === baseError.message,
+      'it should receive the expected error message in the `errorHandler`'
+    );
+  }
+
+  const error = middleware(errorHandler)(mockedMiddlewareAPI)(mockedNext)();
+
+  t.ok(
+    error.message === baseError.message,
+    'it should return the expected error message'
+  );
+});
+
+test('Catch middleware - success case', t => {
+  const mockedNext = action => action;
+
+  t.plan(1);
+
+  const action = middleware(error => error)(mockedMiddlewareAPI)(mockedNext)({
+    type: 'TEST_ACTION',
+  });
+
+  t.equal(
+    action.type,
+    'TEST_ACTION',
+    'it should be the passed action'
+  );
+});