https://github.com/maoueh/typedoc-bug-1020-repro

A tiny repro case for TypeStrong/typedoc#1020 bug
https://github.com/maoueh/typedoc-bug-1020-repro

Last synced: 25 days ago
JSON representation

A tiny repro case for TypeStrong/typedoc#1020 bug

• Host: GitHub
• URL: https://github.com/maoueh/typedoc-bug-1020-repro
• Owner: maoueh
• Created: 2019-04-19T21:02:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-20T01:31:24.000Z (over 5 years ago)
• Last Synced: 2024-10-12T12:15:04.620Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Typedoc nested parameters not rendered bug (union type problem)

See https://github.com/TypeStrong/typedoc/issues/1020

The bug seems to occur only when `tsconfig.json#strict` option is `true`.

At least in this case. The bug report there however report another

repro case for which `strict` is not set (so should be `false`).

Steps:

```

$ yarn install

$ yarn run typedoc --module commonjs --out docs

$ grep "NestedParameter" ./docs/modules/_index_.html

$ echo $?

1

```

Change `strict: false` in `tsconfig.json` then:

```

$ yarn run typedoc --module commonjs --out docs

$ grep "NestedParameter" ./docs/modules/_index_.html

$ echo $?

0

```