docholiday

API

Documentation generated by <a href=https://tremho.github.io/docholiday/>Doc-Holiday</a>

Modules

Module	Description
CommentBlock	CommentBlock (Module) Expresses stub output. Converts SourceInfo-derived data objects into appropriate JSDOC comment blocks and associated code stubs.
CustomRender	CustomRender (Module) Handles } extensions currently supporting `text`, `jsdoc`, and `plantUML`
execCmd	execCmd (Module) Module for the `executeCommand` function
Globber	Globber (Module) Module for evaluating glob patterns
index	index (Module) The cli executor and the main API import for Doc-holiday Prime Export This is the prime module for import, and although other code modules are listed in the documentation as the source modules, do not try to import these modules directly. All symbols can be found at the prime `index` root. for example: `import {SourceInfo, analysisJSON} from "@tremho/doc-holiday"` will work to bring in `SourceInfo` (from `types`) and `analysisJSON` (from `Output`)
Output	Output (Module) Output module that processes the stub output. records entities that have been parsed for a module writes ordered stubs out to a text file that can be processed by a JSDOC engine
ProcessFiles	ProcessFiles (Module) Module for handling processing of source files
SourceReader	SourceReader (Module) Source code reader and parser to identify code entities and extract metadata
TypeCheck	TypeCheck (Module) Module for Constraint definitions and TypeCheck support
types	types (Module) Type and Class structures of Doc-Holiday

CommentBlock

CommentBlock (Module)

Expresses stub output. Converts SourceInfo-derived data objects into appropriate JSDOC comment blocks and associated code stubs.

CommentBlock

CommentBlock~renderCommentBlock(entityInfo, indent)

Renders the comment block for the entity, and its associated stub code

Kind: inner method of CommentBlock
Access: public

Param	Type	Description
entityInfo	`FunctionInfo` \| `ClassInfo` \| `PropertyInfo` \| `EnumInfo` \| `TypedefInfo`	<p>SourceInfo-derived data object of the parsed code entity</p>
indent	`number`	<p>indent margin where the comment block begins</p>

CommentBlock~renderClassStub(ci, indent, [forClass])

Renders the code stub for a class. Unless an inner class, the stub will encapsulate other comment blocks and stubs representing the inner members of this class.

Kind: inner method of CommentBlock
Access: public

Param	Type	Default
ci	`ClassInfo`
indent	`number`
[forClass]	`string`	`"''"`

CommentBlock~renderFunctionStub(fi, indent, [forClass])

Renders the function stub. The only purpose for the stub is to give JSDOC rendering engines the entity anchor for the comment block above. So the actual 'function' does not need to represent the contract. Nevertheless, this rendering outputs the parameters and returns a value representing the primitive return type.

Kind: inner method of CommentBlock
Access: public

Param	Type	Default
fi	`FunctionInfo`
indent	`number`
[forClass]	`string`	`"''"`

CommentBlock~renderPropertyStub(pi, indent)

Renders a code stub for a declared property.

Kind: inner method of CommentBlock
Access: public

Param	Type
pi	`PropertyInfo`
indent	`number`

CommentBlock~renderTypedefStub(ti, indent)

Renders a code stub for a typedef. No stub is necessary for a typedef

Kind: inner method of CommentBlock
Access: public

Param	Type
ti	`TypedefInfo`
indent	`number`

CommentBlock~renderEnumStub(ei, indent)

Renders a code stub for an Enumeration

Kind: inner method of CommentBlock
Access: public

Param	Type
ei	`EnumInfo`
indent	`number`

CustomRender

CustomRender (Module)

Handles } extensions currently supporting text, jsdoc, and plantUML

CustomRender
- ~handleInternalCustom(name, argMap, text) ⇒ string
- ~handleExternalCustom(name, args, text) ⇒ Promise.<string>

CustomRender~handleInternalCustom(name, argMap, text) ⇒ `string`

Checks to see if one of the locally handled extensions is being referenced, and if so performs the requested rendering.

This is called by the CommentBlock processing when it detects a

Kind: inner method of CustomRender
Access: public

