NgDocPageIndex

Interface for a page index that builder generates.

DeclarationTypeScript

export interface NgDocPageIndex { … }

Members

Properties 10
breadcrumbs: `string[]`	Generated breadcrumbs.
content?: `string \| undefined`	Indexed content Usually content maybe undefined only for the API pages that have no content/documentation.
description?: `string \| undefined`	The first paragraph of the declaration's doc comment, as one line of plain text.
fragment?: `string \| undefined`	The url anchor of the section
kind?: `string \| undefined`	The kind of the declaration, such as `Class` or `Component`. The new engine sets it, with `signature` and `description`, on the records of an API page that belong to no section.
pageType: `NgDocPageType`	The type of the page.
route: `string`	The route that can be used to navigate to the page.
section: `string`	Section where the content is located.
signature?: `string \| undefined`	The declaration header as written, such as `export class NgDocThemeService`, as plain text.
title: `string`	Title of the page.