Skip to content
@ng-doc/core / Interface

NgDocApi

No documentation has been provided.

Extends
NgDocBaseEntity
DeclarationTypeScript
export interface NgDocApi extends NgDocBaseEntity { … }

Members

Properties

7
category?: NgDocCategory | undefined

The page category

hidden?: boolean | undefined
inherited from NgDocBaseEntity

If true the page will be hidden from the sidebar

keyword?: string | undefined

Custom keyword that uses to create links to this page

order?: number | undefined
inherited from NgDocBaseEntity

Order is using for sorting entities in the sidebar

route?: string | undefined
overrides NgDocBaseEntity

The route of the entity (current sourceFileFolder name by default)

scopes: NgDocApiScope[]

The API scopes, you can use it to define scopes for files that should be included to the API

title: string
inherited from NgDocBaseEntity

The entity title

Symbol
Kind
Interface
Extends
NgDocBaseEntity
Scope
@ng-doc/core
Edit this page