Param	Type
name	`string`
argMap	`any`
text	`string`

CustomRender~handleExternalCustom(name, args, text) ⇒ `Promise.<string>`

Checks to see if one of the locally handled extensions is being referenced, and if so performs the requested rendering.

This is called by the CommentBlock processing when it detects a

Kind: inner method of CustomRender
Access: public

Param	Type
name	`string`
args	`Array.<string>`
text	`string`

execCmd

execCmd (Module)

Module for the executeCommand function

execCmd
- ~executeCommand(cmd, args, [cwd], [consolePass], [env]) ⇒ Promise.<ExecResult>
- ~ExecResult : object

execCmd~executeCommand(cmd, args, [cwd], [consolePass], [env]) ⇒ `Promise.<ExecResult>`

Execute an external command and return the results in stdout string, stderr string, return code. Optionally allow command to echo to console in real time, or run silent.

Kind: inner method of execCmd
Access: public

Param	Type	Default	Description
cmd	`string`		<p>command to execute</p>
args	`Array.<any>`		<p>to pass to command, as an array</p>
[cwd]	`string`	`"''"`	<p>working directory to run command, if not the currently set one</p>
[consolePass]	`boolean`	`false`	<p>`true` to allow command to echo its output in real time</p>
[env]	`any`	`{}`	<p>any environment values, in key=value form.</p>

execCmd~ExecResult : `object`

Kind: inner typedef of execCmd
Properties

Name	Type	Description
stdStr	`string`	<p>text captured fro StdOut of executed process</p>
errStr	`string`	<p>text captured from StdErr of executed process</p>
process	`string`	<p>return code of executed process</p>

Globber

Globber (Module)

Module for evaluating glob patterns

Globber~getGlobbedFiles(globexp) ⇒ `Array.<string>`

Returns a list of files matching glob expression

Kind: inner method of Globber
Access: public

Param	Type
globexp	`string`

index

index (Module)

The cli executor and the main API import for Doc-holiday

Prime Export

This is the prime module for import, and although other code modules are listed in the documentation as the source modules, do not try to import these modules directly. All symbols can be found at the prime index root.

for example:

import {SourceInfo, analysisJSON} from "@tremho/doc-holiday"

will work to bring in SourceInfo (from types) and analysisJSON (from Output)

index
- ~DocOptions
- ~processFileList(files, [outPath]) ⇒ Generator.<string>
- ~docstub(content, [options])
- ~execute()
- ~capToc()

index~DocOptions

Options for stub generation

Kind: inner class of index
Access: public
Properties

Name	Type	Default	Description
sourceType	`string`	`"'ts'"`	<p>either ‘ts’ (typescript) or ‘js’ (javascript)</p>
stubExtension	`string`	`"'.docstub.js'"`	<ul> <li></li> </ul>

index~processFileList(files, [outPath]) ⇒ `Generator.<string>`

Process a list of source files into comment-normalized stubs output to an output path or generating an analysis JSON yield for each file processed.

Kind: inner method of index
Access: public

Param	Type	Default	Description
files	`Array.<string>`
[outPath]	`string`	`"''"`	<p>if ‘’, analysis JSON will be emitted instead on each yield</p>

index~docstub(content, [options])

Convert source text into documentation stub output

Kind: inner method of index
Access: public

Param	Type	Description
content	`string`	<p>The original source to convert</p>
[options]	`DocOptions`	<p>Options affecting stub creation</p>

index~execute()

Executes the jsdoc or similar documentation generation according to the doc-holiday.conf file settings. In normal flow, this is called after docstub generation for all source files is complete, and the configuration is set to generate from the docstub .js files in the intermediate directory (gen).

Kind: inner method of index
Access: public

index~capToc()

Removes the ToC from a DocumentationJS generated markdown file. Puts the title and attribution line at the top of a markdown output.

Kind: inner method of index
Access: public

Output

Output (Module)

Output module that processes the stub output.

records entities that have been parsed for a module
writes ordered stubs out to a text file that can be processed by a JSDOC engine

Output

Output~clearRecorded()

Clears the list of recorded entities

