Rush Stack商店博客活动
跳至主要内容

@preapproved

标记类型: 修饰符

TSDoc 标准化: 无;此标记是 API 提取器专有的

即使 API 被标记为 @internal,其签名仍将在 API 报告文件中跟踪(*.api.md 文件),因为 API 审查过程通常会关注内部 API。我们可能会问一些问题,例如

  • "这是否会导致其他内部包出现问题?"
  • "我们是否应该考虑将其改为 @public API?"
  • "为什么我们要不断地向那个巨大的 "InternalUtilities" 类中添加更多内容?"

但是,如果审查某个 API 没有用处,可以将其标记为 @preapproved。这会阻止它在 API 文件中被发出,从而将其免于任何审查策略。

@preapproved 标记仅适用于标记为 @internal 的声明,并且仅适用于以下声明类型

  • 枚举
  • 接口
  • 命名空间

用法示例

/**
* Identifiers for various log messages.
*
* @privateRemarks
* These tokens are generated by the tooling system, so there is no reason
* to review them.
*
* @internal @preapproved
*/
export enum _LoggingIds {
...
}

另请参见