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

@deckhack/objtree

v1.0.0

Published

Generate a nicely formatted representation of an object tree

Downloads

5

Readme

objtree is a script that generates a text tree representation of an object. The script can be executed in a browser console or imported as an npm module.

How to Use

var target = {};

var result = objtree(target, {
  // Maximum level of recursion
  maxlevel: 10,
  
  // Prefixed before every name (ex. window)
  grandparent: "",
  
  // String used to indent lines to display the level of nesting
  indentstr: "  ",
  
  // Array of strings (behaving like regular expressions) matched against names to exclude
  // Use / to separate nested objects (ex. {a:{b:{c:true}}} will be a/b/c)
  // Note that grandparent is not included in the name matching process
  exclude: []
});

result.asObj(); // returns internal representation of the tree
result.asText(); // returns a formatted text representation
result.downloadText(filename); // triggers a browser file download with the formatted text

Example

var target = {
  testBool: true,
  testInt: 15,
  testFloat: -3.6,
  testString: "text",
  testFunction: function(a, b, c){},
  testArray1: [ 1, 2, true, "abc" ],
  testArray2: [
    { hi: "there" },
    [ 0, 1, [false] ]
  ],
  testObject: {
    abc: [ 1, 2 ]
  }
};

target.testObject["testSpecial-Name!"] = null;

function MyClass(){}

MyClass.CONSTANT = true;
MyClass.data = 10;
MyClass.prototype.a = function(){};
MyClass.prototype.b = function(){};

target["testClass"] = MyClass;

Calling objtree(target).asText() with no additional settings yields (ordered by type and then name):

OBJECT TREE
===========
|--  testArray2
  |--  testArray2['0']
    |-- [var] testArray2['0'].hi > there
  |--  testArray2['1']
    |-- [arr] testArray2['1']['2'] > [ false ]
    |-- [var] testArray2['1']['0'] > 0
    |-- [var] testArray2['1']['1'] > 1
|--  testObject
  |-- [arr] testObject.abc                  > [ 1, 2 ]
  |-- [var] testObject['testSpecial-Name!'] > (null)
|-- [fun] testClass()
  |--  testClass.prototype
    |-- [fun] testClass.prototype.a()
    |-- [fun] testClass.prototype.b()
  |-- [var] testClass.CONSTANT > true
  |-- [var] testClass.data     > 10
|-- [fun] testFunction(a, b, c)
|-- [arr] testArray1 > [ 1, 2, true, abc ]
|-- [var] testBool   > true
|-- [var] testFloat  > -3.6
|-- [var] testInt    > 15
|-- [var] testString > text