Kind: inner method of Output
Access: public

Output~analysisJSON()

Return the recorded analysis as JSON

Kind: inner method of Output
Access: public

Output~recordInfo(info, source)

Records the information of a parsed entity into the collection

Kind: inner method of Output
Access: public

Param	Type
info	`ClassInfo` \| `FunctionInfo` \| `PropertyInfo` \| `EnumInfo` \| `TypedefInfo`
source	`string`

Output~findSourceIndent(si, source)

Determines the indent of this source by counting whitespace characters from the preceding line start. Note: Does not consider tab expansion

Kind: inner method of Output
Access: public

Param	Type
si	`SourceInfo`
source	`string`

Output~readModuleDescription(source)

Examines the top lines of the source for a module description.

A module description is any comment block of one or more lines starting at the very first line and ending with a blank line below it.

Note: for source code that must include a "#!" "shebang" comment as the first line, the module description comment block can begin on the second line

Kind: inner method of Output
Access: public

Param	Type
source	`string`

Output~sortRecorded()

Sorts the recorded collection of entity info so that the array is represented in the original source code order

Kind: inner method of Output
Access: public

Output~stubOut() ⇒ `string`

Outputs all the recorded entities for a parsed module as a series of comment blocks and code stubs

Kind: inner method of Output
Access: public

Output~writeStubFile(filePath, moduleName, moduleDescription)

Writes the stubbed version of af module source to the stub file

Kind: inner method of Output
Access: public

Param	Type
filePath	`string`
moduleName	`string`
moduleDescription	`string`

ProcessFiles

ProcessFiles (Module)

Module for handling processing of source files

ProcessFiles
- ~processSourceFile(srcPath, fncallback, prcallback, clscallback, encallback, tdcallback)
- ~processSource(contents, ext, fncallback, prcallback, clscallback, encallback, tdcallback)

ProcessFiles~processSourceFile(srcPath, fncallback, prcallback, clscallback, encallback, tdcallback)

read and parse the given source file and emit each instance of FunctionInfo via the given callback

Kind: inner method of ProcessFiles
Access: public

Param	Type	Description
srcPath	`string`	<p>The path to the source file to read</p>
fncallback	`FICallback`	<p>the function that will receive the FunctionInfo instances emitted by the parse.</p>
prcallback	`PICallback`	<p>the function that will receive the PropertyInfo instances emitted by the parse.</p>
clscallback	`CICallback`	<p>the function that will receive the ClassInfo instances emitted by the parse.</p>
encallback	`EICallback`	<p>the function that will receive the EnumInfo instances emitted by the parse.</p>
tdcallback	`TICallback`

ProcessFiles~processSource(contents, ext, fncallback, prcallback, clscallback, encallback, tdcallback)

Process source as text

Kind: inner method of ProcessFiles
Access: public

Param	Type	Description
contents	`string`	<p>to process</p>
ext	`string`	<p>or ‘ts’ for javascript or typescript source</p>
fncallback	`FICallback`	<p>to call on each FunctionInfo parse</p>
prcallback	`PICallback`	<p>to call on each PropertyInfo parse</p>
clscallback	`CICallback`	<p>to call on each ClassInfo parse</p>
encallback	`EICallback`	<p>to call on each EnumInfo parse</p>
tdcallback	`TICallback`

SourceReader

SourceReader (Module)

Source code reader and parser to identify code entities and extract metadata

SourceReader
- ~SourceReader
  - new SourceReader(srcText, ext)
  - .skipTop()
  - .pastWhite(str, [startIndex])
  - .skipWhite()
  - .findWhite(str, startIndex)
  - .readNextWord(str, startIndex)
  - .skipImport()
  - .skipExport()
  - .skipRequire()
  - .skipDHOFF()
  - .nextEnd([isType])
  - .readSourceLine([isType])
  - .readTypeDef(str, startIndex)
  - .getFunctionName(inClass, text) ⇒ string
  - .extractMethodInfo(name,si, [longsrc]) ⇒ FunctionInfo
  - .deriveTypeFromValue(value)
  - .myBracketExtract(src, pair)
  - .extractConstraints(description, type) ⇒ object

