Updated API docs to use more words. Modified typings to seperate concepts to help docs

Author: mpeyper

docs/reference/api.md

@@ -6,33 +6,93 @@ route: '/reference/api'
 
 # API
 
-## `renderHook(callback[, options])`
+`react-hooks-testing-library` exports the following methods:
+
+- [`renderHook`](/reference/api#renderhook)
+- [`act`](/reference/api#act)
+
+---
+
+## `renderHook`
+
+```js
+function renderHook(
+  callback: function(props?: any): any,
+  options?: RenderHookOptions
+): RenderHookResult
+```
 
 Renders a test component that will call the provided `callback`, including any hooks it calls, every time it renders.
 
+The `renderHook` function accept the following arguments:
+
+### `callback`
+
+The function that is called each `render` of the test component. This function should call one or more hooks for testing.
+
+The `props` passed into the callback will be the `initialProps` provided in the `options` to `renderHook`, unless new props are provided by a subsequent `rerender` call.
+
+### `options`
+
+An options object to modify the execution of the `callback` function. See the [`renderHook` Options](/reference/api#renderhook-options) section for more details.
+
 > _Note: `testHook` has been renamed to `renderHook`. `testHook` will continue work in the current version with a deprecation warning, but will be removed in a future version._
 >
 > **_You should update any usages of `testHook` to use `renderHook` instead._**
 
-### Arguments
+## `renderHook` Options
+
+The `renderHook` function accepts the following options as the second parameter:
+
+### `initialProps`
+
+The initial values to pass as `props` to the `callback` function of `renderHook.
+
+### `wrapper`
 
-- `callback` (`function([props])`) - function to call each render. This function should call one or more hooks for testing
-  - The `props` passed into the callback will be the `initialProps` provided in the `options` until new props are provided by a `rerender` call
-- `options` (`object`)
-  - `initialProps` (`object`) - the initial values to pass to the `callback` function
-  - `wrapper` (`component`) - pass a React component to wrap the test component
-    - This is usually used to add context providers from `React.createContext` for the hook access with `useContext`
+A React component to wrap the test component in when rendering. This is usually used to add context providers from `React.createContext` for the hook to access with `useContext`.
 
-### Returns
+## `renderHook` Result
+
+The `renderHook` method returns an object that has a following properties:
+
+### `result`
+
+```js
+{
+  current: any,
+  error: Error
+}
+```
+
+The `current` value or the `result` will reflect whatever is returned from the `callback` passed to `renderHook`. Any thrown values will be reflected in the `error` value of the `result`.
+
+### `waitForNextUpdate`
+
+```js
+function waitForNextUpdate(): Promise<void>
+```
 
-- `result` (`object`)
-  - `current` (`any`) - the return value of the `callback` function
-  - `error` (`Error`) - the error that was thrown if the `callback` function threw an error during rendering
 - `waitForNextUpdate` (`function`) - returns a `Promise` that resolves the next time the hook renders, commonly when state is updated as the result of a asynchronous action
-- `rerender` (`function([newProps])`) - function to rerender the test component including any hooks called in the `callback` function
-  - If `newProps` are passed, the will replace the `initialProps` passed the the `callback` function for future renders
-- `unmount` (`function()`) - function to unmount the test component, commonly used to trigger cleanup effects for `useEffect` hooks
 
-## `act(callback)`
+### `rerender`
+
+```js
+function rerender(newProps?: any): void
+```
+
+A function to rerender the test component, causing any hooks to be recalculated. If `newProps` are passed, the will replace the `initialProps` passed to the `callback` function for the rerender any subsequent renders.
+
+### `unmount`
+
+```js
+function unmount(): void
+```
+
+A function to unmount the test component. This is commonly used to trigger cleanup effects for `useEffect` hooks.
+
+---
+
+## `act`
 
-This is the same [`act` function](https://testing-library.com/docs/react-testing-library/api#act) that is exported by `react-testing-library`.
+This is the same [`act` function](https://reactjs.org/docs/test-utils.html#act) that is exported by `react-test-renderer`.

package-lock.json

@@ -30,7 +30,8 @@
     "contributors:add": "all-contributors add"
   },
   "dependencies": {
-    "@babel/runtime": "^7.4.2"
+    "@babel/runtime": "^7.4.2",
+    "@types/react": "16.8.14"
   },
   "devDependencies": {
     "@babel/cli": "7.4.3",
@@ -40,7 +41,6 @@
     "@babel/plugin-transform-runtime": "7.4.3",
     "@babel/preset-env": "7.4.3",
     "@babel/preset-react": "7.0.0",
-    "@types/react": "16.8.14",
     "all-contributors-cli": "6.3.1",
     "babel-eslint": "10.0.1",
     "babel-plugin-module-resolver": "3.2.0",

package.json

@@ -1,19 +1,27 @@
-export function renderHook<P, R>(
-  callback: (props: P) => R,
-  options?: {
-    initialProps?: P,
-    wrapper?: React.ComponentType
-  }
-): {
-  readonly result: {
-    readonly current: R,
-    readonly error: Error
-  }
+import * as React from 'react'
+
+interface RenderHookOptions<P> {
+  initialProps?: P
+  wrapper?: React.ComponentType
+}
+
+interface HookResult<R> {
+  readonly current: R
+  readonly error: Error
+}
+
+interface RenderHookResult<P, R> {
+  readonly result: HookResult<R>
   readonly waitForNextUpdate: () => Promise<void>
   readonly unmount: () => boolean
-  readonly rerender: (hookProps?: P) => void
+  readonly rerender: (newProps?: P) => void
 }
 
+export function renderHook<P, R>(
+  callback: (props: P) => R,
+  options?: RenderHookOptions<P>
+): RenderHookResult<P, R>
+
 export const testHook: typeof renderHook
 
 export function act(callback: () => void): void