MathBunny / typedoc-namespace-bug-demo

Minimal example of TypeDoc interface re-export namespace bug (#1353)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TypeDoc Namespace Bug

Simple reproducible setup demonstrating a re-exporting bug in TypeDoc.

Purpose

Highlights the issue of "variables" appearing as a heading for type re-exporting, when in fact it is an interface. The complete source code can be found in src.

/**
 * Sample namespace exported that leverages aliasing. 
 */
export namespace admin.subnamespace{
  export import DemoInterface = demoInterfaceApi.DemoInterface; // DOES NOT WORK!
  export interface DemoClass extends demoClassApi.DemoClass {}
}

Getting started

npm install && npm run build && npm run docs

After, open the generated docs in the docs folder. You'll notice by going to the nested namespace the following:

Related Pull Requests

The following seems related but does not fully satisfy the issue. However, compared to TypeDoc 0.15.0 it is working much better because the re-export appears in the documentation unlike before.

About

Minimal example of TypeDoc interface re-export namespace bug (#1353)


Languages

Language:TypeScript 100.0%