Global

Type Definitions

EventNames

Source:
Properties:
Name Type Description
parseBegin string

The event triggered before the files are parsed.
newComment string

The event triggered when the plugin finds a new JSDoc comment.
commentsReady string

The event triggered when all the comments were analyzed and the features should start making modifications to the code.
Type:

TSUtilsOptions

Source:
Properties:
Name Type Attributes Description
typedefImports boolean

Whether or not to enable the feature that removes typedef statements that use import. Default true.
typeOfTypes boolean

Whether or not to enable the feature that replaces {Class.<T>} with {Class.<T>}. Default true.
extendTypes boolean

Whether or not to enable the feature that allows intersections to be reformatted. Default true.
removeTaggedBlocks boolean

Whether or not to enable the feature that removes blocks that use the @jsdoc-remove tag.
removeTags boolean

Whether or not to enable the feature that removes tags that follow a @jsdoc-remove-next-tag tag.
modulesOnMemberOf boolean

Whether or not to enable the feature that fixes modules' paths on memeberof so they can use dot notation. Default true.
modulesTypesShortName boolean

Whether or not to register modules types without the module path too. Default true.
parentTag boolean

Whether or not to transform all parent tags into memberof. Default true.
typeScriptUtilityTypes boolean

Whether or not to add the external utility types from TypeScript. Default true.
tagsReplacement Object.<string, string> <nullable>

A dictionary of tags to replace, they keys are the tags being used and the values the tag that should be used. Default null.
Type:

TagsReplacementDictionary

Source:
Type: