clone-dom
v1.0.0
Published
**CloneDOM** is a library that wraps `document.createElement()` with checks to ensure identical elements are created **precisely once**.
Downloads
2
Readme
CloneDOM
CloneDOM is a library that wraps document.createElement()
with checks to ensure identical elements are created precisely once.
Motivation
DOM element creation is a straightforward process. The browser calls the underlying APIs to instantiate a representation of a node. When said node is appended to a page, the painting process begins.
Sometimes, creating thousands of nodes can get very tricky and affect the memory complexity of your web application. This is very much notable in huge apps where massive tables or shared components are used.
Cloning identical nodes
Luckily, with the node.cloneNode()
method on elements, we can effectively use the shared attributes and define a Record<SerializedProps, Element>
relationship between any arbitrary nodes to ensure that, say, X only yields Y when it satisfies a single condition, shared serializable props.
This means CloneDOM can effectively reduce the memory overhead of creating 10,000 similar nodes to, say, N, which depends on the rate of identity matches between nodes. The more the <td />
elements with the attribute class="cell center"
, the more the matches, hence more cloning over creation.
This is a sample benchmark demonstrating the performance of cloneNode()
(±28.1 ops/sec) over createElement()
(±18.7 ops/sec):
User agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0
Browser/OS: Firefox 91 on Windows
Register overpopulation
A major risk would be that the register could be overpopulated with non-weak in-memory JavaScript objects. One advantage is CloneDOM does not deep copy children and only retains single element info. Additionally, only string props are checked against, meaning, event handlers will always be re-attached synchronously since such info is typically lost in the cloning process.
Finally, for elements without any attributes (checked via NamedNodeMap.prototype.length
), a __no_attr__
check is used. So every <p />
node without attributes hits said check and gets cloned immediately, children and event handlers attached, then returned.
RAM/CPU/Memory vs. Time complexity
The test above was rather theoretical so I instead replicated a small environment where two suites, lazy and regular, are run subsequently after timeouts. Each suite creates a list of 100,000 div
elements iteratively. Memory stats are visually displayed via memory-stats and console.time()
, console.timeEnd()
and console.memory
used respectively. Results:
You might've noticed the memory-time relationship here:
Regular DOM has quicker creations.
CloneDOM consumes less memory.
Missing features
- Flushing the register after a specified timeout or size limit (via checking against
Object.keys(register).length
)
What CloneDOM is not
- CloneDOM is not a mega-multi-purpose swiss-army-knife. It primarily handles element creation.
- Like regular DOM operations,
CloneDOM.createElement()
is not web worker-friendly. - CloneDOM has nothing to do with ReactDOM.
- Absolutely no diffing. Out of the scope.
License
MIT © Saddam M.