Metadata Schema and Interface Definition Language (IDL)
Clone or download
Latest commit 9321380 Oct 11, 2018

README.md

metaschema

Metadata Schema and Interface Definition Language (IDL)

TravisCI Codacy Badge NPM Version NPM Downloads/Month NPM Downloads

Installation

$ npm install metaschema

Interface: metaschema

Introspect interface

metaschema.introspect(namespace)

  • namespace:hash of interfaces Returns: hash of hash of record, { method, title, parameters }

Parse function signature

metaschema.parseSignature(fn)

  • fn:function - method Returns: { title, parameters }

Generate md from interfaces inventory

metaschema.generateMd(inventory)

  • inventory:hash of hash of record - { method, title, parameters } Returns: string, md document

Contributors