1"use strict";(self.webpackChunktsdoc_org=self.webpackChunktsdoc_org||[]).push([[5432],{5552(e,t,a){a.d(t,{xA:()=>g,yg:()=>m});var n=a(829);function r(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function i(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),a.push.apply(a,n)}return a}function l(e){for(var t=1;t<arguments.length;t++){var a=null!=arguments[t]?arguments[t]:{};t%2?i(Object(a),!0).forEach(function(t){r(e,t,a[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(a)):i(Object(a)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(a,t))})}return e}function o(e,t){if(null==e)return{};var a,n,r=function(e,t){if(null==e)return{};var a,n,r={},i=Object.keys(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n<i.length;n++)a=i[n],t.indexOf(a)>=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var s=n.createContext({}),p=function(e){var t=n.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):l(l({},t),e)),a},g=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},u=n.forwardRef(function(e,t){var a=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,g=o(e,["components","mdxType","originalType","parentName"]),u=p(a),m=r,d=u["".concat(s,".").concat(m)]||u[m]||c[m]||i;return a?n.createElement(d,l(l({ref:t},g),{},{components:a})):n.createElement(d,l({ref:t},g))});function m(e,t){var a=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=a.length,l=new Array(i);l[0]=u;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:r,l[1]=o;for(var p=2;p<i;p++)l[p]=a[p];return n.createElement.apply(null,l)}return n.createElement.apply(null,a)}u.displayName="MDXCreateElement"},5674(e,t,a){a.r(t),a.d(t,{assets:()=>g,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var n=a(6443),r=a(8338),i=(a(829),a(5552)),l=["components"],o={title:"@public"},s=void 0,p={unversionedId:"pages/tags/public",id:"pages/tags/public",title:"@public",description:"| | |",source:"@site/docs/pages/tags/public.md",sourceDirName:"pages/tags",slug:"/pages/tags/public",permalink:"/pages/tags/public",draft:!1,editUrl:"https://github.com/microsoft/rushstack-websites/tree/main/websites/tsdoc.org/docs/pages/tags/public.md",tags:[],version:"current",frontMatter:{title:"@public"},sidebar:"docsSidebar",previous:{title:"@privateRemarks",permalink:"/pages/tags/privateremarks"},next:{title:"@readonly",permalink:"/pages/tags/readonly"}},g={},c=[{value:"Suggested meaning",id:"suggested-meaning",level:2},{value:"Example",id:"example",level:2},{value:"See also",id:"see-also",level:2}],u={toc:c};function m(e){var t=e.components,a=(0,r.A)(e,l);return(0,i.yg)("wrapper",(0,n.A)({},u,a,{components:t,mdxType:"MDXLayout"}),(0,i.yg)("head",null,(0,i.yg)("link",{rel:"canonical",href:"https://tsdoc.org/pages/pages/tags/public/"})),(0,i.yg)("table",null,(0,i.yg)("tbody",{parentName:"table"},(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"Standardization:"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("a",{parentName:"td",href:"/pages/spec/standardization_groups"},"Discretionary"))),(0,i.yg)("tr",{parentName:"tbody"},(0,i.yg)("td",{parentName:"tr",align:null},"Syntax kind:"),(0,i.yg)("td",{parentName:"tr",align:null},(0,i.yg)("a",{parentName:"td",href:"/pages/spec/tag_kinds"},"Modifier"))))),(0,i.yg)("h2",{id:"suggested-meaning"},"Suggested meaning"),(0,i.yg)("p",null,'Designates that an API item\'s release stage is "public". It has been officially released to third-party developers,\nand its signature is guaranteed to be stable (e.g. following Semantic Versioning rules).'),(0,i.yg)("h2",{id:"example"},"Example"),(0,i.yg)("pre",null,(0,i.yg)("code",{parentName:"pre",className:"language-ts"},"/**\n * Represents a book in the catalog.\n * @public\n */\nexport class Book {\n /**\n * The title of the book.\n * @internal\n */\n public get _title(): string;\n\n /**\n * The author of the book.\n */\n public get author(): string;\n}\n")),(0,i.yg)("p",null,"In this example, ",(0,i.yg)("inlineCode",{parentName:"p"},"Book.author")," inherits its ",(0,i.yg)("inlineCode",{parentName:"p"},"@public")," designation from the containing class,\nwhereas ",(0,i.yg)("inlineCode",{parentName:"p"},"Book._title"),' is marked as "internal".'),(0,i.yg)("h2",{id:"see-also"},"See also"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"/pages/tags/alpha"},"@alpha")," tag"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"/pages/tags/beta"},"@beta")," tag"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"/pages/tags/experimental"},"@experimental")," tag"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"/pages/tags/internal"},"@internal")," tag"),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://api-extractor.com/pages/setup/configure_rollup/#trimming-based-on-release-tags"},"Trimming based on release tags"),":\na reference implementation of this feature")))}m.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.