1"use strict";(self.webpackChunktsdoc_org=self.webpackChunktsdoc_org||[]).push([[4105],{5552(e,t,r){r.d(t,{xA:()=>i,yg:()=>u});var a=r(829);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function s(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?o(Object(r),!0).forEach(function(t){n(e,t,r[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):o(Object(r)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))})}return e}function l(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},o=Object.keys(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)r=o[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var p=a.createContext({}),c=function(e){var t=a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):s(s({},t),e)),r},i=function(e){var t=c(e.components);return a.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},g=a.forwardRef(function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),g=c(r),u=n,m=g["".concat(p,".").concat(u)]||g[u]||d[u]||o;return r?a.createElement(m,s(s({ref:t},i),{},{components:r})):a.createElement(m,s({ref:t},i))});function u(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,s=new Array(o);s[0]=g;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:n,s[1]=l;for(var c=2;c<o;c++)s[c]=r[c];return a.createElement.apply(null,s)}return a.createElement.apply(null,r)}g.displayName="MDXCreateElement"},1978(e,t,r){r.r(t),r.d(t,{assets:()=>i,contentTitle:()=>p,default:()=>u,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var a=r(6443),n=r(8338),o=(r(829),r(5552)),s=["components"],l={title:"@deprecated"},p=void 0,c={unversionedId:"pages/tags/deprecated",id:"pages/tags/deprecated",title:"@deprecated",description:"| | |",source:"@site/docs/pages/tags/deprecated.md",sourceDirName:"pages/tags",slug:"/pages/tags/deprecated",permalink:"/pages/tags/deprecated",draft:!1,editUrl:"https://github.com/microsoft/rushstack-websites/tree/main/websites/tsdoc.org/docs/pages/tags/deprecated.md",tags:[],version:"current",frontMatter:{title:"@deprecated"},sidebar:"docsSidebar",previous:{title:"@decorator",permalink:"/pages/tags/decorator"},next:{title:"@defaultValue",permalink:"/pages/tags/defaultvalue"}},i={},d=[{value:"Usage",id:"usage",level:2},{value:"Example",id:"example",level:2},{value:"See also",id:"see-also",level:2}],g={toc:d};function u(e){var t=e.components,r=(0,n.A)(e,s);return(0,o.yg)("wrapper",(0,a.A)({},g,r,{components:t,mdxType:"MDXLayout"}),(0,o.yg)("head",null,(0,o.yg)("link",{rel:"canonical",href:"https://tsdoc.org/pages/pages/tags/deprecated/"})),(0,o.yg)("table",null,(0,o.yg)("tbody",{parentName:"table"},(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:null},"Standardization:"),(0,o.yg)("td",{parentName:"tr",align:null},(0,o.yg)("a",{parentName:"td",href:"/pages/spec/standardization_groups"},"Core"))),(0,o.yg)("tr",{parentName:"tbody"},(0,o.yg)("td",{parentName:"tr",align:null},"Syntax kind:"),(0,o.yg)("td",{parentName:"tr",align:null},(0,o.yg)("a",{parentName:"td",href:"/pages/spec/tag_kinds"},"Block tag"))))),(0,o.yg)("h2",{id:"usage"},"Usage"),(0,o.yg)("p",null,"This block tag communicates that an API item is no longer supported and may be removed in a future release.\nThe ",(0,o.yg)("inlineCode",{parentName:"p"},"@deprecated")," tag is followed by a sentence describing the recommended alternative. It recursively applies\nto members of the container. For example, if a class is deprecated, then so are all of its members."),(0,o.yg)("h2",{id:"example"},"Example"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre",className:"language-ts"}
1,"/**\n * The base class for controls that can be rendered.\n *\n * @deprecated Use the new {@link Control} base class instead.\n */\nexport class VisualControl {\n . . .\n}\n")),(0,o.yg)("h2",{id:"see-also"},"See also"),(0,o.yg)("ul",null,(0,o.yg)("li",{parentName:"ul"},(0,o.yg)("a",{parentName:"li",href:"https://github.com/microsoft/tsdoc/issues/131"},"Issue #131"),": How to deprecate a single parameter")))}u.isMDXComponent=!0}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.