feat(action): add typesafe Error

[#33]

Author: hitmands

src/__snapshots__/redux-fluent.e2e.spec.ts.snap

@@ -10,3 +10,31 @@ Object {
   ],
 }
 `;
+
+exports[`redux-fluent E2E should delete a todo 1`] = `
+Object {
+  "todos": Array [
+    Object {
+      "id": "first-todo-id",
+      "status": "pending",
+    },
+  ],
+}
+`;
+
+exports[`redux-fluent E2E should delete a todo 2`] = `
+Object {
+  "todos": Array [
+    Object {
+      "id": "first-todo-id",
+      "status": "pending",
+    },
+  ],
+}
+`;
+
+exports[`redux-fluent E2E should delete a todo 3`] = `
+Object {
+  "todos": Array [],
+}
+`;

src/create-action/createAction.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line no-unused-vars
-import { FSA } from 'flux-standard-action';
+import { ErrorFSA, FSA } from 'flux-standard-action';
 
 
 export interface ReduxFluentAction<
@@ -10,11 +10,21 @@ export interface ReduxFluentAction<
   type: T;
 }
 
+export interface ReduxFluentActionError<
+  T extends string = string,
+  E extends Error = Error,
+  M = void,
+  > extends ErrorFSA<E, M> {
+  type: T;
+}
+
 type Formatter<T, R> = (rawPayload: any, rawMeta: any, T: T) => R;
 export type RFA<T extends string = string, P = any, M = any> = ReduxFluentAction<T, P, M>;
+export type RFAE<T extends string = string, P extends Error = Error, M = any> = ReduxFluentActionError<T, P, M>;
 
 export interface ActionCreator<T extends string, P, M> {
   readonly type: T;
+  <E extends Error = Error, RM = any>(rawPayload?: E, rawMeta?: RM): RFAE<T, E, M>
   <RP = any, RM = any>(rawPayload?: RP, rawMeta?: RM): RFA<T, P, M>;
 }
 

src/redux-fluent.e2e.spec.ts

@@ -1,4 +1,5 @@
 import { createStore } from 'redux';
+import { isError } from 'flux-standard-action';
 import {
   createAction,
   combineReducers,
@@ -14,12 +15,19 @@ describe('redux-fluent E2E', () => {
 
   const actions = {
     addTodo: createAction<'todos | add', Todo>('todos | add'),
+    deleteTodo: createAction<'todos/:id | delete', Todo>('todos/:id | delete'),
   };
 
   const todos = createReducer<'todos', Todo[]>('todos')
     .actions(
-      ofType(actions.addTodo)
-        .map(((state, action) => state.concat(action.payload))),
+      ofType(actions.addTodo).map(
+        ((state, action) => state.concat(action.payload)),
+      ),
+      ofType(actions.deleteTodo).map(
+        ((state, action) => (isError(action)
+          ? state
+          : state.filter(({ id }) => id !== action.payload.id))),
+      ),
     )
     .default(() => []);
 
@@ -37,4 +45,27 @@ describe('redux-fluent E2E', () => {
       store.getState(),
     ).toMatchSnapshot();
   });
+
+  it('should delete a todo', () => {
+    const store = createStore(rootReducer);
+    const todo = {
+      id: 'first-todo-id',
+      status: 'pending',
+    };
+
+    store.dispatch(actions.addTodo(todo));
+    expect(
+      store.getState(),
+    ).toMatchSnapshot();
+
+    store.dispatch(actions.deleteTodo(new Error('something went wrong')));
+    expect(
+      store.getState(),
+    ).toMatchSnapshot();
+
+    store.dispatch(actions.deleteTodo(todo));
+    expect(
+      store.getState(),
+    ).toMatchSnapshot();
+  });
 });