get-api
Get API information from a module
Installation
Install get-api
using npm:
npm install --save get-api
Usage
Module usage
var getApi = ; var mod = ; ;/** * { * methods: [...], * properties: [...] * } */
See the tests for examples.
API
getApi(mod [, opts])
Name | Type | Description |
---|---|---|
mod | Mixed |
The module to get API for |
opts | Object |
Options |
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 {};
License
MIT