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

import{_ as r,c as o,z as s,E as e,B as p,a,R as n,G as c,o as t}from"./chunks/framework.ade46834.js";const Zn=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":1694660529000}'),i={name:"application/vitepress-plugin-shiki-twoslash/api/annotations.md"},d=s("h1",{id:"queries",tabindex:"-1"},[a("Queries "),s("a",{class:"header-anchor",href:"#queries","aria-label":'Permalink to "Queries"'},"​")],-1),_=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),y=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),h=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),u={class:"vp-code-group vp-adaptive-theme"},m=n("",1),g={class:"blocks"},B={class:"language-ts vp-adaptive-theme active line-numbers-mode"},v=s("button",{title:"Copy Code",class:"copy"},null,-1),b=s("span",{class:"lang"},"ts",-1),f={class:"language-ts"},D={class:"tag-container"},T={class:"shiki solarized-dark twoslash lsp",style:{"background-color":"#002B36",color:"#839496"},active:"true"},w=s("div",{class:"language-id"},"ts",-1),A={class:"code-container"},q=s("div",{class:"line"},[s("span",{style:{color:"#93A1A1"}},"function"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#839496"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),C={class:"line"},x=s("span",{style:{color:"#839496"}},"    ",-1),k=s("span",{style:{color:"#859900"}},"if",-1),S=s("span",{style:{color:"#839496"}}," (",-1),I={style:{color:"#268BD2"}},V=s("data-lsp",{lsp:"any"},"orr",-1),P=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),E=n("",6),R=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),N=s("span",{style:{color:"#839496"}},".",-1),M=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),z=n("",5),X=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),Z=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),F=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),Y={class:"twoslash-annotation left",style:{top:"0rem"}},H={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"},Q=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),$={class:"tag-container"},j={class:"shiki solarized-light twoslash lsp",style:{"background-color":"#FDF6E3",color:"#657B83"},active:"true"},G=s("div",{class:"language-id"},"ts",-1),O={class:"code-container"},J=s("div",{class:"line"},[s("span",{style:{color:"#586E75"}},"function"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#657B83"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),W={class:"line"},K=s("span",{style:{color:"#657B83"}},"    ",-1),ss=s("span",{style:{color:"#859900"}},"if",-1),as=s("span",{style:{color:"#657B83"}}," (",-1),ns={style:{color:"#268BD2"}},os=s("data-lsp",{lsp:"any"},"orr",-1),ts=s("span",{style:{color:"#657B83"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),ls=n("",6),es=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),ps=s("span",{style:{color:"#657B83"}},".",-1),rs=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),cs=n("",5),is=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),ds=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),_s=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),ys=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"}")],-1),hs={class:"twoslash-annotation left",style:{top:"0rem"}},us={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"},ms=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),gs=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Bs=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),vs=n("",1),bs=n("",4),fs={class:"vp-code-group vp-adaptive-theme"},Ds=n("",1),Ts={class:"blocks"},ws={class:"language-ts vp-adaptive-theme active line-numbers-mode"},As=s("button",{title:"Copy Code",class:"copy"},null,-1),qs=s("span",{class:"lang"},"ts",-1),Cs={class:"language-ts"},xs={class:"tag-container"},ks={class:"shiki solarized-dark twoslash lsp",style:{"background-color":"#002B36",color:"#839496"},active:"true"},Ss=s("div",{class:"language-id"},"ts",-1),Is={class:"code-container"},Vs=s("div",{class:"line"},[s("span",{style:{color:"#93A1A1"}},"function"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#839496"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),Ps={class:"line"},Es=s("span",{style:{color:"#839496"}},"    ",-1),Rs=s("span",{style:{color:"#859900"}},"if",-1),Ns=s("span",{style:{color:"#839496"}}," (",-1),Ms={style:{color:"#268BD2"}},zs=s("data-lsp",{lsp:"any"},"orr",-1),Xs=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Ls=n("",6),Zs=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),Fs=s("span",{style:{color:"#839496"}},".",-1),Ys=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Hs=n("",5),Qs=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),Us=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),$s=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),js=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),Gs={class:"twoslash-annotation right",style:{top:"3rem"}},Os={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),Ws=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(0deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Ks={class:"tag-container"},sa={class:"shiki solarized-light twoslash lsp",style:{"background-color":"#FDF6E3",color:"#657B83"},active:"true"},aa=s("div",{class:"language-id"},"ts",-1),na={class:"code-container"},oa=s("div",{class:"line"},[s("span",{style:{color:"#586E75"}},"function"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#657B83"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),ta={class:"line"},la=s("span",{style:{color:"#657B83"}},"    ",-1),ea=s("span",{style:{color:"#859900"}},"if",-1),pa=s("span",{style:{color:"#657B83"}}," (",-1),ra={style:{color:"#268BD2"}},ca=s("data-lsp",{lsp:"any"},"orr",-1),ia=s("span",{style:{color:"#657B83"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),da=n("",6),_a=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),ya=s("span",{style:{color:"#657B83"}},".",-1),ha=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),ua=n("",5),ma=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),ga=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),Ba=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),va=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"}")],-1),ba={class:"twoslash-annotation right",style:{top:"3rem"}},fa={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"},Da=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),Ta=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(0deg)"}},"Discovered a typo, the param is arr, not orr!",-1),wa=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),Aa=n("",1),qa=s("p",null,"Upside down arrow pointing at the error, using flipped to re-flip the arrow:",-1),Ca={class:"vp-code-group vp-adaptive-theme"},xa=n("",1),ka={class:"blocks"},Sa={class:"language-ts vp-adaptive-theme active line-numbers-mode"},Ia=s("button",{title:"Copy Code",class:"copy"},null,-1),Va=s("span",{class:"lang"},"ts",-1),Pa={class:"language-ts"},Ea={class:"tag-container"},Ra={class:"shiki solarized-dark twoslash lsp",style:{"background-color":"#002B36",color:"#839496"},active:"true"},Na=s("div",{class:"language-id"},"ts",-1),Ma={class:"code-container"},za=s("div",{class:"line"},[s("span",{style:{color:"#93A1A1"}},"function"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#839496"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),Xa={class:"line"},La=s("span",{style:{color:"#839496"}},"    ",-1),Za=s("span",{style:{color:"#859900"}},"if",-1),Fa=s("span",{style:{color:"#839496"}}," (",-1),Ya={style:{color:"#268BD2"}},Ha=s("data-lsp",{lsp:"any"},"orr",-1),Qa=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Ua=n("",6),$a=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),ja=s("span",{style:{color:"#839496"}},".",-1),Ga=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Oa=n("",5),Ja=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),Wa=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),Ka=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#839496"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),sn=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),an={class:"twoslash-annotation right",style:{top:"-0.7rem"}},nn={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"},on=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),tn=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),ln={class:"tag-container"},en={class:"shiki solarized-light twoslash lsp",style:{"background-color":"#FDF6E3",color:"#657B83"},active:"true"},pn=s("div",{class:"language-id"},"ts",-1),rn={class:"code-container"},cn=s("div",{class:"line"},[s("span",{style:{color:"#586E75"}},"function"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"function compact(arr: any): any"},"compact")]),s("span",{style:{color:"#657B83"}},[a("("),s("data-lsp",{lsp:"(parameter) arr: any"},"arr"),a(") {")])],-1),dn={class:"line"},_n=s("span",{style:{color:"#657B83"}},"    ",-1),yn=s("span",{style:{color:"#859900"}},"if",-1),hn=s("span",{style:{color:"#657B83"}}," (",-1),un={style:{color:"#268BD2"}},mn=s("data-lsp",{lsp:"any"},"orr",-1),gn=s("span",{style:{color:"#657B83"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Bn=n("",6),vn=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),bn=s("span",{style:{color:"#657B83"}},".",-1),fn=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Dn=n("",5),Tn=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),wn=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),An=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"    "),s("span",{style:{color:"#859900"}},"return"),s("span",{style:{color:"#657B83"}}," "),s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")])],-1),qn=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"}")],-1),Cn={class:"twoslash-annotation right",style:{top:"-0.7rem"}},xn={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"},kn=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),Sn=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),In=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),Vn=n("",1);function Pn(En,Rn,Nn,Mn,zn,Xn){const l=c("data-err");return t(),o("div",null,[d,_,y,h,s("div",u,[m,s("div",g,[s("div",B,[v,b,s("pre",null,[s("code",f,[s("div",D,[s("pre",T,[w,s("div",A,[s("code",null,[q,s("div",C,[x,k,S,s("span",I,[e(l,null,{default:p(()=>[V]),_:1})]),P,E,R,N,M,z]),X,L,Z,F])])]),a(`
`),s("div",Y,[a(`
  `),(t(),o("svg",H,[a(`
    `),Q,a(`
