Add export of ExtraProps type

syntax-tree · Sep 27, 2023 · 85a3787 · 85a3787
1 parent 079baa0
commit 85a3787
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/index.js b/index.js
@@ -1,5 +1,6 @@
 /**
  * @typedef {import('./lib/components.js').Components} Components
+ * @typedef {import('./lib/components.js').ExtraProps} ExtraProps
  * @typedef {import('./lib/index.js').ElementAttributeNameCase} ElementAttributeNameCase
  * @typedef {import('./lib/index.js').Fragment} Fragment
  * @typedef {import('./lib/index.js').Jsx} Jsx

diff --git a/readme.md b/readme.md
@@ -22,6 +22,7 @@ with an automatic JSX runtime.
     *   [`Options`](#options)
     *   [`Components`](#components)
     *   [`ElementAttributeNameCase`](#elementattributenamecase)
+    *   [`ExtraProps`](#extraprops)
     *   [`Fragment`](#fragment)
     *   [`Jsx`](#jsx)
     *   [`JsxDev`](#jsxdev)
@@ -256,6 +257,16 @@ React casing is for example `className`, `strokeLinecap`, `xmlLang`.
 type ElementAttributeNameCase = 'html' | 'react'
 ```
 
+### `ExtraProps`
+
+Extra fields we pass (TypeScript type).
+
+###### Type
+
+```ts
+type ExtraProps = {node?: Element | undefined}
+```
+
 ### `Fragment`
 
 Represent the children, typically a symbol (TypeScript type).
@@ -557,6 +568,7 @@ This package is fully typed with [TypeScript][].
 It exports the additional types
 [`Components`][api-components],
 [`ElementAttributeNameCase`][api-element-attribute-name-case],
+[`ExtraProps`][api-extra-props],
 [`Fragment`][api-fragment],
 [`Jsx`][api-jsx],
 [`JsxDev`][api-jsx-dev],
@@ -671,6 +683,8 @@ abide by its terms.
 
 [api-element-attribute-name-case]: #elementattributenamecase
 
+[api-extra-props]: #extraprops
+
 [api-fragment]: #fragment
 
 [api-jsx]: #jsx