Merge pull request #3 from MichaelDeBoey/typescript

Add TypeScript typings

Author: erikras

package-scripts.js

@@ -55,7 +55,7 @@ module.exports = {
       description: 'Generates table of contents in README',
       script: 'doctoc README.md'
     },
-    copyTypes: npsUtils.copy('src/*.js.flow dist'),
+    copyTypes: npsUtils.copy('src/*.js.flow src/*.d.ts dist'),
     lint: {
       description: 'lint the entire project',
       script: 'eslint .'

package.json

@@ -5,6 +5,7 @@
   "main": "dist/final-form-arrays.cjs.js",
   "jsnext:main": "dist/final-form-arrays.es.js",
   "module": "dist/final-form-arrays.es.js",
+  "typings": "dist/index.d.js",
   "files": ["dist"],
   "scripts": {
     "start": "nps",

src/index.d.ts

@@ -0,0 +1,17 @@
+import { Mutator } from 'final-form'
+
+type DefaultType = { [key: string]: Mutator }
+
+export default DefaultType
+
+/** The shape of the mutators once final-form has bound them to state */
+export type Mutators = {
+  insert: (name: string, index: number, value: any) => void
+  move: (name: string, from: number, to: number) => void
+  pop: (name: string) => any
+  push: (name: string, value: any) => void
+  remove: (name: string, index: number) => any
+  shift: (name: string) => any
+  swap: (name: string, indexA: number, indexB: number) => void
+  unshift: (name: string, value: any) => void
+}