SourceReader~SourceReader

The primary source parsing object. Maintains its parsing position in the source internally.

Call getApiInfo to receive a full analysis of the given source.

Kind: inner class of SourceReader
Access: public

~SourceReader
- new SourceReader(srcText, ext)
- .skipTop()
- .pastWhite(str, [startIndex])
- .skipWhite()
- .findWhite(str, startIndex)
- .readNextWord(str, startIndex)
- .skipImport()
- .skipExport()
- .skipRequire()
- .skipDHOFF()
- .nextEnd([isType])
- .readSourceLine([isType])
- .readTypeDef(str, startIndex)
- .getFunctionName(inClass, text) ⇒ string
- .extractMethodInfo(name,si, [longsrc]) ⇒ FunctionInfo
- .deriveTypeFromValue(value)
- .myBracketExtract(src, pair)
- .extractConstraints(description, type) ⇒ object

new SourceReader(srcText, ext)

Param	Type	Description
srcText	`string`	<p>the source code content</p>
ext	`string`	<p>either ‘.js’ for javascript or ‘.ts’ for typescript</p>

sourceReader.skipTop()

Skip things like "use strict" at the top.

Kind: instance method of SourceReader
Access: public

sourceReader.pastWhite(str, [startIndex])

returns the position past skipped white space in a given string

Kind: instance method of SourceReader
Access: public

Param	Type	Default
str	`string`
[startIndex]	`number`	`0`

sourceReader.skipWhite()

advance past white space in parsing

Kind: instance method of SourceReader
Access: public

sourceReader.findWhite(str, startIndex)

advances to the next start of white space in parsing

Kind: instance method of SourceReader
Access: public

Param	Type
str	`*`
startIndex	`*`

sourceReader.readNextWord(str, startIndex)

reads the next word, stopping at comma or whitespace

Kind: instance method of SourceReader
Access: public

Param	Type
str	`*`
startIndex	`*`

sourceReader.skipImport()

skips past an import statement

Kind: instance method of SourceReader
Access: public

sourceReader.skipExport()

skips past an export statement

Kind: instance method of SourceReader
Access: public

sourceReader.skipRequire()

skips past a require statement

Kind: instance method of SourceReader
Access: public

sourceReader.skipDHOFF()

Skips code excluded from parsing between ##DH-OFF --> ##DH-ON comments

Kind: instance method of SourceReader
Access: public

sourceReader.nextEnd([isType])

finds the next end of line or start of comment

Kind: instance method of SourceReader
Access: public

Param	Type	Default
[isType]	`boolean`	`false`

sourceReader.readSourceLine([isType])

Reads the next line of source, discrening the start and end of the comment block and code declaration.

Kind: instance method of SourceReader
Access: public

Param	Type	Default
[isType]	`boolean`	`false`

sourceReader.readTypeDef(str, startIndex)

Read a type description. Includes support for template types.

Kind: instance method of SourceReader
Access: public

Param	Type
str	`*`
startIndex	`*`

sourceReader.getFunctionName(inClass, text) ⇒ `string`

Determines if the source appears to be a function, and if so returns the function name. Otherwise an empty string ('') is returned.

Kind: instance method of SourceReader
Access: public

Param	Type	Description
inClass	`boolean`	<p>if we are parsing a class</p>
text	`string`

sourceReader.extractMethodInfo(name,si, [longsrc]) ⇒ `FunctionInfo`

Try to build a valid FunctionInfo entity from the given SourceInfo

Kind: instance method of SourceReader
Access: public

Param	Type	Default
name,si	`SourceInfo`
[longsrc]	`string`	`"''"`

sourceReader.deriveTypeFromValue(value)

returns the associated primitive type for a value represented by the given value string

Kind: instance method of SourceReader
Access: public

Param	Type
value	`string`

sourceReader.myBracketExtract(src, pair)

My own bracket matching algorithm

Tried using libraries from npm, such as parenthesis, g2-bracket-parser and peeler but each of these had some failing or another that prevented it from working as I needed it.

