jsondom

JSON DOM

A DOM-like interface for querying complex Javascript objects. (Also a very light wrapper around js-traverse).

Installation

npm install json-dom

Usage

> var jsd = require('json-dom');
> var complex = {
  title: "this is a test",
  articles: [
    {
      title: "sub title",
      articles: "this is an article"
    },
    {
      hello: "it is me you're looking for"
    }
  ]
};

> jsd.getValuesByKeyName(complex, 'title');
["this is a test", "sub title"]

> jsd.getValuesByKeyName(complex, 'title', 1);
["this is a test"]

> jsd.getNodesMatching(complex, 'articles');
[
  [
    {
      title: 'sub title',
      articles: 'this is an article'
    },
    {
      hello: 'it is me you\'re looking for'
    }
  ],
  'this is an article'
]

> js.getNodesMatching(complex, 'articles', true);
[ { title: 'this is a test',
    articles: [ [Object], [Object] ] },
  { title: 'sub title',
    articles: 'this is an article' } ]

Methods

getNodesMatching(tree, needle, parent)

/**
 * Returns a node of the tree if any of the keys or values in the node match the
 * provided criteria
 * @param  {Object}   tree      Object graph
 * @param  {String}   needle    The value you're looking for
 * @param  {Boolean}  (parents) Should it return the parent of the matching element
 * @return {Array}              An array of parent nodes which have matching children
 */
};

getValuesByKey(tree, key, maxDepth)

/**
 * Gets all values from object graph that exist at the specified key name
 * @param  {Object}   tree      Object graph
 * @param  {String}   key       Name of key
 * @param  {Integer} (maxDepth) Max recursion depth, zero means no maxDepth. Default zero
 * @return {Array}              Array of values from matching keys
 */

License

Copyright 2013 Condé Nast. Licensed under the MIT License.