You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

bees

Package Overview
Dependencies
1
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

bees

Api documentation generator


Version published
Maintainers
1
Created

Readme

Source

bees (in Italian API means bees)

Let the code write your docs D:

Installation:

$ npm install bees

Example:

See test/file

Plugin:

You can extend Bees and add new keywords with a tiny plugin system (see lib/plugins)

var bees = require('bees');
bees.use('plugin', function(cmd, json) {
  json.plugin = cmd[1];
});
console.log(
  bees.parse(
    require('fs').readFileSync('./app.js','utf-8')
  )
);

Now you can use it

/**
 * GET /:id
 * 
 * @param id id of the user
 * @return user infos
 * @plugin hai lol
*/
$ node plugin.js
[
  {
    method: 'GET',
    path: '/:id',
    params: { id: 'id of the user' },
    return: 'user infos',
    plugin: 'hai lol'
  }
]

Reporters:

Reporters are a way to return formatted objects.

If we got this in eyes-reporter.js:

var inspector = require('eyes').inspector({stream: null});

module.exports = function(doc) {
  return inspector(doc);
};

And we call bees just like this:

bees -R eyes-reporter <file>

We will get:

eyes

Cool eh?

To Do:

  • Generate HTML from JSON

Tests:

$ npm test

Tests are written with Vows

License:

MIT

FAQs

Package last updated on 27 Jul 2012

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc