resolves #116

Author: quisido

default.d.ts

@@ -1,6 +1,8 @@
+import DispatchFunction from './types/dispatch-function';
 import Dispatchers from './types/dispatchers';
+import NewGlobalState from './types/new-global-state';
 
-export type Dispatch = Dispatchers<State, Reducers>;
+export type Dispatch = DispatchFunction<State> & Dispatchers<State, Reducers>;
 
 export interface Reducers { }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "reactn",
-  "version": "2.1.7",
+  "version": "2.2.0",
   "author": "Charles Stover <[email protected]>",
   "description": "React, but with built-in global state management.",
   "homepage": "https://github.com/CharlesStover/reactn#readme",
@@ -36,7 +36,7 @@
     "@babel/preset-env": "^7.4.2",
     "@babel/preset-typescript": "^7.3.3",
     "@testing-library/jest-dom": "^4.0.0",
-    "@testing-library/react": "^8.0.5",
+    "@testing-library/react": "8.0.5",
     "@types/jest": "^24.0.11",
     "@types/node": "^12.6.2",
     "@types/react": "^16.7.13",
@@ -46,8 +46,8 @@
     "eslint": "^5.15.2",
     "eslint-plugin-react": "^7.12.4",
     "jest": "^24.6.0",
-    "react": "^16.8.6",
-    "react-dom": "^16.8.6",
+    "react": "~16.8",
+    "react-dom": "~16.8",
     "ts-jest": "^24.0.1",
     "ts-node": "^8.0.2",
     "typescript": "^3.3.1"

src/global-state-manager.ts

@@ -1,5 +1,6 @@
 import { Reducers, State } from '../default';
 import Callback from '../types/callback';
+import DispatchFunction from '../types/dispatch-function';
 import Dispatcher, { ExtractArguments } from '../types/dispatcher';
 import Dispatchers from '../types/dispatchers';
 import Middleware, { MiddlewareCreator } from '../types/middleware';
@@ -135,14 +136,25 @@ export default class GlobalStateManager<
   ): Dispatcher<G, A> {
     return (...args: A): Promise<G> => {
       return this.set(
-        reducer(this.state, this.dispatchers, ...args),
-        name,
+        reducer(this.state, this.dispatcherMap, ...args),
+        name, 
         args,
       )
         .then((): G => this.state);
     };
   }
 
+  // The dispatcher map, contrary to this.dispatchers, is the map that belongs
+  //   *to* a dispatcher. In addition to the map *of* dispatchers, it includes
+  //   a dispatch function that sets the global state.
+  public get dispatcherMap(): DispatchFunction<G> & Dispatchers<G, R> {
+    const dispatch: DispatchFunction<G> = (newGlobalState: NewGlobalState<G>): Promise<G> =>
+      this.set(newGlobalState).then((): G => this.state);
+    return Object.assign(dispatch, this.dispatchers);
+  }
+
+  // The dispatchers are a map *of* dispatchers. This is in contrast to
+  //   this.dispatcherMap, which is a map that belongs *to* a dispatcher.
   public get dispatchers(): Dispatchers<G, R> {
     return copyObject(this._dispatchers);
   }

src/index.ts

@@ -4,6 +4,7 @@ import {
   ReactNComponentClass,
   ReactNPureComponentClass,
 } from '../types/component-class';
+import DispatchFunction from '../types/dispatch-function';
 import Dispatcher, { ExtractArguments, PropertyDispatcher } from '../types/dispatcher';
 import Dispatchers from '../types/dispatchers';
 import NewGlobalState from '../types/new-global-state';
@@ -93,7 +94,7 @@ interface ReactN extends Omit<typeof React, 'Component' | 'default' | 'PureCompo
 
   // useDispatch()
   useDispatch<G extends {} = State, R extends {} = Reducers>(
-  ): Dispatchers<G, R>;
+  ): DispatchFunction<G> & Dispatchers<G, R>;
 
   // useDispatch(Function)
   useDispatch<G extends {} = State, R extends {} = Reducers, A extends any[] = any[]>(

src/set-global.ts

@@ -30,7 +30,7 @@ export default function _setGlobal<
         globalStateManager,
         callback(
           globalStateManager.state,
-          globalStateManager.dispatchers,
+          globalStateManager.dispatcherMap,
           stateChange,
         ),
       )

src/use-dispatch.ts

@@ -1,6 +1,7 @@
 import { useContext } from 'react';
 import useForceUpdate from 'use-force-update';
 import { Reducers, State } from '../default';
