npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@plotdb/datadom

v0.2.0

Published

dom serializer / deserializer

Downloads

4

Readme

datadom

DOM serializer / deserializer with scriptable plugins.

WIP, please consider this as an unstable library.

Usage

install via npm:

npm install --save @plotdb/datadom

Add datadom.js in your HTML:

<script src="datadom.js"></script>

serialize/deserialize a DOM tree:

json = datadom.serialize(document.querySelector("your-selector"), [])
datadom.deserialize(json,[])
  .then({node, promise}) ->
    node # node is the deserialized DOM tree root.
    promise # promise for asynchronous content
  .then ({node, promise}) -> # all content prepared.

datadom is also a constructor:

dd = new datadom({ ... })
dd.init().then(function() { ... });

API

constructor options:

  • plugin: function, of Array of functions as default plugin(s).
    • plugin function accepts 1 parameters: subtree root ( for serialize ) / subdoc root ( for deserialize )
  • data: datadom json
  • node: root of DOM tree. ignored if data is provided.
  • window: optional window object if run in NodeJS.

datadom object methods:

  • init(): initialize data and node ( from provided counterpart ). Return promise.
  • update(ops): apply ops ( operation transformations ) to internal data and DOM tree.
  • getData(): return datadom json.
  • getNode(): return root of the corresponding DOM tree.

datadom class methods:

  • serialize(node, plugin): convert DOM tree (with root node) into json.
    • node: root node of DOM tree to serialize
    • plugin(d): optional handler for custom node types.
  • deserialize(data, plugin): convert datadom json into DOM tree
    • data: a datadom json.
    • plugin(d): optional handler for custom node types.

Node.js

to run in nodeJS, use jsdom and pass window as an argument:

datadom.deserialize(data, [], (new JSDOM()).window);

similarly, pass window in constructor when using new datadom( ... ):

new datadom({ ..., window: (new JSDOM()).window)});

Plugins

(TBD) check doc/plugin.md for more information.

License

MIT