Typedef

Static Public Summary
public	AST: Object
public	ASTNode: Object
public	CoverageObject: Object
public	DocObject: Object Parsed doc comment.
public	DocTypedef: Object
public	ESDocCLIArgv: Object ESDocCLI uses argv
public	ESDocConfig: Object esdoc2 config object.
public	IceCap: Object
public	IceCapInstanceTypedef: Object
public	ManualConfigItem: Object
public	NPMPackageObject: Object
public	PackageTypedef: Object
public	ParsedParam: Object
public	Taffy: Object
public	TaffyCursor: Object
public	Tag: Object doc comment tag.

Static Public

public AST: Object source

Properties:

Name	Type	Attribute	Description
body	Object
leadingComments	Object[]

See:

https://github.com/estree/estree

public ASTNode: Object source

Properties:

Name	Type	Attribute	Description
type	string
superClass	Object	optional
leadingComments	Object[]	optional
trailingComments	Object[]	optional
body	Object[]	optional
parent	ASTNode	optional	this is customize by esdoc2

See:

https://github.com/estree/estree

public CoverageObject: Object source

Properties:

Name	Type	Attribute	Description
coverage	string		ratio.
expectCount	number		all identifier count.
actualCount	number		documented identifier count.
files	Object<string, Object>		file name and coverage.

public DocObject: Object source

Parsed doc comment.

public DocTypedef: Object source

public ESDocCLIArgv: Object source

ESDocCLI uses argv

Properties:

Name	Type	Attribute	Description
h	boolean	optional	for help
help	boolean	optional	for help
v	boolean	optional	for version
version	boolean	optional	for version
c	string	optional	for config file path
_	string[]	optional	for source directory path

public ESDocConfig: Object source

esdoc2 config object.

Properties:

Name	Type	Attribute	Description
source	string	nullable: false	directory path of javascript source code.
destination	string	nullable: false	directory path of output.
title	string	optional
includes	string[]	optional default: ["\\.(js\|es6)$"]
excludes	string[]	optional default: ["\\.config\\.(js\|es6)$"]
access	string[]	optional default: ["public", "protected"]
autoPrivate	boolean	optional default: true
builtinExternal	boolean	optional default: true
unexportIdentifier	boolean	optional default: false
undocumentIdentifier	boolean	optional default: true
coverage	boolean	optional default: true
debug	boolean	optional default: false
index	string	optional default: "./README.md"
package	string	optional default: "./package.json"
styles	string[]	optional default: []
scripts	string[]	optional default: []
test	{type: string, source: string, includes: string[], excludes: string[]}
manual	Object	optional
manual.globalIndex	boolean
manual.asset	string
manual.index	string
manual.overview	string[]
manual.design	string[]
manual.installation	string[]
manual.usage	string[]
manual.tutorial	string[]
manual.configuration	string[]
manual.example	string[]
manual.advanced	string[]
manual.faq	string[]
manual.changelog	string[]
experimentalProposal	Object	optional
experimentalProposal.classProperties	boolean
experimentalProposal.objectRestSpread	boolean
experimentalProposal.doExpressions	boolean
experimentalProposal.functionBind	boolean
experimentalProposal.functionSent	boolean
experimentalProposal.asyncGenerators	boolean
experimentalProposal.decorators	boolean
experimentalProposal.exportExtensions	boolean
experimentalProposal.dynamicImport	boolean

See:

https://esdoc2.org/config.html

public IceCap: Object source

See:

https://github.com/h13i32maru/ice-cap

public IceCapInstanceTypedef: Object source

Properties:

Name	Type	Attribute	Description
loop	function
attr	function
text	function
load	function
into	function
drop	function
html	string

TODO:

remove this typedef.

public ManualConfigItem: Object source

Properties:

Name	Type	Attribute	Description
label	string
paths	string[]
fileName	string	optional
reference	string	optional

public NPMPackageObject: Object source

See:

https://docs.npmjs.com/files/package.json

public PackageTypedef: Object source

Properties:

Name	Type	Attribute	Description
repository	Object
repository.url	string

public ParsedParam: Object source

Properties:

Name	Type	Attribute	Description
nullable	boolean	optional
types	string[]
spread	boolean	optional
optional	boolean	optional
defaultValue	string	optional
defaultRaw	*	optional
name	string	optional
description	string	optional

public Taffy: Object source

See:

http://www.taffydb.com/

public TaffyCursor: Object source

Properties:

Name	Type	Attribute	Description
each	function

TODO:

remove this typedef.

public Tag: Object source

doc comment tag.

Properties:

Name	Type	Attribute	Description
tagName	string
tagValue	*