{"_id":"doc","_rev":"10-2977fe0132452f742f923fcb2dec8f69","name":"doc","description":"Runtime documentation tool for REPL","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"doc","id":"doc","version":"0.0.1","description":"Runtime documentation tool for REPL","keywords":[],"author":{"name":"Irakli Gozalishvili","email":"rfobic@gmail.com","url":"http://jeditoolkit.com"},"homepage":"https://github.com/Gozala/doc","repository":{"type":"git","url":"git://github.com/Gozala/doc.git","web":"https://github.com/Gozala/doc"},"bugs":{"url":"http://github.com/Gozala/doc/issues/"},"devDependencies":{"test":">=0.0.10"},"dependencies":{"graphquire":">=0.6.1"},"main":"./index.js","engines":{"node":"0.4.x"},"scripts":{"test":"node tests/test-all.js","install":"graphquire --clean --write"},"licenses":[{"type":"MIT","url":"http://jeditoolkit.com/LICENSE"}],"_npmJsonOpts":{"file":"/Users/gozala/.npm/doc/0.0.1/package/package.json","wscript":false,"contributors":false,"serverjs":false},"_id":"doc@0.0.1","_engineSupported":false,"_npmVersion":"1.0.26","_nodeVersion":"v0.5.4","_defaultsLoaded":true,"dist":{"shasum":"ec4287396acffce972ee26b1182fc61b24c2e677","tarball":"https://registry.npmjs.org/doc/-/doc-0.0.1.tgz","integrity":"sha512-ibJR7ZMMpAXjE0Bi6CACm6U8qt85HM99/sbCE1BiZ6PKEEJWKvyOTSvW5vGkjwKyOWYXfy1A4eEHPxuBW1R71g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAZuvvZ2q5tzA2wo72W5pMKQ3QLao2tlUTQmiGnxw8qNAiBNLgmgQuGVFQs/kpJ3zwo6qm/f3iKf9+Og5ECbihfr3w=="}]},"maintainers":[{"name":"gozala","email":"rfobic@gmail.com"}]},"0.0.2":{"name":"doc","id":"doc","version":"0.0.2","description":"Runtime documentation tool for REPL","keywords":["runtime","documentation","docs","repl"],"author":{"name":"Irakli Gozalishvili","email":"rfobic@gmail.com","url":"http://jeditoolkit.com"},"homepage":"https://github.com/Gozala/doc","repository":{"type":"git","url":"git://github.com/Gozala/doc.git","web":"https://github.com/Gozala/doc"},"bugs":{"url":"http://github.com/Gozala/doc/issues/"},"main":"./index.js","licenses":[{"type":"MIT","url":"http://jeditoolkit.com/LICENSE"}],"_npmJsonOpts":{"file":"/Users/gozala/.npm/doc/0.0.2/package/package.json","wscript":false,"contributors":false,"serverjs":false},"_id":"doc@0.0.2","dependencies":{},"devDependencies":{},"engines":{"node":"*"},"_engineSupported":true,"_npmVersion":"1.0.26","_nodeVersion":"v0.5.5","_defaultsLoaded":true,"dist":{"shasum":"e05083cc6b6ec3679434eaf70a94c37082814772","tarball":"https://registry.npmjs.org/doc/-/doc-0.0.2.tgz","integrity":"sha512-Ul7mC+TykmNVLw9ZBg56mPnxC4ovuzm62jS1Z0NJrkFbdGupDFyCPstbbOl1nBLOf0Hbe0GJXvoi5LodKWBjRQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCE9sCcITyKGCgXT/k1Pob3xSMNQeB0hJIbvKD5sj8W3wIgPqmMjf/gFLASEVT2njwqN7vTDDatwSpYOGGzkYGL2xg="}]},"scripts":{},"maintainers":[{"name":"gozala","email":"rfobic@gmail.com"}]},"0.0.3":{"name":"doc","id":"doc","version":"0.0.3","description":"Runtime documentation tool for REPL","keywords":["runtime","documentation","docs","repl"],"author":{"name":"Irakli Gozalishvili","email":"rfobic@gmail.com","url":"http://jeditoolkit.com"},"homepage":"https://github.com/Gozala/doc","repository":{"type":"git","url":"https://github.com/Gozala/doc.git","web":"https://github.com/Gozala/doc"},"bugs":{"url":"http://github.com/Gozala/doc/issues/"},"main":"./index.js","licenses":[{"type":"MIT","url":"http://jeditoolkit.com/LICENSE"}],"readme":"# doc #\n\nRuntime documentation tool for REPL.\n\n## Usage ##\n\nHave you ever wished you could see docs for the given function right out of\nthe REPL? If so, this tool is for you!\n\n```js\nvar doc = require('doc').doc\ndoc(doc) // Prints following output:\n\n/*\nfunction doc(source) { ... }\n-----------------------------------------------\nPrints documentanion of the given function\n*/\n\n// You can also document your own functions:\n\nfunction compose() {\n  doc: \"Returns the composition of a list of functions, where each function\"\n     | \"consumes the return value of the function that follows. In math\"\n     | \"terms, composing the functions `f()`, `g()`, and `h()` produces\"\n     | \"`f(g(h()))`.\"\n     | \"Usage:\"\n     | \"var greet = function(name) { return 'hi: ' + name }\"\n     | \"var exclaim = function(statement) { return statement + '!' }\"\n     | \"var welcome = compose(exclaim, greet)\"\n     | \"welcome('moe')\"\n     | \"//> 'hi: moe!'\"\n\n  var funcs = Array.prototype.slice.call(arguments)\n  return function composed() {\n    var args = slice.call(arguments)\n    var i = funcs.length\n    while (0 <= --i) args = [ funcs[i].apply(this, args) ]\n    return args[0]\n  }\n}\n\ndoc(compose) // Prints following output:\n\n/*\nfunction compose() { ... }\n-----------------------------------------------\nReturns the composition of a list of functions, where each function\nconsumes the return value of the function that follows. In math\nterms, composing the functions `f()`, `g()`, and `h()` produces\n`f(g(h()))`.\nUsage:\nvar greet = function(name) { return 'hi: ' + name }\nvar exclaim = function(statement) { return statement + '!' }\nvar welcome = compose(exclaim, greet)\nwelcome('moe')\n//> 'hi: moe!'\n*/\n\n// Alternative way to documenting functions (Not cross platform though):\n\nfunction sum(a, b) {\n  /**\n  Takes arbitary number of arguments and returns their sum.\n  Usage:\n  sum(7, 2, 8) //> 17\n  **/\n\n  var count = arguments.length, index = 0, value = 0\n  while (index < count) value += arguments[index++]\n  return value\n}\n\ndoc(sum) // Prints following output:\n\n/*\nfunction sum(a, b) { ... }\n-----------------------------------------------\nTakes arbitary number of arguments and returns their sum.\nUsage:\nsum(7, 2, 8) //> 17\n*/\n\n```\n\n## Install ##\n\n    npm install doc\n","readmeFilename":"Readme.md","_id":"doc@0.0.3","dist":{"shasum":"2712f573b13a64aa7b860c00dab980cbc2d3e908","tarball":"https://registry.npmjs.org/doc/-/doc-0.0.3.tgz","integrity":"sha512-JbtDy+nCyfZnavUWV9FrDC5RjuCBllkYbf5u6U2WiD5QXO7lu9F4u1hrQveVpnKaf11x4S0bQq3b842VTv12cg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAmSMnAC8UJKAKv1Wr+aNlE5llOg3LYXuvRlZGW8CuLCAiEA/QbBHtR31x9Pr9pxf0mwLuYEmZC8J9/9DoJCYxy+xHE="}]},"_from":".","_npmVersion":"1.2.25","_npmUser":{"name":"robskillington","email":"rob.skillington@gmail.com"},"maintainers":[{"name":"gozala","email":"rfobic@gmail.com"},{"name":"robskillington","email":"rob.skillington@gmail.com"}]}},"maintainers":[{"name":"gozala","email":"rfobic@gmail.com"},{"name":"robskillington","email":"rob.skillington@gmail.com"}],"time":{"modified":"2022-06-15T06:33:41.915Z","created":"2011-09-02T15:12:08.201Z","0.0.1":"2011-09-02T15:12:11.111Z","0.0.2":"2011-09-04T13:59:47.322Z","0.0.3":"2013-12-13T21:10:45.922Z"},"author":{"name":"Irakli Gozalishvili","email":"rfobic@gmail.com","url":"http://jeditoolkit.com"},"repository":{"type":"git","url":"https://github.com/Gozala/doc.git","web":"https://github.com/Gozala/doc"}}