Home Manual Reference Source Test Repository 
import ESDocCLI from 'esdoc/src/ESDocCLI.js'
public class | source

ESDocCLI

Command Line Interface for ESDoc.

Example:

let cli = new ESDocCLI(process.argv);
cli.exec();

Test:

Constructor Summary

Public Constructor
public

Create instance.

Member Summary

Private Members
private

Method Summary

Public Methods
public

exec()

execute to generate document.
Private Methods
private

create config object from config file.
private

show help of ESDoc
private

show version of ESDoc

Public Constructors

public constructor(argv: Object) source

Create instance.

Params:

NameTypeAttributeDescription
argv Object

this is node.js argv(process.argv)

Private Members

private _argv: ESDocCLIArgv source

Public Methods

public exec() source

execute to generate document.

Test:

Private Methods

private _createConfigFromJSONFile(configFilePath: string): ESDocConfig source

create config object from config file.

Params:

NameTypeAttributeDescription
configFilePath string

config file path.

Return:

ESDocConfig

config object.

Test:

private _showHelp() source

show help of ESDoc

private _showVersion() source

show version of ESDoc