+import DispatchFunction from '../types/dispatch-function';
 import Dispatcher, {
   ExtractArguments,
   PropertyDispatcher,
@@ -37,7 +38,7 @@ export default function _useDispatch<
   R extends {} = Reducers,
 >(
   overrideGlobalStateManager: GlobalStateManager<G, R> | null,
-): Dispatchers<G, R>;
+): DispatchFunction<G> & Dispatchers<G, R>;
 
 // useDispatch(Function)
 export default function _useDispatch<
@@ -113,7 +114,7 @@ export default function _useDispatch<
 
   // Return all dispatchers.
   if (typeof reducer === 'undefined') {
-    return globalStateManager.dispatchers;
+    return globalStateManager.dispatcherMap;
   }
 
   // Use a custom reducer.

tests/context/use-dispatch-undefined.test.ts

@@ -78,8 +78,8 @@ describe('Context useDispatch()', (): void => {
   });
 
 
-  it('should return an object', (): void => {
-    expect(typeof dispatchers).toBe('object');
+  it('should return a function', (): void => {
+    expect(dispatchers).toBeInstanceOf(Function);
   });
 
   it('should return the global dispatch object', async (): Promise<void> => {

tests/global-state-manager/create-dispatcher.test.ts

@@ -71,9 +71,10 @@ describe('GlobalStateManager.createDispatcher', (): void => {
       expect(spy).toHaveBeenCalledTimes(1);
       expect(spy).toHaveBeenCalledWith(
         startState,
-        globalStateManager.dispatchers,
+        expect.anything(),
         ...REDUCER_ARGS,
       );
+      expect(spy.mock.calls[0][1].toString()).toBe(globalStateManager.dispatcherMap.toString());
     });
 
     const spy = spyOn('set');

tests/global-state-manager/dispatcher-map.test.ts

@@ -0,0 +1,40 @@
+import GlobalStateManager from '../../src/global-state-manager';
+import { G, INITIAL_REDUCERS, INITIAL_STATE, R } from '../utils/initial';
+
+const STATE_CHANGE: Partial<G> = {
+  x: true,
+};
+
+const NEW_STATE: G = {
+  ...INITIAL_STATE,
+  ...STATE_CHANGE,
+};
+
+describe('GlobalStateManager.dispatcherMap', (): void => {
+
+  let globalStateManager: GlobalStateManager<G, R>;
+  beforeEach((): void => {
+    globalStateManager = new GlobalStateManager<G, R>(INITIAL_STATE, INITIAL_REDUCERS);
+  });
+
+
+
+  it('should be a function with 1 argument', (): void => {
+    expect(globalStateManager.dispatcherMap).toBeInstanceOf(Function);
+    expect(globalStateManager.dispatcherMap).toHaveLength(1);
+  });
+
+  it('should update and return the global state', async (): Promise<void> => {
+    expect(globalStateManager.state).not.toEqual(NEW_STATE);
+    const newGlobalState: G = await globalStateManager.dispatcherMap(STATE_CHANGE);
+    expect(newGlobalState).toEqual(NEW_STATE);
+    expect(globalStateManager.state).toEqual(NEW_STATE);
+  });
+
+  it('should have a property for each reducer', (): void => {
+    for (const reducer of Object.keys(INITIAL_REDUCERS)) {
+      expect(globalStateManager.dispatcherMap).toHaveProperty(reducer);
+      expect(globalStateManager.dispatcherMap[reducer]).toBeInstanceOf(Function);
+    }
+  });
+});

tests/provider/set-global.test.ts

@@ -1,4 +1,6 @@
 import createProvider from '../../src/create-provider';
+import DispatchFunction from '../../types/dispatch-function';
+import Dispatchers from '../../types/dispatchers';
 import ReactNProvider from '../../types/provider';
 import { G, INITIAL_REDUCERS, INITIAL_STATE, R } from '../utils/initial';
 import { hasContext } from '../utils/react-version';
@@ -43,11 +45,12 @@ describe('Provider.setGlobal', (): void => {
   it(
     'should execute a callback with the new state',
     async (): Promise<void> => {
-      const CALLBACK: jest.Mock<void, []> = jest.fn();
+      const CALLBACK: jest.Mock<void, [ G, DispatchFunction<G> & Dispatchers<G, R>]> = jest.fn();
       await Provider.setGlobal(STATE_CHANGE, CALLBACK);
       expect(CALLBACK).toHaveBeenCalledTimes(1);
       expect(CALLBACK)
-        .toHaveBeenCalledWith(NEW_STATE, Provider.dispatch, STATE_CHANGE);
+        .toHaveBeenCalledWith(NEW_STATE, expect.anything(), STATE_CHANGE);
+      // expect(CALLBACK.mock.calls[0][1].toString()).toBe(Provider.dispatcherMap.toString());
     }
   );