This version works, although it is not elegant. It parses one character at a time, which thankfully turns out to run faster than I originally feared. This allows treating the problem from a state-machine perspective, and there is no chance of skipping a stateful event (although I suppose an optimization could be made to skip whitespace, or clearly defined comment blocks).

This simply counts brackets and levels until we return to level 0 it statefully ignores brackets that are out of scope, including cases for:

comments
quoted strings (single, double, and backtick)
handles escapes for quote scope recognition

Kind: instance method of SourceReader
Access: public

Param	Type	Description
src	`string`	<p>bracketed source</p>
pair	`string`	<p>matching pair that define the bracket delimiters</p>

sourceReader.extractConstraints(description, type) ⇒ `object`

Extracts the constraints from the description. Returns a formatted object with results.

Kind: instance method of SourceReader
Returns: object - <p>Object detail: {description:string, constraintMap:any, error:string, status:SpecificationStatus}</p>
Access: public

Param	Type
description	`string`
type	`string`

TypeCheck

TypeCheck (Module)

Module for Constraint definitions and TypeCheck support

TypeCheck
- ~TypeConstraint
- ~ValueType
- ~ElementCheckType
- ~valueTypeFromString(str) ⇒ ValueType
- ~stringFromValueType(vt) ⇒ string
- ~parseConstraintsToMap(typeString, [blockSet]) ⇒ Map.<string, TypeConstraint>
- ~parseConstraints(type, block) ⇒ TypeConstraint
- ~validate(value, constraintString) ⇒ string

TypeCheck~TypeConstraint

Base form of TypeConstraint. Defines the base type and the test method.

Kind: inner class of TypeCheck
Access: public
Properties

Name	Type	Description
type	`string`	<p>The type this constraint applies to</p>
[badName]	`string`	<p>defined only if we encounter an unrecognized constraint keyword</p>
[note]	`string`	<p>a freeform note that appears in comments. No runtime verification.</p>

~TypeConstraint

new TypeConstraint([typeString])

Param	Type	Default
[typeString]	`string`	`"''"`

typeConstraint.test(value)

Perform a runtime test of the value

returns without throw if test was okay, otherwise throws a ConstraintError explaining the violation.

Kind: instance method of TypeConstraint
Access: public

Param	Type	Description
value	`any`	<ul> <li>value to test against this constraint</li> </ul>

typeConstraint.toString()

Describes the constraint in printable terms (not really used, a bit redundant to describe)

Kind: instance method of TypeConstraint
Access: public

typeConstraint.describe()

describe the constraints in human terms.

Kind: instance method of TypeConstraint
Access: public

TypeCheck~ValueType

Enumeration of basic types

see stringFromValueType
see valueTypeFromString

Kind: inner enum of TypeCheck
Read only: true
Properties

Name	Type	Default	Description
none	`number`	`none`	<p>*(value = 0)*</p>
number	`number`	`number`	<p>*(value = 1)*</p>
string	`number`	`string`	<p>*(value = 2)*</p>
boolean	`number`	`boolean`	<p>*(value = 3)*</p>
object	`number`	`object`	<p>*(value = 4)*</p>
array	`number`	`array`	<p>*(value = 5)*</p>
regex	`number`	`regex`	<p>*(value = 6)*</p>

TypeCheck~ElementCheckType

Enumeration of checkType parsed results.

parameters (p1, p2) are parsed at same time, and meaning does vary per checkType.

Kind: inner enum of TypeCheck
Read only: true
Properties

Name	Type	Default	Description
none	`number`	`none`	<p>don’t test the elements *(value = 0)*</p>
all	`number`	`all`	<p>test all the elements *(value = 1)*</p>
random	`number`	`random`	<p>test up to a given number (p1) of elements, randomly chosen *(value = 2)*</p>
step	`number`	`step`	<p>test every (p1) elements *(value = 3)*</p>
first	`number`	`first`	<p>test all up to (p1) elements, then stop *(value = 4)*</p>
last	`number`	`last`	<p>test all of the last (p1) elements *(value = 5)*</p>
firstThenLast	`number`	`firstThenLast`	<p>Test the first (p1) elements, and the last (p2) elements *(value = 6)*</p>
firstThenStep	`number`	`firstThenStep`	<p>test all up to (p1) elements, then every (p2) thereafter *(value = 7)*</p>
firstThenRandom	`number`	`firstThenRandom`	<p>test all up to (p1) elements, then up to (p2) of the remaining, chosen at random *(value = 8)*</p>

