Skip to content

Commit f85bc72

Browse files
committed
docs(types): added tsdoc @param
1 parent 27ed8b6 commit f85bc72

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

types/index.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ export interface HTMLReactParserOptions {
1515

1616
/**
1717
* Convert HTML string to React elements.
18+
*
19+
* @param - Raw string of HTML to parse.
20+
* @param options - Options to use when converting to react.
1821
* @returns ReactElement on successful parse or string when `html` cannot be
1922
* parsed as HTML
2023
*/

types/lib/dom-to-react.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ import { DomNode, HTMLReactParserOptions } from 'html-react-parser';
33

44
/**
55
* Converts DOM nodes to React elements.
6+
*
7+
* @param nodes - A list of formatted DomNodes to convert to React.
8+
* @param options - Options to use when converting to react.
69
* @returns ReactElement or and array of ReactElements.
710
*/
811
export default function domToReact(

0 commit comments

Comments
 (0)