Skip to main content

​
emit

​
Summary

Converts a TSDoc node tree to markdown text

​
Signature

emit(stringBuilder: StringBuilder, docNode: DocNode, options: IMarkdownEmitterOptions): string;

​
Parameters

​
stringBuilder

Type:StringBuilder Output buffer to write markdown to

​
docNode

Type:DocNode Root TSDoc node to emit

​
options

Type:IMarkdownEmitterOptions Emission configuration options

​
Returns

Type:string Converts a TSDoc node tree to markdown text

​
Remarks

This is the main entry point for markdown emission. It initializes the emission context (writer, formatting state) and recursively processes the node tree. The output is automatically terminated with a newline.