Updated docs for ReactWrapper.instance() enzymejs#1669

conor-cafferkey-sociomantic · Jul 13, 2018 · fb19fda · fb19fda
1 parent cd28cee
commit fb19fda
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 10 deletions.
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
@@ -174,8 +174,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
@@ -191,17 +191,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) {