`)])),a(`
  `),U,a(`
`)])]),a(`
`),s("div",$,[s("pre",j,[G,s("div",O,[s("code",null,[J,s("div",W,[K,ss,as,s("span",ns,[e(l,null,{default:p(()=>[os]),_:1})]),ts,ls,es,ps,rs,cs]),is,ds,_s,ys])])]),a(`
`),s("div",hs,[a(`
  `),(t(),o("svg",us,[a(`
    `),ms,a(`
`)])),a(`
  `),gs,a(`
`)])])])]),Bs]),vs])]),bs,s("div",fs,[Ds,s("div",Ts,[s("div",ws,[As,qs,s("pre",null,[s("code",Cs,[s("div",xs,[s("pre",ks,[Ss,s("div",Is,[s("code",null,[Vs,s("div",Ps,[Es,Rs,Ns,s("span",Ms,[e(l,null,{default:p(()=>[zs]),_:1})]),Xs,Ls,Zs,Fs,Ys,Hs]),Qs,Us,$s,js])])]),a(`
`),s("div",Gs,[a(`
  `),(t(),o("svg",Os,[a(`
    `),Js,a(`
`)])),a(`
  `),Ws,a(`
`)])]),a(`
`),s("div",Ks,[s("pre",sa,[aa,s("div",na,[s("code",null,[oa,s("div",ta,[la,ea,pa,s("span",ra,[e(l,null,{default:p(()=>[ca]),_:1})]),ia,da,_a,ya,ha,ua]),ma,ga,Ba,va])])]),a(`
`),s("div",ba,[a(`
  `),(t(),o("svg",fa,[a(`
    `),Da,a(`
