[Docs] mount: Updated docs for ReactWrapper.instance(); remove docs…

… for v2's `getNode()`/`getNodes()` Fixes #1669
enzymejs · Jun 1, 2018 · 6767ce5 · 6767ce5
1 parent 0ee548f
commit 6767ce5
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 80 deletions.
diff --git a/docs/api/ReactWrapper/getNode.md b/docs/api/ReactWrapper/getNode.md
diff --git a/docs/api/ReactWrapper/getNodes.md b/docs/api/ReactWrapper/getNodes.md
diff --git a/docs/api/ReactWrapper/instance.md b/docs/api/ReactWrapper/instance.md
@@ -1,14 +1,12 @@
 # `.instance() => ReactComponent`
 
-Gets the instance of the component being rendered as the root node passed into `mount()`.
-
-NOTE: can only be called on a wrapper instance that is also the root instance.
+Returns the wrapper's underlying instance.
 
 
 
 #### Returns
 
-`ReactComponent`: The component instance.
+`ReactComponent|DOMComponent`: The retrieved instance.
 
 
 

diff --git a/docs/api/mount.md b/docs/api/mount.md
@@ -129,12 +129,6 @@ Returns a static HTML rendering of the current node.
 #### [`.get(index) => ReactElement`](ReactWrapper/get.md)
 Returns the node at the provided index of the current wrapper.
 
-#### [`.getNode() => ReactElement`](ReactWrapper/getNode.md)
-Returns the wrapper's underlying node.
-
-#### [`.getNodes() => Array<ReactElement>`](ReactWrapper/getNodes.md)
-Returns the wrapper's underlying nodes.
-
 #### [`.getDOMNode() => DOMComponent`](ReactWrapper/getDOMNode.md)
 Returns the outer most DOMComponent of the current wrapper.
 
@@ -174,8 +168,8 @@ Manually sets props of the root component.
 #### [`.setContext(context) => ReactWrapper`](ReactWrapper/setContext.md)
 Manually sets context of the root component.
 
-#### [`.instance() => ReactComponent`](ReactWrapper/instance.md)
-Returns the instance of the root component.
+#### [`.instance() => ReactComponent|DOMComponent`](ReactWrapper/instance.md)
+Returns the wrapper's underlying instance.
 
 #### [`.unmount() => ReactWrapper`](ReactWrapper/unmount.md)
 A method that un-mounts the component.

diff --git a/packages/enzyme/src/ReactWrapper.js b/packages/enzyme/src/ReactWrapper.js
@@ -190,17 +190,15 @@ class ReactWrapper {
   }
 
   /**
-   * Gets the instance of the component being rendered as the root node passed into `mount()`.
-   *
-   * NOTE: can only be called on a wrapper instance that is also the root instance.
+   * Returns the wrapper's underlying instance.
    *
    * Example:
    * ```
    * const wrapper = mount(<MyComponent />);
    * const inst = wrapper.instance();
    * expect(inst).to.be.instanceOf(MyComponent);
    * ```
-   * @returns {ReactComponent}
+   * @returns {ReactComponent|DOMComponent}
    */
   instance() {
     if (this.length !== 1) {