Merge pull request #7 from icopp/add-typescript-definitions

Add Typescript definitions

Author: capaj

README.md

@@ -70,3 +70,13 @@ All props are optional
 - **then** runs when promise is resolved. Async will run function provided in it's render passing a resolved value as first parameter.
 - **catch** runs when promise is rejected. Async will run function provided in it's render passing an error as first parameter.
 - **pendingRender** is a node which will be outputted from Async render method while promise is pending. If none is provided, defaults to `<div/>`
+
+## To use with Typescript
+
+```
+import Async, { Props as AsyncProps } from 'react-promise'
+
+const StringAsync = Async as { new (props: AsyncProps<string>): Async<string> }
+```
+
+The type used for the generic will be matched against the type for the promise's value. This workaround is necessary because currently there's no way to directly supply generic types in Typescript.

package.json

@@ -3,6 +3,7 @@
   "version": "1.1.3",
   "description": "react.js component for dealing with promises",
   "main": "./lib/async.js",
+  "types": "./lib/async.d.ts",
   "jspm": {
     "format": "esm"
   },

src/async.d.ts

@@ -0,0 +1,20 @@
+import * as React from 'react'
+
+export interface Props<T> {
+  promise?: Promise<T>
+  before?: (handlePromise: () => void) => React.ReactNode
+  then?: (value: T) => React.ReactNode
+  catch?: (err: any) => React.ReactNode
+  pendingRender?: React.ReactNode
+}
+
+export interface State {
+  started: boolean
+  resolved: boolean
+  finished: boolean
+  rejected: boolean
+}
+
+declare class Async<T> extends React.Component<Props<T>, State> { }
+
+export default Async