Home

Members

DefaultConfig

Defines a default configuration with all possible configuration options.

Functions

render(config) ⇒ Promise

Parses and renders RAML service definitions. Depending on the provided configuration, this method will send its output to different locations.

parse(config) ⇒ Promise

Parses RAML service definitions returns a promise containing an object with all parsed values when resolved.

DefaultConfig

Defines a default configuration with all possible configuration options.

Kind: global variable
Properties

Name	Type	Description
input	object	Input configuration.
input.paths	array	A list of source paths to look for RAML files. This may contain files and directories.
input.recursive	boolean	Whenever to walk recursively through proviced directory paths.
input.fileFilter	RegExp	Regular Expression or function for more advanced filtering of files and directories to include.
input.templateFile	string	Nunjucks template file used to create templated output.
input.contentFilter	string	Provides a pre-render content filter.
output	object	Output configuration.
output.type	OutputType	Output type configuration.
output.file	object	Configuration for OutputType.File.
output.file.splitting	FileSplitting	Defines on how file output should be generated.
output.file.path	string	Depending on the splitting option a single file or a directory path.
output.file.extension	string	Extension to add to each output file if path does not aleady represent a file path.
output.contentFilter	function	Provides a post-render content filter.

OutputType

Enumeration providing a list of all built-in output types.

Kind: global enum
Properties

Name	Default	Description
ReturnOnly	ReturnOnly	Just return a string.
StdOut	StdOut	Print all to stdout.
File	File	Write everything to files.

FileSplitting

Enumeration providing a list of all possible file output types.

Kind: global enum
Properties

Name	Default	Description
AllInOne	AllInOne	Put all results into one big file.
OnePerResource	OnePerResource	Create one result file per resource.

render(config) ⇒ Promise

Parses and renders RAML service definitions. Depending on the provided configuration, this method will send its output to different locations.

Kind: global function

Param	Type	Description
config	object	Configuration based on the options provided by DefaultConfig.

parse(config) ⇒ Promise

Parses RAML service definitions returns a promise containing an object with all parsed values when resolved.

Kind: global function

Param	Type	Description
config	object	Configuration based on the options provided by DefaultConfig