react-component-instance 0.0.7 → 0.0.9

package/README.md

@@ -11,17 +11,28 @@ import getInstance from 'react-component-instance'
 **Note** that for use with _Testing Library_ import from `react-component-instance/container`
 
 ```javascript
-import getInstance from 'react-component-instance/container'
-
 import {
   render
 } from '@testing-library/react'
 
-const {
-  container
-} = render(
-  <Component />
-)
+import getInstance from 'react-component-instance/container'
 
-const instance = getInstance(container)
+describe('`getInstance`', () => {
+  class Component extends React.Component {
+    render () {
+      return <div />
+    }
+  }
+
+  it('gets the instance', () => {
+    const {
+      container
+    } = render(
+      <Component />
+    )
+
+    expect(getInstance(container))
+      .toBeInstanceOf(Component)
+  })
+})
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-component-instance",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Get a React class component instance from its DOM Element",
   "keywords": [
     "react",
@@ -41,7 +41,7 @@
     "@testing-library/react": "^16.2.0",
     "@types/debug": "^4.1.12",
     "@types/jest": "^29.5.14",
-    "@types/react": "^19.0.11",
+    "@types/react": "^19.0.12",
     "core-js": "^3.41.0",
     "eslint": "^9.22.0",
     "eslint-plugin-react": "^7.37.4",

package/src/container/index.mjs

@@ -1,4 +1,5 @@
 /**
+ *  @typedef {import('@testing-library/react').RenderResult} RenderType
  *  @typedef {ReactComponentInstanceTypes.FiberRootNode} FiberRootNode
  */
 
@@ -21,7 +22,7 @@ export function getContainerFiberNodeFrom (container) {
 }
 
 /**
- *  @param {{ container: { firstElementChild: Element | null } }} component
+ *  @param {RenderType} component
  *  @returns {Element | null}
  */
 export function getComponentElement ({

package/src/index.mjs

@@ -1,4 +1,5 @@
 /**
+ *  @typedef {import('@testing-library/react').RenderResult} RenderType
  *  @typedef {ReactComponentInstanceTypes.FiberNode} FiberNode
  */
 
@@ -87,7 +88,7 @@ export function getChildFiberNodeFrom (element) {
 }
 
 /**
- *  @param {{ container: { firstElementChild: Element | null } }} component
+ *  @param {RenderType} component
  *  @returns {Element | null}
  */
 export function getComponentElement ({

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "NodeNext",
-    "target": "ESNext",
-    "allowJs": true,
-    "checkJs": true,
-    "noEmit": true,
-    "strict": true,
-    "jsx": "react"
-  },
-  "include": [
-    "."
-  ]
-}