Class TsDoc

constructor

• new TsDoc(code?, options?): TsDoc

• Creates a new TSDoc comment.

  Parameters

  • Optional code: string

    The TSDoc block comment soruce code.

  • Optional options: TsDocOptions

    Options for the TSDoc instance.

  Returns TsDoc

  Throws

  If the provided code is not a valid TSDoc block comment.

Readonly multi

Readonly namedMulti

Readonly single

Static defaultTagOrder

isEmpty

• get isEmpty(): boolean

• Returns whether the TsDoc instance has no tags.

  Returns boolean

size

• get size(): number

• The number of tags in the TsDoc instance.

  Returns number

addBlockComment

• addBlockComment(code): TsDoc

• Parses a TSDoc block comment and adds the tags to the TsDoc instance.

  Parameters

  • code: string

    The TSDoc block comment soruce code.

  Returns TsDoc

addTag

• addTag(tsDocTag): TsDoc

• Adds a TsDocTag to the TsDoc instance.

  Parameters

  • tsDocTag: TsDocTag

    The TsDocTag to add.

  Returns TsDoc

assign

• assign(tsdoc): TsDoc

• Merge tags from another TsDoc instance.

  Parameters

  • tsdoc: TsDoc

  Returns TsDoc

clear

• clear(): TsDoc

• Deletes all tags. The tagOrder and paramOrder properties are not affected.

  Returns TsDoc

clone

• clone(): TsDoc

• Returns a deep clone of this instance.

  Returns TsDoc

getTagOrder

• getTagOrder(): string[]

• Returns the order in which tags are rendered in the TSDoc comment. If no tagOrder was specified in the constructor options, TsDoc.defaultTagOrder is used.

  Returns string[]

iterateTags

• iterateTags(withSpaces?): Generator<"" | TsDocTag, any, unknown>

• Iterate tags in the order specified in the ´tagOrder´ and ´paramOrder´ properties.

  Parameters

  • Optional withSpaces: boolean

    Whether to yield empty strings encountered in ´tagOrder´. Empty strings are used to add spacing between tags.

  Returns Generator<"" | TsDocTag, any, unknown>

removeTags

• removeTags(tag, name?): TsDoc

• Deletes one or all TsDocTag matching the provided tag. If name is not provided, all tags matching the provided tag are deleted.

  Parameters

  • tag: string

    The tag to remove.

  • Optional name: string

    The name of the tag to remove.

  Returns TsDoc

render

• render(): string

• Renders a TSDoc block comment string with all tags in the order specified by the tagOrder property.

  Returns string

reorderParams

• reorderParams(): TsDoc

• Sort the param tags according to the order specified in the paramOrder property.

  Returns TsDoc

toString

• toString(): string

• Renders a TSDoc block comment string with all tags in the order specified by the tagOrder property.

  Returns string

  Remarks

  Identical to the render method.