@internal

Tag Kind

Modifier

TSDoc Reference

@internal

The @internal tag indicates that a reflection is not intended to be used by API consumers. API items annotated with @internal may be removed from the generated documentation by specifying the --excludeInternal option.

Example

export class Visibility {
    /** @internal */
    member = 123;
}

See Also

• The @alpha tag
• The @beta tag
• The @experimental tag
• The --excludeInternal option
• The --stripInternal TypeScript compiler option