![\"TagSoup\"](\"./assets/logo.png\"){kind=logo}
\n\n \n
hello
cool');\n// ⮕ DocumentFragment\n\ntoHTML(fragment);\n// ⮕ '
hello
cool
hello');\n// ❌ ParserError: Unexpected end tag.\n\nconst fragment = XMLDOMParser.parseFragment('
hello
hello
hello
hello
cool', {\n onStartTagOpening(tagName) {\n // Called with 'p', 'p', and 'br'\n },\n onText(text) {\n // Called with 'hello' and 'cool'\n },\n});\n```\n\n[`XMLSAXParser`](https://smikhalevski.github.io/tag-soup/variables/XMLSAXParser.html) parses XML markup and calls\nhandler methods when a token is read. It throws\n[`ParserError`](https://smikhalevski.github.io/tag-soup/classes/ParserError.html) if markup doesn't satisfy XML spec:\n\n```ts\nimport { XMLSAXParser } from 'tag-soup';\n\nXMLSAXParser.parseFragment('
hello', {});\n// ❌ ParserError: Unexpected end tag.\n\nXMLSAXParser.parseFragment('
hello
hello
', {\n onComment(data) {\n // Called with ' greeting '\n },\n onStartTagOpening(tagName) {\n // Called with 'p'\n },\n onAttribute(name, value) {\n // Called with 'class', 'x'\n },\n onStartTagClosing() {\n // Called after all attributes of 'p' are read\n },\n onStartTag(tagName, attributes, isSelfClosing) {\n // Called after onStartTagClosing\n },\n onText(text) {\n // Called with 'hello'\n },\n onEndTag(tagName) {\n // Called with 'p'\n },\n});\n```\n\n# Tokenization\n\nTagSoup exports preconfigured\n[`HTMLTokenizer`](https://smikhalevski.github.io/tag-soup/variables/HTMLSAXParser.html) which parses HTML markup and\ninvokes a callback when a token is read. This tokenizer never throws errors during tokenization and forgives malformed\nmarkup:\n\n```ts\nimport { HTMLTokenizer } from 'tag-soup';\n\nHTMLTokenizer.tokenizeFragment('hello
cool', (token, startIndex, endIndex) => {\n // Handle token\n});\n```\n\n[`XMLTokenizer`](https://smikhalevski.github.io/tag-soup/variables/XMLTokenizer.html) parses XML markup and invokes\na callback when a token is read. It throws\n[`ParserError`](https://smikhalevski.github.io/tag-soup/classes/ParserError.html) if markup doesn't satisfy XML spec:\n\n```ts\nimport { XMLTokenizer } from 'tag-soup';\n\nXMLTokenizer.tokenizeFragment('
hello', (token, startIndex, endIndex) => {});\n// ❌ ParserError: Unexpected end tag.\n\nXMLTokenizer.tokenizeFragment('
hello
`. |\n| `\"START_TAG_CLOSING\"` | The `>` that closes an opening tag. |\n| `\"START_TAG_SELF_CLOSING\"` | The `/>` that self-closes a tag. |\n| `\"END_TAG_NAME\"` | The name portion of a closing tag, e.g. `p` in `
`. |\n| `\"ATTRIBUTE_NAME\"` | An attribute name. |\n| `\"ATTRIBUTE_VALUE\"` | A decoded attribute value. |\n| `\"COMMENT\"` | Comment content, excluding ``. |\n| `\"PROCESSING_INSTRUCTION_TARGET\"` | The target of a processing instruction, e.g. `xml` in ``. |\n| `\"PROCESSING_INSTRUCTION_DATA\"` | The data portion of a processing instruction. |\n| `\"CDATA_SECTION\"` | Content of a CDATA section, excluding ``. |\n| `\"DOCTYPE_NAME\"` | The name in a DOCTYPE declaration, e.g. `html` in ``. |\n\n# Serialization\n\nTagSoup exports two preconfigured serializers:\n[`toHTML`](https://smikhalevski.github.io/tag-soup/variables/toHTML.html) and\n[`toXML`](https://smikhalevski.github.io/tag-soup/variables/toXML.html).\n\n```ts\nimport { HTMLDOMParser, toHTML } from 'tag-soup';\n\nconst fragment = HTMLDOMParser.parseFragment('hello
cool');\n// ⮕ DocumentFragment\n\ntoHTML(fragment);\n// ⮕ '
hello
cool
hello');\n// ⮕ DocumentFragment\n\nmySerializer(fragment);\n// ⮕ '
hello
`. |\n| [`implicitlyOpenedTags`](https://smikhalevski.github.io/tag-soup/interfaces/ParserOptions.html#implicitlyopenedtags) | Tags for which a synthetic start tag is inserted when an unbalanced end tag is encountered (e.g. `['p', 'br']` so `
` becomes ``). |\n| [`areTagNamesCaseInsensitive`](https://smikhalevski.github.io/tag-soup/interfaces/ParserOptions.html#aretagnamescaseinsensitive) | If `true`, tag name comparisons ignore ASCII case. |\n| [`areCDATASectionsRecognized`](https://smikhalevski.github.io/tag-soup/interfaces/ParserOptions.html#arecdatasectionsrecognized) | If `true`, CDATA sections (``) are recognized. |\n| [`areProcessingInstructionsRecognized`](https://smikhalevski.github.io/tag-soup/interfaces/ParserOptions.html#areprocessinginstructionsrecognized) | If `true`, processing instructions (``) are recognized. |\n| [`areSelfClosingTagsRecognized`](https://smikhalevski.github.io/tag-soup/interfaces/ParserOptions.html#areselfclosingtagsrecognized) | If `true`, self-closing tags (`| Library | \nLibrary size | \nDOM parsing | \nSAX parsing | \n||
|---|---|---|---|---|---|
| Ops/sec | \nRAM | \nOps/sec | \nRAM | \n||
| tag-soup@3.2.1 | \n\n21 kB\n | \n35 Hz | \n22 MB | \n54 Hz | \n22 kB | \n
| \nhtmlparser2@12.0.0\n | \n\n34 kB\n | \n15 Hz | \n35 MB | \n24 Hz | \n6 MB | \n
| \nparse5@8.0.0\n | \n\n45 kB\n | \n7 Hz | \n105 MB | \n11 Hz | \n10 MB | \n
okay\n nope\n```\n\nWith [`DOMParser`](https://developer.mozilla.org/en-US/docs/Web/API/DOMParser) this markup would be transformed to:\n\n```html\n okay nope okay nope