Release/5.0.0 docs

README.md

@@ -42,6 +42,7 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
+
 - [The problem](#the-problem)
 - [The solution](#the-solution)
 - [When to use this library](#when-to-use-this-library)
@@ -141,17 +142,21 @@ npm install --save-dev @testing-library/react-hooks
 ### Peer Dependencies
 
 `react-hooks-testing-library` does not come bundled with a version of
-[`react`](https://www.npmjs.com/package/react) or
-[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
-the specific version you want to test against. Generally, the installed versions for `react` and
-`react-test-renderer` should have matching versions:
+[`react`](https://www.npmjs.com/package/react) to allow you to install the specific version you want
+to test against. It also does not come installed with a specific renderer, we currently support
+[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) and
+[`react-dom`](https://www.npmjs.com/package/react-dom), you only need to install one of them.
+However,you can install both, but `react-test-renderer` is the default, for more information see the
+[installation docs](https://react-hooks-testing-library.com/#installation). Generally, the installed
+versions for `react` and the selected renderer should have matching versions:
 
 ```sh
 npm install react@^16.9.0
 npm install --save-dev react-test-renderer@^16.9.0
 ```
 
-> **NOTE: The minimum supported version of `react` and `react-test-renderer` is `^16.9.0`.**
+> **NOTE: The minimum supported version of `react`, `react-test-renderer` and `react-dom` is
+> `^16.9.0`.**
 
 ## API
 

docs/api-reference.md

@@ -11,14 +11,15 @@ route: '/reference/api'
 - [`act`](/reference/api#act)
 - [`cleanup`](/reference/api#cleanup)
 - [`addCleanup`](/reference/api#addcleanup)
+- [`removeCleanup`](/reference/api#removecleanup)
 
 ---
 
 ## `renderHook`
 
-```js
+```ts
 function renderHook(
-  callback: function(props?: any): any,
+  callback: (props?: any): any,
   options?: RenderHookOptions
 ): RenderHookResult
 ```
@@ -61,7 +62,7 @@ The `renderHook` function returns an object that has the following properties:
 
 ### `result`
 
-```js
+```ts
 {
   all: Array<any>
   current: any,
@@ -77,7 +78,7 @@ returned at the time.
 
 ### `rerender`
 
-```js
+```ts
 function rerender(newProps?: any): void
 ```
 
@@ -86,13 +87,24 @@ passed, they will replace the `callback` function's `initialProps` for subsequen
 
 ### `unmount`
 
-```js
+```ts
 function unmount(): void
 ```
 
 A function to unmount the test component. This is commonly used to trigger cleanup effects for
 `useEffect` hooks.
 
+### `hydrate`
+
+```ts
+function hydrate(): void
+```
+
+> This is only used when using the `server` module. See [Rendering](/renderer) for more information
+
+A function to hydrate the component. This is commonly used before `act` calls and after `rerender`
+calls.
+
 ### `...asyncUtils`
 
 Utilities to assist with testing asynchronous behaviour. See the
@@ -102,15 +114,15 @@ Utilities to assist with testing asynchronous behaviour. See the
 
 ## `act`
 
-This is the same [`act` function](https://reactjs.org/docs/test-utils.html#act) that is exported by
-`react-test-renderer`.
+This is the same [`act` function](https://reactjs.org/docs/test-utils.html#act) function that is
+exported from your chosen renderer. Although, they both work the same.
 
 ---
 
 ## `cleanup`
 
-```js
-function cleanup: Promise<void>
+```ts
+function cleanup(): Promise<void>
 ```
 
 Unmounts any rendered hooks rendered with `renderHook`, ensuring all effects have been flushed. Any
@@ -142,7 +154,8 @@ module.exports = {
 ```
 
 Alternatively, you can change your test to import from `@testing-library/react-hooks/pure` instead
-of the regular imports.
+of the regular imports. This applys to any of our export methods documented in
+[Rendering](/rendering#being-specific).
 
 ```diff
 - import { renderHook, cleanup, act } from '@testing-library/react-hooks'
@@ -156,8 +169,8 @@ variable to `true` before importing `@testing-library/react-hooks` will also dis
 
 ## `addCleanup`
 
-```js
-function addCleanup(callback: function(): void|Promise<void>): function(): void
+```ts
+function addCleanup(callback: () => void | Promise<void>): (): void
 ```
 
 Add a callback to be called during [`cleanup`](/reference/api#cleanup), returning a function to
@@ -173,8 +186,8 @@ be resolved before moving onto the next cleanup callback.
 
 ## `removeCleanup`
 
-```js
-function removeCleanup(callback: function(): void|Promise<void>): void
+```ts
+function removeCleanup(callback: () => void | Promise<void>): void
 ```
 
 Removes a cleanup callback previously added with [`addCleanup`](/reference/api#addCleanup). Once
@@ -187,10 +200,8 @@ removed, the provided callback will no longer execute as part of running
 
 ### `waitForNextUpdate`
 
-```js
-function waitForNextUpdate(options?: {
-  timeout?: number
-}): Promise<void>
+```ts
+function waitForNextUpdate(options?: { timeout?: number }): Promise<void>
 ```
 
 Returns a `Promise` that resolves the next time the hook renders, commonly when state is updated as
@@ -202,12 +213,15 @@ The maximum amount of time in milliseconds (ms) to wait. By default, no timeout
 
 ### `waitFor`
 
-```js
-function waitFor(callback: function(): boolean|void, options?: {
-  interval?: number,
-  timeout?: number,
-  suppressErrors?: boolean
-}): Promise<void>
+```ts
+function waitFor(
+  callback: () => boolean | void,
+  options?: {
+    interval?: number
+    timeout?: number
+    suppressErrors?: boolean
+  }
+): Promise<void>
 ```
 
 Returns a `Promise` that resolves if the provided callback executes without exception and returns a
@@ -232,12 +246,15 @@ rejected. By default, errors are suppressed for this utility.
 
 ### `waitForValueToChange`
 
-```js
-function waitForValueToChange(selector: function(): any, options?: {
-  interval?: number,
-  timeout?: number,
-  suppressErrors?: boolean
-}): Promise<void>
+```ts
+function waitForValueToChange(
+  selector: () => any,
+  options?: {
+    interval?: number
+    timeout?: number
+    suppressErrors?: boolean
+  }
+): Promise<void>
 ```
 
 Returns a `Promise` that resolves if the value returned from the provided selector changes. It is

docs/installation.md

@@ -0,0 +1,81 @@
+---
+name: Installation
+route: '/installation'
+---
+
+# Installation
+
+## Getting started
+
+This module is distributed via [npm](https://www.npmjs.com/) which is bundled with
+[node](https://nodejs.org) and should be installed as one of your project's `devDependencies`:
+
+```sh
+# if you're using npm
+npm install --save-dev @testing-library/react-hooks
+# if you're using yarn
+yarn add --dev @testing-library/react-hooks
+```
+
+### Peer Dependencies
+
+`react-hooks-testing-library` does not come bundled with a version of
+[`react`](https://www.npmjs.com/package/react) to allow you to install the specific version you want
+to test against. It also does not come installed with a specific renderer, we currently support
+[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) and
+[`react-dom`](https://www.npmjs.com/package/react-dom), you only need to install one of them. For
+more information see [Renderer](/installation#renderer)
+
+```sh
+npm install react@^16.9.0
+npm install --save-dev react-test-renderer@^16.9.0
+```
+
+> **NOTE: The minimum supported version of `react`, `react-test-renderer` and `react-dom` is
+> `^16.9.0`.**
+
+## Renderer
+
+React requires a rendering engine, typically when creating an application people use `react-dom`.
+When running tests, React still requires an engine. We currently support two different engines:
+
+- `react-test-renderer`
+- `react-dom`
+
+If you have both installed in your project, assuming you're using the default imports (see below)
+the library defaults to using `react-test-renderer`. This is because rtr is the defacto test
+renderer for `react-native` for tests and it enables hooks to be correctly tested that are written
+for both `react` & `react-native`.
+
+```js
+import { renderHook } from '@testing-library/react-hooks'
+```
+
+> The auto detection function may not work if tests are bundled to run in the browser.
+
+## Being specific
+
+If, however, for certain tests you want to use a specific renderer (e.g. you want to use `react-dom`
+for SSR) you can import the server module directly:
+
+```ts
+import { renderHook } from '@testing-library/react-hooks/server`
+```
+
+We have the following exports available:
+
+```ts
+import { renderHook, act } from '@testing-library/react-hooks' // will try to auto-detect
+
+import { renderHook, act } from '@testing-library/react-hooks/dom' // will use react-dom
+
+import { renderHook, act } from '@testing-library/react-hooks/native' // will use react-test-renderer
+
+import { renderHook, act } from '@testing-library/react-hooks/server' // will use react-dom
+```
+
+## Testing Framework
+
+In order to run tests, you will probably want to be using a test framework. If you have not already
+got one, we recommend using [Jest](https://jestjs.io/), but this library should work without issues
+with any of the alternatives.

docs/introduction.md

@@ -55,33 +55,3 @@ the results.
 
 1. Your hook is defined alongside a component and is only used there
 2. Your hook is easy to test by just testing the components using it
-
-## Installation
-
-This module is distributed via [npm](https://www.npmjs.com/) which is bundled with
-[node](https://nodejs.org) and should be installed as one of your project's `devDependencies`:
-
-```sh
-npm install --save-dev @testing-library/react-hooks
-```
-
-### Peer Dependencies
-
-`react-hooks-testing-library` does not come bundled with a version of
-[`react`](https://www.npmjs.com/package/react) or
-[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) to allow you to install
-the specific version you want to test against. Generally, the installed versions for `react` and
-`react-test-renderer` should have matching versions:
-
-```sh
-npm install react@^16.9.0
-npm install --save-dev react-test-renderer@^16.9.0
-```
-
-> **NOTE: The minimum supported version of `react` and `react-test-renderer` is `^16.9.0`.**
-
-## Testing Framework
-
-In order to run tests, you will probably want to be using a test framework. If you have not already
-got one, we recommend using [Jest](https://jestjs.io/), but this library should work without issues
-with any of the alternatives.

doczrc.js

@@ -18,6 +18,7 @@ export default {
   },
   menu: [
     { name: 'Introduction' },
+    { name: 'Installation' },
     { name: 'Usage', menu: ['Basic Hooks', 'Advanced Hooks'] },
     { name: 'API Reference' }
   ]