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

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