microtesia.js

Small, fast microdata parsing library for browsers.

To install execute:

$ npm install microtesia.js --save

Or with bower:

$ bower install microtesia.js --save

To use import the script into your HTML as follows:

<script src="../microtesia.js/dist/microtesia.js"></script>

This makes the parseMicrodata function available. This functions takes an Element (or array of Elements) as argument and returns an array of microdata as a JSON objects:

var microdata = parseMicrodata(document);

So parsing the following HTML:

<article role="article" itemscope itemtype="http://schema.org/Organization">

  <h1><span itemprop="name">Organization Name</span> Directory</h1>

  <section>
    <h2 itemprop="department">Department Name</h2>
    <p>Brief department description</p>

    <div itemprop="employee" itemscope itemtype="http://schema.org/Person">
      <span itemprop="name">Jane Doe</span> <br>
      <span itemprop="jobTitle">Vice President for Such-and-Such</span> <br>
      <a href="//tel:5551112222" itemprop="telephone">(555) 111-2222</a> <br>
      <a href="mailto:[email protected]" itemprop="email">[email protected]</a>
    </div>
  </section>

</article>

Would return:

[{
  "_type": "http://schema.org/Organization",
  "employee": {
    "_type": "http://schema.org/Person",
    "email": "mailto:[email protected]",
    "telephone": "//tel:5551112222",
    "jobTitle": "Vice President for Such-and-Such",
    "name": "Jane Doe"
  },
  "department": "Department Name",
  "name": "Organization Name"
}]

You can also pass an array of elements to search for microdata:

var microdata = parseMicrodata(document.querySelectorAll('.microdata'));

Finally, you can pass a URL as item type to only parse root items you're interested in:

var microdata = parseMicrodata('http://schema.org/Organization', document);

Hacking

To test and build run:

$ npm run build