Typedef

Static Public Summary
public	infoObject: Object Validator info object.
public	rocCommandObject: Object Validator info object.
public	rocConfig: Object Roc config object.
public	rocDocumentationObject: Object[] Roc documentation object.
public	rocMapObject: Object Roc map object.
public	rocMetaConfig: Object Roc meta config object.
public	rocMetaSettings: Object Roc meta settings object.
public	rocMetaSettings: Object Roc meta settings object.
public	rocOptions: Object Roc parsed options.
public	rocSettings: Object Roc settings object.
public	rocTableHeader: Object Roc table header object.
public	rocTableSettings: Object Roc table settings object.

Static Public

public infoObject: Object source

Validator info object.

Properties:

Name	Type	Attribute	Description
type	string		The type.
required	boolean		If it is required.

public rocCommandObject: Object source

Validator info object.

Properties:

Name	Type	Attribute	Description
debug	boolean		If debug mode has been enabled.
configObject	rocConfig		The final configuration object where everything has been merged.
metaObject	rocMetaConfig		The final meta configuration object where everything has been merged.
extensionConfig	rocConfig		The configuration object where all extensions has been merged.
parsedOptions	rocOptions		The parsed options given to the cli.

public rocConfig: Object source

Roc config object.

Properties:

Name	Type	Attribute	Description
settings	rocSettings
commands	Object
plugins	Object
extensions	string[]

public rocDocumentationObject: Object[] source

Roc documentation object.

public rocMapObject: Object source

Roc map object.

Properties:

Name	Type	Attribute	Description
name	string
path	string
convertor	function
validator	function

public rocMetaConfig: Object source

Roc meta config object.

Properties:

Name	Type	Attribute	Description
settings	rocMetaSettings
commands	Object
plugins	Object

public rocMetaSettings: Object source

Roc meta settings object.

public rocMetaSettings: Object source

Roc meta settings object.

Properties:

Name	Type	Attribute	Description
descriptions	Object
groups	Object
validations	Object

public rocOptions: Object source

Roc parsed options.

Properties:

Name	Type	Attribute	Description
options	Object
rest	Object

public rocSettings: Object source

Roc settings object.

public rocTableHeader: Object source

Roc table header object.

public rocTableSettings: Object source

Roc table settings object.

See default configuration below:

{
    groupTitleWrapper: (name) => name,
    cellDivider: '|',
    rowWrapper: (input) => `|${input}|`,
    cellWrapper: (input) => ` ${input} `,
    header: true,
    compact: false
}