1"use strict";(self.webpackChunktsdoc_org=self.webpackChunktsdoc_org||[]).push([[6585],{5552(e,t,n){n.d(t,{xA:()=>g,yg:()=>m});var a=n(829);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?i(Object(n),!0).forEach(function(t){r(e,t,n[t])}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):i(Object(n)).forEach(function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))})}return e}function o(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},i=Object.keys(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)n=i[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},g=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},u=a.forwardRef(function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,s=e.parentName,g=o(e,["components","mdxType","originalType","parentName"]),u=p(n),m=r,d=u["".concat(s,".").concat(m)]||u[m]||c[m]||i;return n?a.createElement(d,l(l({ref:t},g),{},{components:n})):a.createElement(d,l({ref:t},g))});function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.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]=n[p];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}u.displayName="MDXCreateElement"},9862(e,t,n){n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>p,toc:()=>c});var a=n(6443),r=n(8338),i=(n(829),n(5552)),l=["components"],o={title:"@internal"},s=void 0,p={unversionedId:"pages/tags/internal",id:"pages/tags/internal",title:"@internal",description:"| | |",source:"@site/docs/pages/tags/internal.md",sourceDirName:"pages/tags",slug:"/pages/tags/internal",permalink:"/pages/tags/internal",draft:!1,editUrl:"https://github.com/microsoft/rushstack-websites/tree/main/websites/tsdoc.org/docs/pages/tags/internal.md",tags:[],version:"current",frontMatter:{title:"@internal"},sidebar:"docsSidebar",previous:{title:"@inheritDoc",permalink:"/pages/tags/inheritdoc"},next:{title:"@label",permalink:"/pages/tags/label"}},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,n=(0,r.A)(e,l);return(0,i.yg)("wrapper",(0,a.A)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,i.yg)("head",null,(0,i.yg)("link",{rel:"canonical",href:"https://tsdoc.org/pages/pages/tags/internal/"})),(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 is not planned to be used by third-party developers. The tooling may trim the\ndeclaration from a public release. In some implementations, certain designated packages may be allowed to\nconsume internal API items, e.g. be
1cause the packages are components of the same product."),(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/public"},"@public")," 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.