chore: update vue api doc to match implementation

Author: davidnixon

docs/vue-testing-library/api.mdx

@@ -7,29 +7,27 @@ title: API
 
 It also exposes these methods:
 
-- [`render(Component, options, callback)`](#rendercomponent-options-callback)
+- [`render(Component, options)`](#rendercomponent-options)
   - [Parameters](#parameters)
     - [Component](#component)
     - [Options](#options)
-    - [Callback Function](#callback-function)
   - [`render` result](#render-result)
     - [`...queries`](#queries)
     - [`container`](#container)
     - [`baseElement`](#baseelement)
-    - [`debug(element)`](#debugelement)
-    - [`unmount()`](#unmount)
-    - [`isUnmounted()`](#isunmounted)
-    - [`html()`](#html)
-    - [`emitted()`](#emitted)
-    - [`updateProps(props)`](#updatepropsprops)
+    - [`debug`](#debug)
+    - [`unmount`](#unmount)
+    - [`html`](#html)
+    - [`emitted`](#emitted)
+    - [`rerender`](#rerenderprops)
 - [`fireEvent`](#fireevent)
   - [`touch(elem)`](#touchelem)
   - [`update(elem, value)`](#updateelem-value)
 - [`cleanup`](#cleanup)
 
 ---
 
-## `render(Component, options, callback)`
+## `render(Component, options)`
 
 The `render` function is the only way of rendering components in Vue Testing
 Library.
@@ -44,10 +42,9 @@ function render(Component, options, callbackFunction) {
     baseElement,
     debug,
     unmount,
-    isUnmounted,
     html,
     emitted,
-    updateProps,
+    rerender,
   }
 }
 ```
@@ -106,20 +103,6 @@ If the `container` is specified, then this defaults to that, otherwise this
 defaults to `document.body`. `baseElement` is used as the base element for the
 queries as well as what is printed when you use `debug()`.
 
-#### Callback Function
-
-```js
-function callbackFunction(vueInstance, vuexStore, router) {}
-```
-
-A callback function that receives the Vue instance as a parameter. Its return
-value is merged with [options](#options), allowing 3rd party plugins to be
-installed prior to mount. To see how this works, see the example using
-[`vue-i18n`](https://github.com/testing-library/vue-testing-library/blob/master/src/__tests__/translations-vue-i18n.js).
-
-The function will also receive the Store or the Router object if the associated
-option was passed in during render.
-
 ### `render` result
 
 The `render` method returns an object that has a few properties:
@@ -164,13 +147,10 @@ renders its HTML directly in the body.
 > Note: the queries returned by the `render` looks into `baseElement`, so you
 > can use queries to test your portal component without the `baseElement`.
 
-#### `debug(element)`
+#### `debug`
 
 This method is a shortcut for `console.log(prettyDOM(element))`.
 
-`element` can either be a DOM element or an array containing DOM elements. It
-defaults to `baseElement`
-
 ```jsx
 import {render} from '@testing-library/vue'
 
@@ -183,8 +163,6 @@ debug()
 // <div>
 //   <h1>Hello World</h1>
 // </div>
-
-// you can also pass an element: debug(getByTestId('messages'))
 ```
 
 This is a simple wrapper around `prettyDOM` which is also exposed and comes from
@@ -195,10 +173,6 @@ This is a simple wrapper around `prettyDOM` which is also exposed and comes from
 An alias for `@vue/test-utils`
 [destroy](https://vue-test-utils.vuejs.org/api/wrapper/#destroy).
 
-#### `isUnmounted()`
-
-Returns whether if a Vue component has been destroyed.
-
 #### `html()`
 
 An alias for `@vue/test-utils`
@@ -209,12 +183,15 @@ An alias for `@vue/test-utils`
 An alias for `@vue/test-utils`
 [emitted](https://vue-test-utils.vuejs.org/api/wrapper/#emitted).
 
-#### `updateProps(props)`
+#### `rerender(props)`
 
 An alias for `@vue/test-utils`
 [setProps](https://vue-test-utils.vuejs.org/api/wrapper/#setprops).
 
-It returns a Promise through `wait()`, so you can `await updateProps(...)`.
+It returns a Promise through so you can `await rerender(...)`.
+
+See
+[update properties example](vue-testing-library/examples.mdx#example-updating-properties).
 
 ---
 

docs/vue-testing-library/examples.mdx

@@ -50,6 +50,50 @@ test('increments value on click', async () => {
 })
 ```
 
+## Example updating properties:
+
+```html
+<template>
+  <div>
+    <p>The sky is {{ sky }}</p>
+    <p>And the grass is {{ grass }}</p>
+  </div>
+</template>
+
+<script>
+  export default {
+    props: {
+      sky: {type: String, default: 'green'},
+      grass: {type: String, default: 'blue'},
+    },
+  }
+</script>
+```
+
+```js
+import {render} from '@testing-library/vue'
+import Component from './Component.vue'
+
+test('properly handles property updates', async () => {
+  const {getByText, rerender} = render(Component, {
+    props: {
+      sky: 'green',
+      grass: 'blue',
+    },
+  })
+
+  // Asserts initial state.
+  getByText('The sky is green')
+  getByText('And the grass is blue')
+
+  await rerender({sky: 'Aquamarine'})
+
+  // Asserts updated state
+  getByText('The sky is Aquamarine')
+  getByText('And the grass is blue')
+})
+```
+
 ## Example using `v-model`:
 
 ```html