@internal
Tag type: modifier
TSDoc standardization: discretionary
The @internal
modifier is one of the four release tags. It indicates that an API item is meant only for usage
by other NPM packages from the same maintainer. Third parties should never use "internal" APIs. To emphasize this,
an underscore prefix should be used in the name of a declaration with an (explicit) @internal
tag. API Extractor
validates this naming convention and will report
ae-internal-missing-underscore if the underscore
is missing.
Usage example:
/**
* This is some example documentation.
* @internal
*/
export function _doSomething(): void {}