Rush StackShopBlogEvents
Skip to main content

@deprecated

Standardization:Core
Syntax kind:Block tag

Usage​

This block tag communicates that an API item is no longer supported and may be removed in a future release. The @deprecated tag is followed by a sentence describing the recommended alternative. It recursively applies to members of the container. For example, if a class is deprecated, then so are all of its members.

Example​

/**
 * The base class for controls that can be rendered.
 *
 * @deprecated Use the new {@link Control} base class instead.
 */
export class VisualControl {
  . . .
}

See also​