Improve this page

@public

Tag type: modifier

TSDoc standardization: discretionary

The @public modifier is one of the four release tags. It indicates that an API item has been officially released, and is now part of the supported contract for a package. If the SemVer versioning scheme is used, then the API signature cannot be changed without a MAJOR version increment.

Usage example:

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

See also