typedoc / jsdoc文档泛型参数（回调参数）

Question

我有以下代码：

type AlarmEvent = events.Event<(name: Alarm) => void>;

如您所见，事件类采用函数签名形式的泛型参数，我想将其记录下来。

有什么想法吗？

Answer 1

如果您只需要挂起正常的JSDocs，您可以创建另一种类型：

type AlarmHandler = (name: Alarm) => void
type AlarmEvent = events.Event<AlarmHandler>

如果您需要使用它来使用JSDoc，您可以在独立的JSDoc注释中使用the @callback tag来完成工作：

/**
 * Handles alarm events
 * @callback
 * @param {Alarm} name The alarm that fired
*/