@alpha
Tag type: modifier
TSDoc standardization: discretionary
The @alpha
modifier is one of the four release tags. It indicates that an API item is eventually intended
to be public, but currently is in an early stage of development. Third parties should not use "alpha" APIs.
Usage example:
/**
* This is some example documentation.
* @alpha
*/
export function doSomething(): void {}