@internal

标准化	可自由决定
语法种类	修饰符

建议含义

表示 API 项不计划供第三方开发者使用。该工具可能会从公开发行版中删除此声明。在某些实现中，某些指定的包可能被允许使用内部 API 项，例如，因为这些包是同一产品的组件。

示例

/**
 * Represents a book in the catalog.
 * @public
 */
export class Book {
  /**
   * The title of the book.
   * @internal
   */
  public get _title(): string;

  /**
   * The author of the book.
   */
  public get author(): string;
}

在此示例中，Book.author 从包含类继承其 @public 指定，而 Book._title 被标记为“internal”。

另请参阅

• @alpha 标签
• @beta 标签
• @experimental 标签
• @public 标签
• 基于发布标签的裁剪：此功能的参考实现