Skip to content

Commit bae05c0

Browse files
committed
fix: update .d.ts docstrings
1 parent d8e2ada commit bae05c0

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

index.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ export interface HTMLReactParserOptions {
1313
}
1414

1515
/**
16-
* Converts HTML string to React elements.
16+
* Converts HTML string to JSX element(s).
1717
*
18-
* @param html - The HTML string to parse to JSX.
18+
* @param html - The HTML string to parse to JSX element(s).
1919
* @param options - The parser options.
20-
* @return - When parsed with HTML string, returns React elements; otherwise, returns string or empty array.
20+
* @return - Single or array of JSX elements.
2121
*/
2222
declare function HTMLReactParser(
2323
html: string,

lib/dom-to-react.d.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ import { HTMLReactParserOptions } from '..';
44
import { DomElement } from 'domhandler';
55

66
/**
7-
* Converts DOM nodes to React elements.
7+
* Converts DOM nodes to JSX element(s).
88
*
9-
* @param nodes - A list of formatted DomNodes to convert to JSX.
9+
* @param nodes - An array of DomNodes to convert to JSX element(s).
1010
* @param options - Options to use when converting to JSX.
11-
* @returns JSX.Element or an array of JSX.Elements.
11+
* @returns Single or array of JSX elements.
1212
*/
1313
export default function domToReact(
1414
nodes: DomElement[],

0 commit comments

Comments
 (0)