A high performance DOM manipulation library for Node.js built using Rust.
Installing rustdom requires a supported version of Node and Rust.
You can install the project with npm. In the project directory, run:
$ npm install --save rustdom
This fully installs the project, including installing any dependencies and running the build.
const RustDOM = require('rustdom');
const dom = new RustDOM("<!DOCTYPE html><html><head><\head><body><p>Foo</p><p class='Bar'>Baz</p></body></html>");
console.log(dom.document.body.firstChild.textContent);
console.log(dom.document.querySelector('.Bar').nodeType);
console.log(dom.serialize());
If you have already installed the project and only want to run the build, run:
$ npm run build
This command uses the cargo-cp-artifact utility to run the Rust build and copy the built library into ./index.node
.
To run build on changes run
$ npm run watch
In the project directory, you can run:
Installs the project, including running npm run build
.
Builds the Node addon (index.node
) from source.
Additional cargo build
arguments may be passed to npm build
and npm build-*
commands. For example, to enable a cargo feature:
npm run build -- --feature=beetle
Alias for npm run build
.
Same as npm build
but, builds the module with the release
profile. Release builds will compile slower, but run faster.
Runs the unit tests by calling npx mocha test
.
Watch for changes and run npm test
on any change.
The Cargo manifest file, which informs the cargo
command.
The Node addon—i.e., a binary Node module—generated by building the project. This is the main module for this package, as dictated by the "main"
key in package.json
.
Under the hood, a Node addon is a dynamically-linked shared object. The "build"
script produces this file by copying it from within the target/
directory, which is where the Rust build produces the shared object.
The npm manifest file, which informs the npm
command.
The directory tree containing the Node.js source code for the project.
The directory tree containing the Rust source code for the project.
Binary artifacts generated by the Rust build.
Test files for the API.
To learn more about Neon, see the Neon documentation.
To learn more about Rust, see the Rust documentation.
To learn more about Node, see the Node documentation.