{"dist":{"shasum":"ba46faa44983f0b70c1a83aeab6169e83a202b1d","tarball":"https://registry.npmjs.org/treeify/-/treeify-1.0.0.tgz","integrity":"sha512-/dVhldBY4E/qhh5171jEo60TC86eYa0LMVgX2gzbBfJvY6h2/suz3JCpJQsh789/saiez4vEGpOuj0e7/xnwhA==","signatures":[{"sig":"MEUCIB9513KCQWEepTnbXsmpKBbqumGzy00DPEBBeHfVMljqAiEAmaoqhXw5hfwE0oQAEOfsK47vbV8SOvxRehhgxlqFKLY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"./treeify","name":"treeify","author":{"name":"Luke Plaster","email":"notatestuser@gmail.com"},"readme":"node-treeify\n============\n\n[![Build Status](https://travis-ci.org/notatestuser/node-treeify.png?branch=master)](https://travis-ci.org/notatestuser/node-treeify)\n\n_treeify_ converts a JS object into a nice, visible depth-indented tree for console printing. The structure\ngenerated is similar to what you get by running the ```tree``` command on Unixy platforms.\n\n```\n{\n    oranges: {\n        'mandarin': {                                          ├─ oranges\n            clementine: null,                                  │  └─ mandarin\n            tangerine: 'so cheap and juicy!'        -=>        │     ├─ clementine\n        }                                                      │     └─ tangerine: so cheap and juicy!\n    },                                                         └─ apples\n    apples: {                                                     ├─ gala\n        'gala': null,                                             └─ pink lady\n        'pink lady': null\n    }\n}\n```\n\nIt also works well with larger nested hierarchies such as file system directory trees.\nIn fact, the ```fs_tree``` example does a pretty good job of imitating ```tree```. Try it out!\n\nSee the other included examples or the test suite for usage scenarios.\n\nInstallation\n------------\nFirst you'll want to run this command in your project's root folder:\n```\n$ npm install treeify\n```\n\nThen proceed to use it in your project:\n```js\nvar treeify = require('treeify');\nconsole.log(\n   treeify.asTree({\n      apples: 'gala',      //  ├─ apples: gala\n      oranges: 'mandarin'  //  └─ oranges: mandarin\n   }, true)\n);\n```\n\n### ...or in a browser\n\nTreeify cooperates with Node, AMD or browser globals to create a module. This means it'll work\nin a browser regardless of whether you have an AMD-compliant module loader or not. If such\na loader isn't found when the script is executed, you may access Treeify at ```window.treeify```.\n\nUsage\n-----\nThe methods exposed to you are as follows, in a strange kind of signature notation:\n\n### asLines()\n```js\ntreeify.asLines(obj, showValues (boolean), [hideFunctions (boolean),] lineCallback (function))\n// NOTE: hideFunctions is optional and may be safely omitted - this was done to ensure we don't break uses of the previous form\n```\n### asTree()\n```js\ntreeify.asTree(obj, showValues (boolean), hideFunctions (boolean)): String\n```\n\nRunning the tests\n-----------------\nThere's a pretty extensive suite of Vows tests included.\n```\n$ npm test\n```\n","engines":{"node":">=0.6"},"scripts":{"test":"./node_modules/vows/bin/vows --spec"},"_npmUser":{"name":"notatestuser","email":"notatestuser@gmail.com"},"keywords":["object","tree","print","console","pretty"],"licenses":[{"url":"http://lp.mit-license.org/","type":"MIT"}],"repository":{"url":"https://github.com/notatestuser/node-treeify.git","type":"git"},"_npmVersion":"1.1.59","description":"converts a JS object into a nice, visible tree structure for the console","directories":{},"maintainers":[{"name":"notatestuser","email":"notatestuser@gmail.com"}],"devDependencies":{"vows":"git://github.com/Filirom1/vows.git#expect"},"_id":"treeify@1.0.0","version":"1.0.0"}