1"use strict";(self.webpackChunktsdoc_org=self.webpackChunktsdoc_org||[]).push([[4174],{5552(e,t,r){r.d(t,{xA:()=>c,yg:()=>u});var n=r(829);function a(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 n=Object.getOwnPropertySymbols(e);t&&(n=n.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,n)}return r}function i(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){a(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 s(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),p=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},g=n.forwardRef(function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),g=p(r),u=a,y=g["".concat(l,".").concat(u)]||g[u]||d[u]||o;return r?n.createElement(y,i(i({ref:t},c),{},{components:r})):n.createElement(y,i({ref:t},c))});function u(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=g;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var p=2;p<o;p++)i[p]=r[p];return n.createElement.apply(null,i)}return n.createElement.apply(null,r)}g.displayName="MDXCreateElement"},6437(e,t,r){r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>u,frontMatter:()=>s,metadata:()=>p,toc:()=>d});var n=r(6443),a=r(8338),o=(r(829),r(5552)),i=["components"],s={title:"@readonly"},l=void 0,p={unversionedId:"pages/tags/readonly",id:"pages/tags/readonly",title:"@readonly",description:"| | |",source:"@site/docs/pages/tags/readonly.md",sourceDirName:"pages/tags",slug:"/pages/tags/readonly",permalink:"/pages/tags/readonly",draft:!1,editUrl:"https://github.com/microsoft/rushstack-websites/tree/main/websites/tsdoc.org/docs/pages/tags/readonly.md",tags:[],version:"current",frontMatter:{title:"@readonly"},sidebar:"docsSidebar",previous:{title:"@public",permalink:"/pages/tags/public"},next:{title:"@remarks",permalink:"/pages/tags/remarks"}},c={},d=[{value:"Usage",id:"usage",level:2},{value:"Example",id:"example",level:2}],g={toc:d};function u(e){var t=e.components,r=(0,a.A)(e,i);return(0,o.yg)("wrapper",(0,n.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/readonly/"})),(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"},"Extended"))),(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"},"Modifier"))))),(0,o.yg)("h2",{id:"usage"},"Usage"),(0,o.yg)("p",null,"This modifier tag indicates that an API item should be documented as being read-only, even if the TypeScript\ntype system may indicate otherwise. For example, suppose a class property has a setter function that always\nthrows an exception explaining that the property cannot be assigned; in this situation, the ",(0,o.yg)("inlineCode",{parentName:"p"},"@readonly")," modifier\ncan be added so that the property is shown as read-only in the documentation."),(0,o.yg)("h2",{id:"example"},"Example"),(0,o.yg)("pre",null,(0,o.yg)("code",{parentName:"pre",className:"language-ts"},"export class Book {\n /**\n * Technically property has a setter, but for documentation purposes it should\n * be presented as readonly.\n * @readonly\n */\n public get title(): string {\n return this._title;\n }\n\n public set title(value: string) {\n throw new Error('This property is read-only!');\n }\n}\n")))}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.