feat(index): export domhandler node types and update README.md

[remarkablemark]

What is the motivation for this pull request?

feat(index): export domhandler node types and update README.md

What is the current behavior?

domhandler node types are not exported. Thus, users have to import directly from domhandler (see #199):

import { Element } from 'domhandler/lib/node';

What is the new behavior?

domhandler node types are exported:

import parse, { Element } from 'html-react-parser';

Checklist:

• Tests
• Documentation
• Types

[github-actions]

size-limit report 📦

Path	Size	Loading time (3g)	Running time (snapdragon)	Total time
dist/html-react-parser.min.js	7.17 KB (0%)	144 ms (0%)	90 ms (-3.6% 🔽)	233 ms

[coveralls]

Coverage remained the same at 100.0% when pulling 057ab48 on feat/types into 3a559e4 on master.

[remarkablemark]

Published v1.1.0:

npm:

npm i [email protected]

Yarn:

yarn add [email protected]

[bicstone]

Thanks!

[remarkablemark]

@bicstone even though I exported the domhandler node types, it still won't help your example in #199 since instanceof requires an object and not a type. So for your use-case, it's still recommended to do this:

import { Element } from 'domhandler/lib/node';
import { HTMLReactParserOptions } from 'html-react-parser';

const options: HTMLReactParserOptions = {
  replace: (domNode) => {
    if (domNode instanceof Element && domNode.attribs) {
      // ...
    }
  },
};

[natterstefan]

@bicstone even though I exported the domhandler node types, it still won't help your example in #199 since instanceof requires an object and not a type. So for your use-case, it's still recommended to do this:

import { Element } from 'domhandler/lib/node';
import { HTMLReactParserOptions } from 'html-react-parser';

const options: HTMLReactParserOptions = {
  replace: (domNode) => {
    if (domNode instanceof Element && domNode.attribs) {
      // ...
    }
  },
};

Hi @remarkablemark, wouldn't it be possible to fix that as well? Because now, people need to import from a transcend dependency of this package (rather than only importing directly from this package.

Which can lead to issues like Module not found: Can't resolve 'domhandler/lib/node' (I just got this in my Next.js setup).

[remarkablemark]

@natterstefan I can see your point about domhandler being a transitive dependency. My only concern of importing and exporting domhandler is that it will add to the bundle size.

Currently, this approach is only necessary for TypeScript projects. I wonder if there's a better alternative that can achieve the best of both worlds.

[natterstefan]

Hi @remarkablemark,

what if you only import the types of domhandler and also export only the required types? This should not increase the bundle size as it is only available in the generated *.d.ts files. Can you try this?