Class: RenderUtils

RenderUtils()

Utility class for exporting layout specifications (FileDescriptor) to various documentation formats. Supports Markdown, ReStructuredText (RST), and HTML table formats.

Constructor

new RenderUtils()

Source:

renders/RenderUtils.js, line 7

Methods

(static) renderAsHtml(fileDescriptor) → {string}

Renders a FileDescriptor layout specification as an HTML table document string.

Parameters:

Name	Type	Description
`fileDescriptor`	FileDescriptor	Layout descriptor to export.

Source:

renders/RenderUtils.js, line 125

Throws:

If fileDescriptor is not an instance of FileDescriptor.
Type TypeError

Returns:

Formatted HTML text.

Type: string

(static) renderAsMarkdown(fileDescriptor) → {string}

Renders a FileDescriptor layout specification as a Markdown formatted document string.

Parameters:

Name	Type	Description
`fileDescriptor`	FileDescriptor	Layout descriptor to export.

Source:

renders/RenderUtils.js, line 15

Throws:

If fileDescriptor is not an instance of FileDescriptor.
Type TypeError

Returns:

Formatted Markdown text.

Type: string

(static) renderAsRst(fileDescriptor) → {string}

Renders a FileDescriptor layout specification as a ReStructuredText (RST) formatted document string.

Parameters:

Name	Type	Description
`fileDescriptor`	FileDescriptor	Layout descriptor to export.

Source:

renders/RenderUtils.js, line 67

Throws:

If fileDescriptor is not an instance of FileDescriptor.
Type TypeError

Returns:

Formatted ReStructuredText text.

Type: string