toshiki-notebook/assets/application_vitepress-plugin-shiki-twoslash_api_annotations.md.2b140703.lean.js

import{_ as c}from"./chunks/PageInfo.vue_vue_type_script_setup_true_lang.250b3e56.js";import{_ as i,C as d,o,c as t,H as e,k as s,a,w as p,Q as n}from"./chunks/framework.b7580407.js";import"./chunks/commonjsHelpers.725317a4.js";const Vn=JSON.parse('{"title":"Meta Annotations","description":"Annotations provide a way to provide outside commentary on your code.","frontmatter":{"description":"Annotations provide a way to provide outside commentary on your code.","title":"Meta Annotations"},"headers":[],"relativePath":"application/vitepress-plugin-shiki-twoslash/api/annotations.md","filePath":"application/vitepress-plugin-shiki-twoslash/api/annotations.md","lastUpdated":1713421977000}'),_={name:"application/vitepress-plugin-shiki-twoslash/api/annotations.md"},y=s("h1",{id:"queries",tabindex:"-1"},[a("Queries "),s("a",{class:"header-anchor",href:"#queries","aria-label":'Permalink to "Queries"'},"​")],-1),h=s("p",null,"Sometimes the thing you want to say is about the code, annotations provide a way to provide outside commentary on your code.",-1),u=s("h2",{id:"annotate-left-right-overrides-text",tabindex:"-1"},[s("code",null,"@annotate: [left|right] [overrides] - [text]"),a(),s("a",{class:"header-anchor",href:"#annotate-left-right-overrides-text","aria-label":'Permalink to "`@annotate: [left|right] [overrides] - [text]`"'},"​")],-1),A=s("p",null,"Annotate has a lot more controls than most of the other Twoslash commands, because each use of it probably needs to feel a bit different. Here's an example based on the TypeScript home page, click it to get it running so we can talk about what it does:",-1),C={class:"vp-code-group vp-adaptive-theme"},m=n("",1),D={class:"blocks"},g={class:"language-ts vp-adaptive-theme active line-numbers-mode"},b=s("button",{title:"Copy Code",class:"copy"},null,-1),v=s("span",{class:"lang"},"ts",-1),B={class:"language-ts"},f={class:"tag-container"},E={class:"shiki github-dark-dimmed twoslash lsp",style:{"background-color":"#22272e",color:"#adbac7"}},T=s("div",{class:"language-id"},"ts",-1),F={class:"code-container"},w=s("div",{class:"line"},[s("span",{style:{color:"#F47067"}},"function"),s("span",{style:{color:"#ADBAC7"}}," "),s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#ADBAC7"}},"("),s("span",{style:{color:"#F69D50"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#ADBAC7"}},") {")],-1),q={class:"line"},x=s("span",{style:{color:"#ADBAC7"}},"    ",-1),S=s("span",{style:{color:"#F47067"}},"if",-1),k={style:{color:"#ADBAC7"}},V=s("data-lsp",{lsp:"any"},"orr",-1),P=s("span",{style:{color:"#6CB6FF"}},[s("data-lsp",{lsp:"any"},"length")],-1),I=n("",6),R=s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),N=s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"any"},"trim")],-1),M=n("",5),J=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),L=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),X=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"    "),s("span",{style:{color:"#F47067"}},"return"),s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),Y=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"}")],-1),H={class:"twoslash-annotation left",style:{top:"0rem"}},$={style:{transform:"translateX(8px) translateY(27px) rotate(90deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},G=s("path",{d:"M1 39C1.5 32.7511 6.1 17.5173 20.5 6.57333M11.5 4.04L27 0.999998C24.8333 4.88444 20.5 13.16 20.5 15.1867",stroke:"black"},null,-1),U=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),j={class:"tag-container"},z={class:"shiki github-light twoslash lsp",style:{"background-color":"#fff",color:"#24292e"}},O=s("div",{class:"language-id"},"ts",-1),Q={class:"code-container"},W=s("div",{class:"line"},[s("span",{style:{color:"#D73A49"}},"function"),s("span",{style:{color:"#24292E"}}," "),s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#24292E"}},"("),s("span",{style:{color:"#E36209"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#24292E"}},") {")],-1),K={class:"line"},Z=s("span",{style:{color:"#24292E"}},"    ",-1),ss=s("span",{style:{color:"#D73A49"}},"if",-1),as={style:{color:"#24292E"}},ns=s("data-lsp",{lsp:"any"},"orr",-1),os=s("span",{style:{color:"#005CC5"}},[s("data-lsp",{lsp:"any"},"length")],-1),ts=n("",6),es=s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),ls=s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"any"},"trim")],-1),ps=n("",5),rs=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),cs=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),is=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"    "),s("span",{style:{color:"#D73A49"}},"return"),s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),ds=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"}")],-1),_s={class:"twoslash-annotation left",style:{top:"0rem"}},ys={style:{transform:"translateX(8px) translateY(27px) rotate(90deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},hs=s("path",{d:"M1 39C1.5 32.7511 6.1 17.5173 20.5 6.57333M11.5 4.04L27 0.999998C24.8333 4.88444 20.5 13.16 20.5 15.1867",stroke:"black"},null,-1),us=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),As=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),Cs=n("",1),ms=n("",4),Ds={class:"vp-code-group vp-adaptive-theme"},gs=n("",1),bs={class:"blocks"},vs={class:"language-ts vp-adaptive-theme active line-numbers-mode"},Bs=s("button",{title:"Copy Code",class:"copy"},null,-1),fs=s("span",{class:"lang"},"ts",-1),Es={class:"language-ts"},Ts={class:"tag-container"},Fs={class:"shiki github-dark-dimmed twoslash lsp",style:{"background-color":"#22272e",color:"#adbac7"}},ws=s("div",{class:"language-id"},"ts",-1),qs={class:"code-container"},xs=s("div",{class:"line"},[s("span",{style:{color:"#F47067"}},"function"),s("span",{style:{color:"#ADBAC7"}}," "),s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#ADBAC7"}},"("),s("span",{style:{color:"#F69D50"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#ADBAC7"}},") {")],-1),Ss={class:"line"},ks=s("span",{style:{color:"#ADBAC7"}},"    ",-1),Vs=s("span",{style:{color:"#F47067"}},"if",-1),Ps={style:{color:"#ADBAC7"}},Is=s("data-lsp",{lsp:"any"},"orr",-1),Rs=s("span",{style:{color:"#6CB6FF"}},[s("data-lsp",{lsp:"any"},"length")],-1),Ns=n("",6),Ms=s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),Js=s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Ls=n("",5),Xs=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),Ys=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),Hs=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"    "),s("span",{style:{color:"#F47067"}},"return"),s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),$s=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"}")],-1),Gs={class:"twoslash-annotation right",style:{top:"3rem"}},Us={style:{transform:"translateX(-10px) translateY(-10px) rotate(-50deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},js=s("path",{d:"M27 39C26.5 32.7511 21.9 17.5173 7.5 6.57333M16.5 4.04L0.999999 0.999998C3.16667 4.88444 7.5 13.16 7.5 15.1867",stroke:"black"},null,-1),zs=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(0deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Os={class:"tag-container"},Qs={class:"shiki github-light twoslash lsp",style:{"background-color":"#fff",color:"#24292e"}},Ws=s("div",{class:"language-id"},"ts",-1),Ks={class:"code-container"},Zs=s("div",{class:"line"},[s("span",{style:{color:"#D73A49"}},"function"),s("span",{style:{color:"#24292E"}}," "),s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#24292E"}},"("),s("span",{style:{color:"#E36209"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#24292E"}},") {")],-1),sa={class:"line"},aa=s("span",{style:{color:"#24292E"}},"    ",-1),na=s("span",{style:{color:"#D73A49"}},"if",-1),oa={style:{color:"#24292E"}},ta=s("data-lsp",{lsp:"any"},"orr",-1),ea=s("span",{style:{color:"#005CC5"}},[s("data-lsp",{lsp:"any"},"length")],-1),la=n("",6),pa=s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),ra=s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"any"},"trim")],-1),ca=n("",5),ia=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),da=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),_a=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"    "),s("span",{style:{color:"#D73A49"}},"return"),s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),ya=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"}")],-1),ha={class:"twoslash-annotation right",style:{top:"3rem"}},ua={style:{transform:"translateX(-10px) translateY(-10px) rotate(-50deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},Aa=s("path",{d:"M27 39C26.5 32.7511 21.9 17.5173 7.5 6.57333M16.5 4.04L0.999999 0.999998C3.16667 4.88444 7.5 13.16 7.5 15.1867",stroke:"black"},null,-1),Ca=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(0deg)"}},"Discovered a typo, the param is arr, not orr!",-1),ma=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),Da=n("",1),ga=s("p",null,"Upside down arrow pointing at the error, using flipped to re-flip the arrow:",-1),ba={class:"vp-code-group vp-adaptive-theme"},va=n("",1),Ba={class:"blocks"},fa={class:"language-ts vp-adaptive-theme active line-numbers-mode"},Ea=s("button",{title:"Copy Code",class:"copy"},null,-1),Ta=s("span",{class:"lang"},"ts",-1),Fa={class:"language-ts"},wa={class:"tag-container"},qa={class:"shiki github-dark-dimmed twoslash lsp",style:{"background-color":"#22272e",color:"#adbac7"}},xa=s("div",{class:"language-id"},"ts",-1),Sa={class:"code-container"},ka=s("div",{class:"line"},[s("span",{style:{color:"#F47067"}},"function"),s("span",{style:{color:"#ADBAC7"}}," "),s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#ADBAC7"}},"("),s("span",{style:{color:"#F69D50"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#ADBAC7"}},") {")],-1),Va={class:"line"},Pa=s("span",{style:{color:"#ADBAC7"}},"    ",-1),Ia=s("span",{style:{color:"#F47067"}},"if",-1),Ra={style:{color:"#ADBAC7"}},Na=s("data-lsp",{lsp:"any"},"orr",-1),Ma=s("span",{style:{color:"#6CB6FF"}},[s("data-lsp",{lsp:"any"},"length")],-1),Ja=n("",6),La=s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),Xa=s("span",{style:{color:"#DCBDFB"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Ya=n("",5),Ha=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),$a=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),Ga=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"    "),s("span",{style:{color:"#F47067"}},"return"),s("span",{style:{color:"#ADBAC7"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),Ua=s("div",{class:"line"},[s("span",{style:{color:"#ADBAC7"}},"}")],-1),ja={class:"twoslash-annotation right",style:{top:"-0.7rem"}},za={style:{transform:"translateX(8px) translateY(46px) rotate(190deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},Oa=s("path",{d:"M1 39C1.5 32.7511 6.1 17.5173 20.5 6.57333M11.5 4.04L27 0.999998C24.8333 4.88444 20.5 13.16 20.5 15.1867",stroke:"black"},null,-1),Qa=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Wa={class:"tag-container"},Ka={class:"shiki github-light twoslash lsp",style:{"background-color":"#fff",color:"#24292e"}},Za=s("div",{class:"language-id"},"ts",-1),sn={class:"code-container"},an=s("div",{class:"line"},[s("span",{style:{color:"#D73A49"}},"function"),s("span",{style:{color:"#24292E"}}," "),s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#24292E"}},"("),s("span",{style:{color:"#E36209"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")]),s("span",{style:{color:"#24292E"}},") {")],-1),nn={class:"line"},on=s("span",{style:{color:"#24292E"}},"    ",-1),tn=s("span",{style:{color:"#D73A49"}},"if",-1),en={style:{color:"#24292E"}},ln=s("data-lsp",{lsp:"any"},"orr",-1),pn=s("span",{style:{color:"#005CC5"}},[s("data-lsp",{lsp:"any"},"length")],-1),rn=n("",6),cn=s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(".")],-1),dn=s("span",{style:{color:"#6F42C1"}},[s("data-lsp",{lsp:"any"},"trim")],-1),_n=n("",5),yn=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),hn=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),un=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"    "),s("span",{style:{color:"#D73A49"}},"return"),s("span",{style:{color:"#24292E"}},[a(),s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),An=s("div",{class:"line"},[s("span",{style:{color:"#24292E"}},"}")],-1),Cn={class:"twoslash-annotation right",style:{top:"-0.7rem"}},mn={style:{transform:"translateX(8px) translateY(46px) rotate(190deg)"},width:"40",height:"40",viewBox:"0 0 40 40",fill:"none",xmlns:"http://www.w3.org/2000/svg"},Dn=s("path",{d:"M1 39C1.5 32.7511 6.1 17.5173 20.5 6.57333M11.5 4.04L27 0.999998C24.8333 4.88444 20.5 13.16 20.5 15.1867",stroke:"black"},null,-1),gn=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),bn=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),vn=n("",1);function Bn(fn,En,Tn,Fn,wn,qn){const r=c,l=d("data-err");return o(),t("div",null,[y,e(r,{readTime:"3",words:"541"}),h,u,A,s("div",C,[m,s("div",D,[s("div",g,[b,v,s("pre",null,[s("code",B,[s("div",f,[s("pre",E,[T,s("div",F,[s("code",null,[w,s("div",q,[x,S,s("span",k,[a(" ("),e(l,null,{default:p(()=>[V]),_:1}),a(".")]),P,I,R,N,M]),J,L,X,Y])])]),a(`
`),s("div",H,[a(`
  `),(o(),t("svg",$,[a(`
    `),G,a(`
`)])),a(`
  `),U,a(`
`)])]),a(`
`),s("div",j,[s("pre",z,[O,s("div",Q,[s("code",null,[W,s("div",K,[Z,ss,s("span",as,[a(" ("),e(l,null,{default:p(()=>[ns]),_:1}),a(".")]),os,ts,es,ls,ps]),rs,cs,is,ds])])]),a(`
`),s("div",_s,[a(`
  `),(o(),t("svg",ys,[a(`
    `),hs,a(`
`)])),a(`
  `),us,a(`
`)])])])]),As]),Cs])]),ms,s("div",Ds,[gs,s("div",bs,[s("div",vs,[Bs,fs,s("pre",null,[s("code",Es,[s("div",Ts,[s("pre",Fs,[ws,s("div",qs,[s("code",null,[xs,s("div",Ss,[ks,Vs,s("span",Ps,[a(" ("),e(l,null,{default:p(()=>[Is]),_:1}),a(".")]),Rs,Ns,Ms,Js,Ls]),Xs,Ys,Hs,$s])])]),a(`
`),s("div",Gs,[a(`
  `),(o(),t("svg",Us,[a(`
    `),js,a(`
`)])),a(`
  `),zs,a(`
`)])]),a(`
`),s("div",Os,[s("pre",Qs,[Ws,s("div",Ks,[s("code",null,[Zs,s("div",sa,[aa,na,s("span",oa,[a(" ("),e(l,null,{default:p(()=>[ta]),_:1}),a(".")]),ea,la,pa,ra,ca]),ia,da,_a,ya])])]),a(`
`),s("div",ha,[a(`
  `),(o(),t("svg",ua,[a(`
    `),Aa,a(`
`)])),a(`
  `),Ca,a(`
`)])])])]),ma]),Da])]),ga,s("div",ba,[va,s("div",Ba,[s("div",fa,[Ea,Ta,s("pre",null,[s("code",Fa,[s("div",wa,[s("pre",qa,[xa,s("div",Sa,[s("code",null,[ka,s("div",Va,[Pa,Ia,s("span",Ra,[a(" ("),e(l,null,{default:p(()=>[Na]),_:1}),a(".")]),Ma,Ja,La,Xa,Ya]),Ha,$a,Ga,Ua])])]),a(`
`),s("div",ja,[a(`
  `),(o(),t("svg",za,[a(`
    `),Oa,a(`
`)])),a(`
  `),Qa,a(`
`)])]),a(`
`),s("div",Wa,[s("pre",Ka,[Za,s("div",sn,[s("code",null,[an,s("div",nn,[on,tn,s("span",en,[a(" ("),e(l,null,{default:p(()=>[ln]),_:1}),a(".")]),pn,rn,cn,dn,_n]),yn,hn,un,An])])]),a(`
`),s("div",Cn,[a(`
  `),(o(),t("svg",mn,[a(`
    `),Dn,a(`
`)])),a(`
  `),gn,a(`
`)])])])]),bn]),vn])])])}const Pn=i(_,[["render",Bn]]);export{Vn as __pageData,Pn as default};