Current File : /var/www/html/node_modules/html-dom-parser/README.md
# html-dom-parser
[](https://nodei.co/npm/html-dom-parser/)
[](https://www.npmjs.com/package/html-dom-parser)
[](https://github.com/remarkablemark/html-dom-parser/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/remarkablemark/html-dom-parser)
[](https://www.npmjs.com/package/html-dom-parser)
HTML to DOM parser that works on both the server (Node.js) and the client (browser):
```
HTMLDOMParser(string[, options])
```
The parser converts an HTML string to a JavaScript object that describes the DOM tree.
#### Example
```js
const parse = require('html-dom-parser');
parse('<p>Hello, World!</p>');
```
Output:
```js
[
Element {
type: 'tag',
parent: null,
prev: null,
next: null,
startIndex: null,
endIndex: null,
children: [
Text {
type: 'text',
parent: [Circular],
prev: null,
next: null,
startIndex: null,
endIndex: null,
data: 'Hello, World!'
}
],
name: 'p',
attribs: {}
}
]
```
[Replit](https://replit.com/@remarkablemark/html-dom-parser) | [JSFiddle](https://jsfiddle.net/remarkablemark/ff9yg1yz/) | [Examples](https://github.com/remarkablemark/html-dom-parser/tree/master/examples)
## Install
[NPM](https://www.npmjs.com/package/html-dom-parser):
```sh
npm install html-dom-parser --save
```
[Yarn](https://yarnpkg.com/package/html-dom-parser):
```sh
yarn add html-dom-parser
```
[CDN](https://unpkg.com/html-dom-parser/):
```html
<script src="https://unpkg.com/html-dom-parser@latest/dist/html-dom-parser.min.js"></script>
<script>
window.HTMLDOMParser(/* string */);
</script>
```
## Usage
Import or require the module:
```js
// ES Modules
import parse from 'html-dom-parser';
// CommonJS
const parse = require('html-dom-parser');
```
Parse empty string:
```js
parse('');
```
Output:
<!-- prettier-ignore -->
```js
[]
```
Parse string:
```js
parse('Hello, World!');
```
```js
[
Text {
type: 'text',
parent: null,
prev: null,
next: null,
startIndex: null,
endIndex: null,
data: 'Hello, World!'
}
]
```
Parse element with attributes:
```js
parse('<p class="foo" style="color: #bada55">Hello, <em>world</em>!</p>');
```
Output:
```js
[
Element {
type: 'tag',
parent: null,
prev: null,
next: null,
startIndex: null,
endIndex: null,
children: [ [Text], [Element], [Text] ],
name: 'p',
attribs: { class: 'foo', style: 'color: #bada55' }
}
]
```
The server parser is a wrapper of [htmlparser2](https://github.com/fb55/htmlparser2) `parseDOM` but with the root parent node excluded.
The client parser mimics the server parser by using the [DOM](https://developer.mozilla.org/docs/Web/API/Document_Object_Model/Introduction) API to parse the HTML string.
## Testing
Run server and client tests:
```sh
npm test
```
Generate HTML coverage report for server tests:
```sh
npx nyc report --reporter=html
```
Lint files:
```sh
npm run lint
npm run lint:fix
```
Test TypeScript declaration file for style and correctness:
```sh
npm run lint:dts
```
## Migration
### v3.0.0
[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.
## Release
Release and publish are automated by [Release Please](https://github.com/googleapis/release-please).
## Special Thanks
- [Contributors](https://github.com/remarkablemark/html-dom-parser/graphs/contributors)
- [htmlparser2](https://github.com/fb55/htmlparser2)
- [domhandler](https://github.com/fb55/domhandler)
## License
[MIT](https://github.com/remarkablemark/html-dom-parser/blob/master/LICENSE)
Mini Shell