Skip to content

Commit fe04d6f

Browse files
docs(readme): document "TypeScript error" in FAQ
Relates to #748
1 parent 0309f57 commit fe04d6f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ parse('<p>Hello, World!</p>'); // React.createElement('p', {}, 'Hello, World!')
5757
- [TS Error: Property 'attribs' does not exist on type 'DOMNode'](#ts-error-property-attribs-does-not-exist-on-type-domnode)
5858
- [Can I enable `trim` for certain elements?](#can-i-enable-trim-for-certain-elements)
5959
- [Webpack build warnings](#webpack-build-warnings)
60+
- [TypeScript error](#typescript-error)
6061
- [Performance](#performance)
6162
- [Contributors](#contributors)
6263
- [Code Contributors](#code-contributors)
@@ -378,6 +379,8 @@ parse('<p> </p>', { trim: true }); // React.createElement('p')
378379

379380
[domhandler](https://github.com/fb55/domhandler) has been upgraded to v5 so some [parser options](https://github.com/fb55/htmlparser2/wiki/Parser-options) like `normalizeWhitespace` have been removed.
380381

382+
Also, it's recommended to upgrade to the latest version of [typescript](https://www.npmjs.com/package/typescript).
383+
381384
### v2.0.0
382385

383386
Since [v2.0.0](https://github.com/remarkablemark/html-react-parser/releases/tag/v2.0.0), Internet Explorer (IE) is no longer supported.
@@ -489,6 +492,19 @@ module.exports = {
489492

490493
See [#238](https://github.com/remarkablemark/html-react-parser/issues/238) and [#213](https://github.com/remarkablemark/html-react-parser/issues/213).
491494

495+
### TypeScript error
496+
497+
If you see the TypeScript error:
498+
499+
```
500+
node_modules/htmlparser2/lib/index.d.ts:2:23 - error TS1005: ',' expected.
501+
502+
2 export { Parser, type ParserOptions };
503+
~~~~~~~~~~~~~
504+
```
505+
506+
Then upgrade to the latest version of [typescript](https://www.npmjs.com/package/typescript). See [#748](https://github.com/remarkablemark/html-react-parser/issues/748).
507+
492508
## Performance
493509

494510
Run benchmark:

0 commit comments

Comments
 (0)