Skip to content

Commit bcab3a8

Browse files
docs(index): tidy and update JSDoc comments for index.js
Document missing param for `options.library`.
1 parent dda59e0 commit bcab3a8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

index.js

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ var domParserOptions = { decodeEntities: true, lowerCaseAttributeNames: false };
77
/**
88
* Converts HTML string to React elements.
99
*
10-
* @param {String} html - The HTML string to parse to React.
11-
* @param {Object} [options] - The parser options.
12-
* @param {Function} [options.replace] - The replace method.
13-
* @return {JSX.Element|JSX.Element[]|String} - Returns React element(s), string, or empty array.
10+
* @param {String} html - HTML string.
11+
* @param {Object} [options] - Parser options.
12+
* @param {Object} [options.library] - Library for React, Preact, etc.
13+
* @param {Function} [options.replace] - Replace method.
14+
* @return {JSX.Element|JSX.Element[]|String} - React element(s), empty array, or string.
1415
*/
1516
function HTMLReactParser(html, options) {
1617
if (typeof html !== 'string') {

0 commit comments

Comments
 (0)