Module: lib/parser

Classes

SchemaMarkdownParserError

Methods

(static) parseSchemaMarkdown(text, optionsopt) → {Object}

Parse Schema Markdown from a string or an iterator of strings

Parameters:
Name Type Attributes Default Description
text string | Array.<string>

The Schema Markdown text
options Object <optional>
 {}

The options object

Properties
Name Type Attributes Default Description
types Object <optional>
 {}

The type model
filename string <optional>
 ''

The name of file being parsed (for error messages)
validate boolean <optional>
 true

If true, validate after parsing
Source:
Throws:

SchemaMarkdownParserError

Returns:

The type model

Type
Object