TypeCheck~valueTypeFromString(str) ⇒ `ValueType`

Translates a type string (number, string, boolean, object, array, regex) into the corresponding ValueType enum Note that strings beside none, array, and regex are synonymous with the typeof operator value

Kind: inner method of TypeCheck
Access: public

Param	Type
str	`string`

TypeCheck~stringFromValueType(vt) ⇒ `string`

Translates a ValueType enum value into the corresponding string. Note that strings beside none, array, and regex are synonymous with the typeof operator value

Kind: inner method of TypeCheck
Access: public

Param	Type
vt	`ValueType`

TypeCheck~parseConstraintsToMap(typeString, [blockSet]) ⇒ `Map.<string, TypeConstraint>`

parse constraints from what may be more than one type (e.g. string|number)

Kind: inner method of TypeCheck
Access: public

Param	Type	Default
typeString	`string`
[blockSet]	`string`	`"''"`

TypeCheck~parseConstraints(type, block) ⇒ `TypeConstraint`

Given a block of text, parse as constraints and return the set if this is a constraint declaration otherwise, return ConstraintStatus.NotConstraint to signify this is a description block and not a constraint declaration

Kind: inner method of TypeCheck
Access: public

Param	Type	Description
type	`*`	<ul> <li>the block of text to evaluate</li> </ul>
block	`*`	<ul> <li>the type parsed from the param or return declaration</li> </ul>

TypeCheck~validate(value, constraintString) ⇒ `string`

Simple test to see if a value adheres to a set of constraints

Kind: inner method of TypeCheck
Returns: string - <p>returns ‘’ if no violation, otherwise returns the error string of the ConstraintError encountered</p>
Access: public

Param	Type	Description
value	`any`	<p>The value to test for constraints. Must be one of the basic types supported by contraints</p>
constraintString	`string`	<p>the constraints to test it against. Constraints listed must match the type being tested. Do not include <> brackets.</p>

types

types (Module)

Type and Class structures of Doc-Holiday

types
- ~ScopeModifiers
- ~SourceInfo
- ~FunctionInfo ⇐ SourceInfo
- ~ClassInfo ⇐ SourceInfo
- ~PropertyInfo ⇐ SourceInfo
- ~EnumInfo ⇐ SourceInfo
- ~EnumValueInfo
- ~TypedefInfo ⇐ SourceInfo
- ~APIInfo
- ~ParameterInfo
- ~ReturnInfo
- ~TypedefForm
- ~SpecificationStatus
- ~FICallback : function
- ~PICallback : function
- ~EICallback : function
- ~TICallback : function
- ~CICallback : function

types~ScopeModifiers

Details about the scope of an entity

Kind: inner class of types
Access: public
Properties

Name	Type	Description
[static]	`boolean`	<ul> <li></li> </ul>
[public]	`boolean`	<ul> <li></li> </ul>
[private]	`boolean`	<ul> <li></li> </ul>
[optional]	`boolean`	<ul> <li></li> </ul>
[const]	`boolean`	<ul> <li></li> </ul>
[async]	`boolean`	<ul> <li></li> </ul>
[generator]	`boolean`	<ul> <li></li> </ul>

types~SourceInfo

Information of where in the source file this entity exists

Kind: inner class of types
Access: public
Properties

Name	Type	Default	Description
decStart	`number`	`-1`	<p>source position where declaration begins</p>
decEnd	`number`	`-1`	<p>source position where declaration ends</p>
comStart	`number`	`-1`	<p>source position where associated comment begins</p>
comEnd	`number`	`-1`	<p>source position where associated comment ends</p>

types~FunctionInfo ⇐ `SourceInfo`

Information about a function within the source

