Home

Members

DefaultConfig

Defines a default configuration with all possible configuration options.

Functions

render(config)

Parses and renders sequelize models. Depending on the provided configuration, this method will send its output to different locations.

parse(config) ⇒ object

Parses sequelize models and returns a data structure with the required data.

DefaultConfig

Defines a default configuration with all possible configuration options.

Kind: global variable
Properties

Name	Type	Description
fieldBlacklist	array	A list of field names not to include in the output.
models	object	Model related configuration.
models.paths	array	A list of source paths to look for models. This may contain files and directories.
models.pathBlacklist	array	A list of files or directories not to include. May contain absolute and relative paths.
models.recursive	boolean	Whenever to walk recursively through proviced directory paths.
models.initFunction	string	Name of a initialization to call on each model file included.
models.initConfig	object	Configuration object to be passed when a model file gets initialized.
models.directoryFiler	RegExp	Regular Expression for more advanced filtering of directories to include.
models.fileFilter	RegExp	Regular Expression for more advanced filtering of files to include.
input	object	Input configuration.
input.templateFile	string	Nunjucks template file used to create templated output.
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.
sequelize	object	Configuration passed to the constructor of sequelize.

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.
OnePerClass	OnePerClass	Create one result file per class/entity.
AsInSource	AsInSource	Output results the way they where defined together in the corresponding source files.

render(config)

Parses and renders sequelize models. 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) ⇒ object

Parses sequelize models and returns a data structure with the required data.

Kind: global function

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