{"id":13300,"library":"html-dom-parser","title":"HTML DOM Parser","description":"html-dom-parser is a versatile JavaScript library designed to convert HTML strings into a structured JavaScript object representation of the Document Object Model (DOM) tree. It operates effectively in both Node.js environments (leveraging `htmlparser2` and `domhandler` internally for performance) and client-side browser contexts (mimicking server parsing behavior using the native DOM API). Currently at version 7.0.1, the library maintains a relatively active release cadence, with multiple updates in recent months addressing bug fixes and dependency bumps. Its key differentiator lies in providing a consistent, serializable DOM-like output (Plain Old JavaScript Objects) across different JavaScript environments, making it suitable for server-side HTML manipulation, client-side virtual DOM implementations, or data extraction where direct DOM access might be unavailable or inefficient.","status":"active","version":"7.0.1","language":"javascript","source_language":"en","source_url":"https://github.com/remarkablemark/html-dom-parser","tags":["javascript","html-dom-parser","html","dom","parser","htmlparser2","pojo","typescript"],"install":[{"cmd":"npm install html-dom-parser","lang":"bash","label":"npm"},{"cmd":"yarn add html-dom-parser","lang":"bash","label":"yarn"},{"cmd":"pnpm add html-dom-parser","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core dependency for server-side HTML parsing, converting HTML string into a handler-friendly format. Major version updates in v6.0.0 and v7.0.0.","package":"htmlparser2","optional":false},{"reason":"Used by htmlparser2 to construct the JavaScript object DOM tree from the parsed HTML events. Major version updates in v6.0.0.","package":"domhandler","optional":false}],"imports":[{"note":"This is the primary default export for ESM environments.","symbol":"parse","correct":"import parse from 'html-dom-parser';"},{"note":"For CommonJS, the default export is exposed via the `.default` property. Directly requiring the package will return the module object, not the parser function itself.","wrong":"const parse = require('html-dom-parser');","symbol":"parse","correct":"const parse = require('html-dom-parser').default;"},{"note":"Used for type-checking and defining options when parsing HTML in server-side (Node.js) environments. This interface is exported directly by the package.","symbol":"ParserOptions","correct":"import type { ParserOptions } from 'html-dom-parser';"}],"quickstart":{"code":"import parse, { ParserOptions } from 'html-dom-parser';\n\n// Basic usage in an ESM environment (Node.js or browser)\nconst simpleHtml = '

Hello, World!

';\nconst domNodes = parse(simpleHtml);\nconsole.log('Parsed simple HTML:', JSON.stringify(domNodes, null, 2));\n\n// Example with server-side options (Node.js only)\n// Options are passed through to htmlparser2 and domhandler.\nconst complexHtml = 'Test
Text & Entities
';\nconst parserOptions: ParserOptions = {\n decodeEntities: true, // Decode HTML entities like &\n xmlMode: false, // Treat input as HTML, not XML\n lowerCaseTags: true // Ensure all tag names are lowercase\n};\n\nconst serverDomNodes = parse(complexHtml, parserOptions);\nconsole.log('\\nParsed complex HTML with options:', JSON.stringify(serverDomNodes, null, 2));\n\n// Accessing properties of the parsed DOM\nconst firstNode = domNodes[0];\nif (firstNode && 'name' in firstNode) {\n console.log('\\nFirst node tag name:', firstNode.name);\n if (firstNode.children && firstNode.children.length > 0) {\n const textNode = firstNode.children[0];\n if ('data' in textNode) {\n console.log('First child text data:', textNode.data);\n }\n }\n}","lang":"typescript","description":"This quickstart demonstrates how to parse a basic HTML string, including how to apply server-side parsing options for more complex scenarios, and access properties of the resulting DOM nodes."},"warnings":[{"fix":"Review your parsing logic and expected DOM structures, particularly for complex or malformed HTML inputs. Consult the `htmlparser2` v12 changelog for specific behavioral changes.","message":"Version 7.0.0 introduced a breaking change by bumping the `htmlparser2` dependency from 11.0.0 to 12.0.0. This update in `htmlparser2` aligns HTML parsing more closely with the WHATWG specification, which may lead to subtle changes in the parsed DOM structure, entity decoding, and handling of certain tag types, especially for raw-text and RCDATA elements (like `