Kind: inner class of types
Extends: SourceInfo
Access: public
Properties

Name	Type	Default	Description
name	`string`	`"''"`	<p>Name of the function</p>
scope	`ScopeModifiers`	`new`	<p>ScopeModifiers() - The scope modifiers of the function</p>
description	`string`		<p>the comment description of this function</p>
params	`Array.<ParameterInfo>`	`[`	<p>array of the function parameters</p>
[return]	`ReturnInfo`		<p>return information of this function</p>
bodyStart	`number`	`-1`	<p>source position where body of function starts</p>
bodyEnd	`number`	`-1`	<p>source position where body of function ends</p>
status	`SpecificationStatus`	`SpecificationStatus.None`	<p>status of the parse</p>
[error]	`string`		<p>if defined, holds error detail. status will hold the coded value.</p>

types~ClassInfo ⇐ `SourceInfo`

Information about a class within the source

Kind: inner class of types
Extends: SourceInfo
Access: public
Properties

Name	Type	Default	Description
name	`string`	`"''"`	<p>name of this class</p>
ClassInfo.rather	`class`		<p>name of this class</p>
[rather.ClassInfo.name]	`string`	`"\"\""`	<p>name of this property</p>
[rather.ClassInfo.type]	`string`	`"\"\""`	<p>type of property</p>
[rather.ClassInfo.scope]	`ScopeModifiers`	`new ScopeModifiers()`	<p>scope modifiers of the property</p>
[rather.ClassInfo.description]	`string`	`"''"`	<p>comment dsescription of property</p>
[rather.ClassInfo.assignStart]	`number`	`-1`	<p>source position where assignment to value begins</p>
[rather.ClassInfo.default]	`string`	`"''"`	<p>the default value assigned to this property</p>
[rather.ClassInfo.TypeConstraint>]	`string`	`"new Map<string, TypeConstraint>()"`	<p>any constraints assigned to this property</p>

types~PropertyInfo ⇐ `SourceInfo`

Information about a non-function property within a source file or within a class

Kind: inner class of types
Extends: SourceInfo
Access: public
Properties

Name	Type	Default	Description
name	`string`	`"\"\""`	<p>name of this property</p>
type	`string`	`"\"\""`	<p>type of property</p>
scope	`ScopeModifiers`	`new`	<p>ScopeModifiers() - scope modifiers of the property</p>
description	`string`	`"''"`	<p>comment dsescription of property</p>
assignStart	`number`	`-1`	<p>source position where assignment to value begins</p>
default	`string`	`"''"`	<p>the default value assigned to this property</p>
TypeConstraint>	`string`	`"new"`	<p>Map<string, TypeConstraint>() - any constraints assigned to this property</p>

types~EnumInfo ⇐ `SourceInfo`

Information about an enum

Kind: inner class of types
Extends: SourceInfo
Access: public
Properties

Name	Type	Default	Description
Enum	`string`		<p>name of this Enum</p>
scope	`ScopeModifiers`	`new`	<p>ScopeModifiers() - scope modifiers of this Enum</p>
description	`string`	`"''"`	<p>comment description</p>
values	`Array.<EnumValueInfo>`	`[`	<p>details on each enumerated value</p>
bodyStart	`number`	`-1`	<p>source position body start</p>
bodyEnd	`number`	`-1`	<p>source position body end</p>

types~EnumValueInfo

Information about a single enum value

Kind: inner class of types
Access: public
Properties

Name	Type	Description
value	`string`	<p>name of enum value</p>
value	`string`	<p>type of enum value</p>
enum	`string`	<p>the value of this enum</p>
value	`string`	<p>comment description of this enum value</p>

types~TypedefInfo ⇐ `SourceInfo`

Kind: inner class of types
Extends: SourceInfo
Access: public
Properties

Name	Type	Default	Description
typedef	`string`		<p>Name of this typedef</p>
typedef	`string`		<p>Form of this typedef</p>
typedef	`string`		<p>Type assigned to this typedef</p>
description	`string`	`"''"`	<p>comment description</p>
structure	`string`		<p>for object or function types, the declared structure</p>
TypeConstraint>	`string`	`"new"`	<p>Map<string, TypeConstraint>() - any constraints applied</p>
bodyStart	`number`	`-1`	<p>source position of body start</p>
bodyEnd	`number`	`-1`	<p>source position of body end</p>