`)])),a(`
  `),Ta,a(`
`)])])])]),wa]),Aa])]),qa,s("div",Ca,[xa,s("div",ka,[s("div",Sa,[Ia,Va,s("pre",null,[s("code",Pa,[s("div",Ea,[s("pre",Ra,[Na,s("div",Ma,[s("code",null,[za,s("div",Xa,[La,Za,Fa,s("span",Ya,[e(l,null,{default:p(()=>[Ha]),_:1})]),Qa,Ua,$a,ja,Ga,Oa]),Ja,Wa,Ka,sn])])]),a(`
`),s("div",an,[a(`
  `),(t(),o("svg",nn,[a(`
    `),on,a(`
`)])),a(`
  `),tn,a(`
`)])]),a(`
`),s("div",ln,[s("pre",en,[pn,s("div",rn,[s("code",null,[cn,s("div",dn,[_n,yn,hn,s("span",un,[e(l,null,{default:p(()=>[mn]),_:1})]),gn,Bn,vn,bn,fn,Dn]),Tn,wn,An,qn])])]),a(`
`),s("div",Cn,[a(`
  `),(t(),o("svg",xn,[a(`
    `),kn,a(`
`)])),a(`
  `),Sn,a(`
`)])])])]),In]),Vn])])])}const Fn=r(i,[["render",Pn]]);export{Zn as __pageData,Fn as default};