@experimental

Tag Kind

Modifier

TSDoc Reference

@experimental

This tag can be used to indicate that the associated member is intended to eventually be used by third-party developers but is not yet stable enough to conform to semantic versioning requirements.

The TSDoc specification indicates that the @beta and @experimental tags should be treated as semantically equivalent. TypeDoc users should generally use one or the other, but not both.

Example

export class Visibility {
    /** @experimental */
    newBehavior(): void;
}

See Also

• The @alpha tag
• The @beta tag
• The @public tag
• The --visibilityFilters option