get-api v1.0.1

get-api

Get API information from a module

Installation

Install get-api using npm:

npm install --save get-api

Usage

Module usage

var getApi = require('get-api');

var mod = require('path-to-a-module');

getApi(mod);
/**
 * {
 *   methods: [...],
 *   properties: [...]
 * }
 */

See the tests for examples.

API

getApi(mod [, opts])

Returns: Object, see the tests for examples.

options.main

Type: String
Default: "__MAIN_EXPORT__"

If provided it's used as a name fallback in case there is a main exported function without a name, i.e:

module.exports = function () {};

License

MIT