typescript - Compodoc literal type issue - Compodoc shows "literal type" for Type aliases - Stack Overflow

I was wondering if anyone else got this issue where after we generate docs with Compodoc (npx @compodoc

I was wondering if anyone else got this issue where after we generate docs with Compodoc (npx @compodoc/compodoc -p tsconfig.json -s) ALL type aliases show literal type instead of showing the properties a certain type has. For example:

/** 
 * Represents a test field as an example for literal type issue.
 * @type {TestField}
 * @property {string} test1 - The test1 field.
 * @property {string} test2 - The test2 field.
 */
export type TestField = {
  test1: string
  test2: string
}

After generating docs it will show

Did anyone else experience this issue where the description is shown but the type definition just show literal type? It would be great to understand what am I missing here that causes the type definitions to show literal type.

Thank you all in advance!

I was trying to generate Compodoc docs by running npx @compodoc/compodoc -p tsconfig.json -s against my tsconfig.json file, we can see the the doc string description is being generated and shown ok while the type definition (properties this type has) are not shown and we only see literal type. I've asked same question on Compodoc's repo in GitHub:

发布者:admin,转转请注明出处:http://www.yc00.com/questions/1745097098a4611044.html

相关推荐

发表回复

评论列表(0条)

  • 暂无评论

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信