Home Manual Reference Source Test Repository

Typedef

Static Public Summary
public
public
public
public

Parsed doc comment.
public
public

ESDocCLI uses argv
public

ESDoc config object.
public
public
public
public
public
public
public
public
public

doc comment tag.

Static Public

public AST: Object source

Properties:

NameTypeAttributeDescription
body Object
leadingComments Object[]
trailingComments Object[]

See:

public ASTNode: Object source

Properties:

NameTypeAttributeDescription
type string
superClass Object
  • optional
leadingComments Object[]
  • optional
trailingComments Object[]
  • optional
body Object[]
  • optional
parent ASTNode
  • optional

this is customize by ESDoc

See:

public CoverageObject: Object source

Properties:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
h boolean
  • optional

for help
help boolean
  • optional

for help
{boolean *

[v] - for version
version boolean
  • optional

for version
c string
  • optional

for config file path
_ string[]
  • optional

for source directory path

public ESDocConfig: Object source

ESDoc config object.

Properties:

NameTypeAttributeDescription
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"
importPathPrefix string
  • optional
  • default: ""
styles string[]
  • optional
  • default: []
scripts string[]
  • optional
  • default: []
test {type: string, source: string, includes: string[], excludes: string[]}
manual Object
  • optional
manual.asset string
manual.overview string[]
manual.installation string[]
manual.usage string[]
manual.tutorial string[]
manual.configuration string[]
manual.example string[]
manual.faq string[]
manual.changelog string[]

See:

public IceCap: Object source

See:

public IceCapInstanceTypedef: Object source

Properties:

NameTypeAttributeDescription
loop function
attr function
text function
load function
into function
drop function
html string

TODO:

  • remove this typedef.

public ManualConfigItem: Object source

Properties:

NameTypeAttributeDescription
label string
paths string[]
fileName string
  • optional
reference string
  • optional

public NPMPackageObject: Object source

See:

public PackageTypedef: Object source

Properties:

NameTypeAttributeDescription
repository Object
repository.url string

public ParsedParam: Object source

Properties:

NameTypeAttributeDescription
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:

public TaffyCursor: Object source

Properties:

NameTypeAttributeDescription
each function

TODO:

  • remove this typedef.

public Tag: Object source

doc comment tag.

Properties:

NameTypeAttributeDescription
tagName string
tagValue *