如何为打字稿枚举类型 {[key]: value } 生成文档？

Question

I am writing a logger service for nodeJS in Typescript.我正在 Typescript 中为 nodeJS 编写记录器服务。 I have an enum as below:我有一个枚举如下：

enum LOG_TYPES {
  NONE = 0,
  ERROR = 1,
  WARN = 2,
  INFO = 3,
  DEBUG = 4,
}

then I have an setLogType function:然后我有一个 setLogType 函数：

setLogType(type: LOG_TYPES) {
 this.logType = type
}

My problem is I don't know how to make docs for the type param.我的问题是我不知道如何为type参数制作文档。

My expectation is the recommendation would show like this我的期望是推荐会像这样显示

0                   NONE
1                   ERROR
2                   WARN
3                   INFO
4                   DEBUG
...

Answer 1

enum LOG_TYPES {
  NONE = 0,
  ERROR = 1,
  WARN = 2,
  INFO = 3,
  DEBUG = 4,
}
setLogType(type: keyof typeof LOG_TYPES) {
 this.logType = type
}