Rush StackShopBlogEvents
Skip to main content

@beta

Tag type: modifier

TSDoc standardization: discretionary

The @beta modifier is one of the four release tags. It indicates that an API item has been released as a preview or for experimental purposes. Third parties are encouraged to try it and provide feedback. However, a "beta" API should NOT be used in production, because it may be changed or removed in a future version.

Usage example:

/**
* This is some example documentation.
* @beta
*/
export function doSomething(): void {}

See also