Rush StackShopBlogEvents
Skip to main content

@internal

Standardization:Discretionary
Syntax kind:Modifier

Suggested meaning​

Designates that an API item is not planned to be used by third-party developers. The tooling may trim the declaration from a public release. In some implementations, certain designated packages may be allowed to consume internal API items, e.g. because the packages are components of the same product.

Example​

/**
 * 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;
}

In this example, Book.author inherits its @public designation from the containing class, whereas Book._title is marked as "internal".

See also​