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

tido-mei-traversals

v0.1.0

Published

Semantic MEI traversal functions in JavaScript

Downloads

2

Readme

mei-traversals

Collection of single dispatch and multiple dispatch functions to traverse the MEI structure.

The type signature for all traversals are element -> *

Note that the API is currently considered unstable, and subject to change.

API

Complete list of available functions by category

Usage

By default, this library operates under the assumption the MEI is immutable. To change this see the next section on configuration.

Each function gets added to a pristine lodash instance (using _.runInContext and _.mixin) and that instance is exported. This is a heavy dependency.

The main power of this library comes from multiple dispatch functions which allow us to navigate the MEI using common musical semantics without exposing the MEI structure. You shouldn't have to worry about the fact that some elements are hierarchically related, while others are related by attribute.

Consider the following MEI snippets:

<staff>
  <note/>
</staff>
<measure>
  <staff n="1"/>
  <dynam staff="1"/>
<measure/>

In the first example, calling traversals.staff with the <note/> will return the parent <staff>. In the second example, Calling traversals.staff with the <dynam staff="1"/> will return the <staff> which has a matching n attribute.

Example
import traversals from 'mei-traversals';
import { DOMParser } from 'xmldom';

const domParser = new DOMParser();

const doc = domParser.parseFromString(`
  <mei>
    <music>
      <mdiv>
        <score>
          <measure>
            <staff n="1">
              <layer>
                <note />
                <note />
              </layer>
            </staff>
          </measure>
        </score>
      </mdiv>
    </music>
  </mei>
`)

const notes = traversals.notes(doc);
const staffN = traversals.staffN(notes[1]);
console.log(staffN); // => 1

Configuration

To configure the traversals, use the .configure(options) function provided on the main traversals object.

  • options
    • cache
      • If true, the result of each traversal is cached on the input DOM element.
      • default: true
    • log
      • If true, each traversal is logged with the input DOM element, output data, and duration
      • default: false
    • tryCatch
      • If true, each traversal is wrapped in a try catch
      • default: true
Example:
import traversals from 'tido-mei-traversals';

traversals.configure({ log: true, cache: true, tryCatch: true });

Performance

No benchmarks yet.

Installation

npm install --save tido-mei-traversals

Compiling from source

If you are not installing from npm, you can compile the source on your own. To compile, run the following command:

npm run prepublish

Run the Tests

npm install
npm test

Dependencies