@xmldom/is-dom-node
Advanced tools
TypeScript helper functions to narrow the type of object to a Node descendant
@xmldom/is-dom-node is a versatile TypeScript library designed to provide robust utility functions for working with DOM nodes. Whether you're developing for the browser or dealing with XML in NodeJS, this library offers a comprehensive set of functions for checking and asserting various types of DOM nodes. It's particularly useful when working with NodeJS libraries like xpath and @xmldom/xmldom, as it can validate the objects returned by these libraries.
npm install @xmldom/is-dom-node
Import the library and use it as follows:
import * as isDomNode from "@xmldom/is-dom-node";
const element = document.createElement("div");
const result = isDomNode.isElementNode(element); // Output: true
import * as isDomNode from "@xmldom/is-dom-node";
function handleNode(node: Node) {
if (isDomNode.isElementNode(node)) {
// TypeScript now knows `node` is an Element
console.log(node.tagName);
} else if (isDomNode.isTextNode(node)) {
// TypeScript now knows `node` is a Text node
console.log(node.wholeText);
} else {
try {
// Assert that the node is a Comment node
isDomNode.assertIsCommentNode(node);
// TypeScript now knows `node` is a Comment node
console.log(node.nodeValue);
} catch (error) {
console.error("Node is not a Comment node:", error);
}
}
}
The API consists of two main types of functions:
is... FunctionsThese functions return a boolean value indicating whether the given object meets certain criteria:
isNodeLike: Checks if a given value resembles a DOM node.isArrayOfNodes: Checks if the given value is an array of DOM nodes.isElementNode, isAttributeNode, isTextNode, etc.: Check for specific types of DOM nodes.assertIs... FunctionsThese functions assert that a given object meets certain criteria and throw an error if it doesn't:
assertIsNodeLike: Asserts that a given value is a DOM node.assertIsArrayOfNodes: Asserts that the given value is an array of DOM nodes.assertIsElementNode, assertIsAttributeNode, assertIsTextNode, etc.: Assert for specific types of DOM nodes.Both the is... and assertIs... functions can be used for TypeScript type narrowing. After a successful check or assertion, TypeScript will recognize the specific type of the DOM node, allowing for more robust and error-free code.
xpath and @xmldom/xmldomPlease read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.
This project is licensed under the MIT License - see the LICENSE.md file for details.
FAQs
TypeScript helper functions to narrow the type of object to a Node descendant
The npm package @xmldom/is-dom-node receives a total of 615,477 weekly downloads. As such, @xmldom/is-dom-node popularity was classified as popular.
We found that @xmldom/is-dom-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.