Rush StackShopBlogEvents
Skip to main content

@beta

Standardization:Discretionary
Syntax kind:Modifier
Synonyms:@experimental

Suggested meaning​

Designates that an API item's release stage is "beta". It has been released to third-party developers experimentally for the purpose of collecting feedback. The API should not be used in production, because its contract may change without notice. The tooling may trim the declaration from a public release, but may include it in a developer preview release.

Example​

/**
 * Represents a book in the catalog.
 * @public
 */
export class Book {
  /**
   * The title of the book.
   * @beta
   */
  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 "beta".

See also​