Merge pull request #77 from aikoven/master

Add TypeScript definitions

Author: ulfryk

index.d.ts

@@ -0,0 +1,18 @@
+import {Middleware, Dispatch} from "redux";
+
+
+export type ThunkAction<R, S, E> = (dispatch: Dispatch<S>, getState: () => S,
+                                    extraArgument: E) => R;
+
+declare module "redux" {
+  export interface Dispatch<S> {
+    <R, E>(asyncAction: ThunkAction<R, S, E>): R;
+  }
+}
+
+
+declare const thunk: Middleware & {
+  withExtraArgument(extraArgument: any): Middleware;
+};
+
+export default thunk;

package.json

@@ -4,11 +4,13 @@
   "description": "Thunk middleware for Redux.",
   "main": "lib/index.js",
   "jsnext:main": "es/index.js",
+  "typings": "./index.d.ts",
   "files": [
     "lib",
     "es",
     "src",
-    "dist"
+    "dist",
+    "index.d.ts"
   ],
   "scripts": {
     "clean": "rimraf lib dist es",
@@ -67,7 +69,10 @@
     "eslint-config-airbnb": "1.0.2",
     "eslint-plugin-react": "^4.1.0",
     "mocha": "^2.2.5",
+    "redux": "^3.4.0",
     "rimraf": "^2.5.2",
+    "typescript": "^1.8.10",
+    "typescript-definition-tester": "0.0.4",
     "webpack": "^1.12.14"
   }
 }

test/index.js

@@ -1,5 +1,7 @@
 import chai from 'chai';
 import thunkMiddleware from '../src/index';
+import * as tt from 'typescript-definition-tester';
+
 
 describe('thunk middleware', () => {
   const doDispatch = () => {};
@@ -91,4 +93,16 @@ describe('thunk middleware', () => {
       });
     });
   });
+
+  describe('TypeScript definitions', function test() {
+    this.timeout(0);
+
+    it('should compile against index.d.ts', (done) => {
+      tt.compileDirectory(
+        __dirname,
+        fileName => fileName.match(/\.ts$/),
+        () => done()
+      );
+    });
+  });
 });

test/typescript.ts

@@ -0,0 +1,33 @@
+import {Store, Middleware} from 'redux';
+import thunk, {ThunkAction} from '../index.d.ts';
+
+
+declare const store: Store<{foo: string}>;
+
+store.dispatch(dispatch => {
+  dispatch({type: 'FOO'});
+});
+
+store.dispatch((dispatch, getState) => {
+  const state = getState();
+
+  const foo: string = state.foo;
+});
+
+const middleware: Middleware = thunk.withExtraArgument('bar');
+
+store.dispatch((dispatch, getState, extraArg) => {
+  console.log(extraArg);
+});
+
+const thunkAction: ThunkAction<void, {foo: string}, {bar: number}> =
+  (dispatch, getState, extraArg) => {
+    const foo: string = getState().foo;
+    const bar: number = extraArg.bar;
+
+    dispatch({type: 'FOO'});
+  };
+
+const thunkActionDispatchOnly: ThunkAction<void, {}, {}> = dispatch => {
+  dispatch({type: 'FOO'});
+};