types~APIInfo

Top-level collection of all functions, classes, and properties

Kind: inner class of types
Access: public
Properties

Name	Type	Default	Description
functions	`Array.<FunctionInfo>`	`[`	<ul> <li></li> </ul>
classes	`Array.<ClassInfo>`	`[`	<ul> <li></li> </ul>
properties	`Array.<PropertyInfo>`	`[`	<ul> <li></li> </ul>
enums	`Array.<EnumInfo>`	`[`	<ul> <li></li> </ul>
typedefs	`Array.<TypedefInfo>`	`[`	<ul> <li></li> </ul>

types~ParameterInfo

Information about a parameter

Kind: inner class of types
Access: public
Properties

Name	Type	Default	Description
type	`string`	`"''"`	<p>type of parameter</p>
TypeConstraint>	`string`	`"new"`	<p>Map<string, TypeConstraint>() - any constraints applied to parameter value</p>
ordinal	`number`		<p>which parameter in series is this one?</p>
name	`string`		<p>name of the parameter</p>
description	`string`		<p>comment description of parameter</p>
optional	`boolean`		<p>true if this is an optional parameter</p>
default	`string`	`"''"`	<p>defined if there is a default value assigned</p>
status	`SpecificationStatus`	`SpecificationStatus.None`	<p>parse status</p>
error	`string`		<p>if defined, holds error detail. status is probably MISMATCH.</p>

types~ReturnInfo

Information about a return value

Kind: inner class of types
Access: public
Properties

Name	Type	Default	Description
type	`string`	`"''"`	<p>Type being returned</p>
description	`string`		<p>comment description of return value</p>
TypeConstraint>	`string`	`"new"`	<p>Map<string, TypeConstraint>() - any constraints applied to return value</p>
status	`SpecificationStatus`	`SpecificationStatus.None`	<p>parse status</p>

types~TypedefForm

Kind: inner enum of types
Read only: true
Properties

Name	Type	Default	Description
Primitive	`number`	`Primitive`	<p>describes an alias to one or more primitive types *(value = 0)*</p>
Object	`number`	`Object`	<p>describes a typedef to an object *(value = 1)*</p>
Array	`number`	`Array`	<p>describes a typedef to an array *(value = 2)*</p>
Function	`number`	`Function`	<p>a typedef function (aka Callback) *(value = 3)*</p>

types~SpecificationStatus

Parse error status for parameter constraints

Kind: inner enum of types
Read only: true
Properties

Name	Type	Default	Description
None	`number`	`None`	<p>not analyzed *(value = 0)*</p>
Okay	`string`	`"Okay"`	<p>documented and reconciled</p>
BadConstraint	`string`	`"BadConstraint"`	<p>syntax error processing constraint declaration</p>
Mismatch	`string`	`"Mismatch"`	<p>JSDoc does not match typescript declaration</p>

types~FICallback : `function`

Callback for source reader. Calls back with FunctionInfo and associated text for each function in source

Kind: inner typedef of types

Param	Type
fi	`FunctionInfo`
[text]	`string`

types~PICallback : `function`

Callback for source reader. Calls back with PropertyInfo and associated text for each property in source

Kind: inner typedef of types

Param	Type
pi	`PropertyInfo`
[text]	`string`

types~EICallback : `function`

Callback for source reader. Calls back with EnumInfo and associated text for each enum in source

Kind: inner typedef of types

Param	Type
ei	`EnumInfo`
[text]	`string`

types~TICallback : `function`

Callback for source reader. Calls back with TypedefInfo and associated text for each type definition in source

Kind: inner typedef of types

Param	Type
ti	`TypedefInfo`
[text]	`string`

types~CICallback : `function`

Callback for source reader. Calls back with ClassInfo and associated text for each class in source

Kind: inner typedef of types

Param	Type
ci	`ClassInfo`
[text]	`string`