Display Options

Options that are used to configure how the output is structured and displayed.

—hidePageHeader

Accepts a boolean value. Defaults to false.

{
  "hidePageHeader": false
}

—hideBreadcrumbs

Accepts a boolean value. Defaults to false.

{
  "hideBreadcrumbs": false
}

—hidePageTitle

Accepts a boolean value. Defaults to false.

{
  "hidePageTitle": false
}

—hideGroupHeadings

Accepts a boolean value. Defaults to false.

By default members are grouped by kind (eg Classes, Functions etc).

This creates a flat structure where all members are displayed at the same heading level.

{
  "hideGroupHeadings": false
}

—useCodeBlocks

Accepts a boolean value. Defaults to false.

This option can be used to improve readability and aesthetics when defining signatures and declarations.

Please note that when this option is set to true it is not possible to link to other references.

As a work around the @link tag can be be used to manually reference types.

{
  "useCodeBlocks": false
}

—expandObjects

Accepts a boolean value. Defaults to false.

By default objects inside declarations are collapsed to preserve space and improve readability.

This option should be set when a full object representation is preferred.

{
  "expandObjects": false
}

—expandParameters

Accepts a boolean value. Defaults to false.

By default parameters in signature definitions only display the parameter name so the output is more concise.

This option should be set when a full type representation is preferred.

{
  "expandParameters": false
}

—blockTagsPreserveOrder

Accepts an array of string values.

By default block tags (such as @example, @remarks, @deprecated) are rendered after “Parameters”, “Returns” and “Type declaration” sections for signatures and declarations.

The rationale is that comment block tags often contain more detailed, supplementary information and are typically secondary to understanding the primary use of the symbol,

Use this option to preserve the position of the tag content with the comment summary.

{
  "blockTagsPreserveOrder": ["@example", "@deprecated"]
}

—indexFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option renders index items either as a simple unordered list or in a table.

When table style is selected the following will be the behaviour:

• For a members index, a description column will be added with key table - the first paragraph of the comment summary, or key htmlTable - the entire comment contents.
• For a packages index, (when --entryPointStrategy equals packages), the package.json description will be displayed with an additional “Version” column (when --includeVersion equals true).
• For a documents index a description column will be added to the table printing the "description" frontmatter variable.

{
  "indexFormat": "list"
}

—parametersFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option specifies the output format for parameters and type parameters of functions and class methods:

• “list”: parameters are output as bullet points in a linear list, suitable for more detailed comments.
• “table”: parameters are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: parameters are output in an HTML table, enabling block elements to render in table cells.

{
  "parametersFormat": "list"
}

—interfacePropertiesFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option specifies the output format for interface properties:

• “list”: properties are output in linear blocks with headings, suitable for more detailed comments.
• “table”: properties are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: properties are output in an HTML table, enabling block elements to render in tabular format.

{
  "interfacePropertiesFormat": "list"
}

—classPropertiesFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option specifies the output format for class properties:

• “list”: properties are output in linear blocks with headings, suitable for more detailed comments.
• “table”: properties are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: properties are output in an HTML table, enabling block elements to render in tabular format.

{
  "classPropertiesFormat": "list"
}

—enumMembersFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option specifies the output format for enumeration members:

• “list”: members are output in linear blocks with headings, suitable for more detailed comments.
• “table”: members are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: members are output in an HTML table, enabling block elements to render in tabular format.

{
  "enumMembersFormat": "list"
}

—typeDeclarationFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option specifies the output format for type declaration of variables and type aliases.

• “list”: declarations are output in linear blocks with headings, suitable for more detailed comments.
• “table”: declarations are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: declarations are output in an HTML table, enabling block elements to render in tabular format.

{
  "typeDeclarationFormat": "list"
}

—propertyMembersFormat

Accepts one of "list" | "table" | "htmlTable". Defaults to "list".

This option will handle the formatting of object literals assigned as properties in classes or interfaces.

Note this options will only take effect when the property declaration is rendered in a list format.

• “list”: members are output in linear blocks with headings, suitable for more detailed comments.
• “table”: members are output within a Markdown table, condensed into a single paragraph.
• “htmlTable”: members are output in an HTML table, enabling block elements to render in tabular format.

{
  "propertyMembersFormat": "list"
}

—tableColumnSettings

By default, all available data for symbols are displayed in table columns which can result in several columns in certain use-cases.

This option allows you to control the visibility of columns, prioritizing readability over displaying complete data. In addition you can control the alignment of the header text.

{
  "tableColumnSettings": {
    "hideDefaults": false,
    "hideInherited": false,
    "hideModifiers": false,
    "hideOverrides": false,
    "hideSources": false,
    "hideValues": false,
    "leftAlignHeaders": false
  }
}