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

import{_ as r,c as n,z as s,E as e,B as p,a,R as o,G as c,o as t}from"./chunks/framework.ade46834.js";const Fo=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":1686508837000}'),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=o("",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),P={style:{color:"#268BD2"}},E=s("data-lsp",{lsp:"any"},"orr",-1),I=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),V=o("",6),N=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),R=s("span",{style:{color:"#839496"}},".",-1),z=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),M=o("",5),X=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),O=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),F=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),L=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),H={class:"twoslash-annotation left",style:{top:"0rem"}},J={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"},K=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),Y={class:"tag-container"},$={class:"shiki solarized-light twoslash lsp",style:{"background-color":"#FDF6E3",color:"#657B83"},active:"true"},Q=s("div",{class:"language-id"},"ts",-1),Z={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),G={class:"line"},W=s("span",{style:{color:"#657B83"}},"    ",-1),ss=s("span",{style:{color:"#859900"}},"if",-1),as=s("span",{style:{color:"#657B83"}}," (",-1),os={style:{color:"#268BD2"}},ns=s("data-lsp",{lsp:"any"},"orr",-1),ts=s("span",{style:{color:"#657B83"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),ls=o("",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=o("",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=o("",1),bs=o("",4),fs={class:"vp-code-group vp-adaptive-theme"},Ds=o("",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),Ps={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),Is={class:"line"},Vs=s("span",{style:{color:"#839496"}},"    ",-1),Ns=s("span",{style:{color:"#859900"}},"if",-1),Rs=s("span",{style:{color:"#839496"}}," (",-1),zs={style:{color:"#268BD2"}},Ms=s("data-lsp",{lsp:"any"},"orr",-1),Xs=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Os=o("",6),Fs=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),Ls=s("span",{style:{color:"#839496"}},".",-1),Hs=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Js=o("",5),Ks=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),Ys=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),$s=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),Qs={class:"twoslash-annotation right",style:{top:"3rem"}},Zs={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),Gs=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(0deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Ws={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),oa={class:"code-container"},na=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=o("",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=o("",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=o("",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=o("",1),ka={class:"blocks"},Sa={class:"language-ts vp-adaptive-theme active line-numbers-mode"},Pa=s("button",{title:"Copy Code",class:"copy"},null,-1),Ea=s("span",{class:"lang"},"ts",-1),Ia={class:"language-ts"},Va={class:"tag-container"},Na={class:"shiki solarized-dark twoslash lsp",style:{"background-color":"#002B36",color:"#839496"},active:"true"},Ra=s("div",{class:"language-id"},"ts",-1),za={class:"code-container"},Ma=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"},Oa=s("span",{style:{color:"#839496"}},"    ",-1),Fa=s("span",{style:{color:"#859900"}},"if",-1),La=s("span",{style:{color:"#839496"}}," (",-1),Ha={style:{color:"#268BD2"}},Ja=s("data-lsp",{lsp:"any"},"orr",-1),Ka=s("span",{style:{color:"#839496"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Ua=o("",6),Ya=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),$a=s("span",{style:{color:"#839496"}},".",-1),Qa=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Za=o("",5),ja=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),Wa=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),so=s("div",{class:"line"},[s("span",{style:{color:"#839496"}},"}")],-1),ao={class:"twoslash-annotation right",style:{top:"-0.7rem"}},oo={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"},no=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),to=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),lo={class:"tag-container"},eo={class:"shiki solarized-light twoslash lsp",style:{"background-color":"#FDF6E3",color:"#657B83"},active:"true"},po=s("div",{class:"language-id"},"ts",-1),ro={class:"code-container"},co=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),io={class:"line"},_o=s("span",{style:{color:"#657B83"}},"    ",-1),yo=s("span",{style:{color:"#859900"}},"if",-1),ho=s("span",{style:{color:"#657B83"}}," (",-1),uo={style:{color:"#268BD2"}},mo=s("data-lsp",{lsp:"any"},"orr",-1),go=s("span",{style:{color:"#657B83"}},[a("."),s("data-lsp",{lsp:"any"},"length"),a()],-1),Bo=o("",6),vo=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"(parameter) arr: any"},"arr")],-1),bo=s("span",{style:{color:"#657B83"}},".",-1),fo=s("span",{style:{color:"#268BD2"}},[s("data-lsp",{lsp:"any"},"trim")],-1),Do=o("",5),To=s("span",{class:"error"},[s("span",null,"Cannot find name 'orr'."),s("span",{class:"code"},"2304")],-1),wo=s("span",{class:"error-behind"},"Cannot find name 'orr'.",-1),Ao=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),qo=s("div",{class:"line"},[s("span",{style:{color:"#657B83"}},"}")],-1),Co={class:"twoslash-annotation right",style:{top:"-0.7rem"}},xo={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"},ko=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),So=s("p",{class:"twoslash-annotation-text",style:{transform:"rotate(-3deg)"}},"Discovered a typo, the param is arr, not orr!",-1),Po=s("div",{class:"line-numbers-wrapper","aria-hidden":"true"},[s("span",{class:"line-number"},"1"),s("br")],-1),Eo=o("",1);function Io(Vo,No,Ro,zo,Mo,Xo){const l=c("data-err");return t(),n("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",P,[e(l,null,{default:p(()=>[E]),_:1})]),I,V,N,R,z,M]),X,O,F,L])])]),a(`
`),s("div",H,[a(`
  `),(t(),n("svg",J,[a(`
    `),K,a(`
`)])),a(`
  `),U,a(`
`)])]),a(`
`),s("div",Y,[s("pre",$,[Q,s("div",Z,[s("code",null,[j,s("div",G,[W,ss,as,s("span",os,[e(l,null,{default:p(()=>[ns]),_:1})]),ts,ls,es,ps,rs,cs]),is,ds,_s,ys])])]),a(`
`),s("div",hs,[a(`
  `),(t(),n("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",Ps,[s("code",null,[Es,s("div",Is,[Vs,Ns,Rs,s("span",zs,[e(l,null,{default:p(()=>[Ms]),_:1})]),Xs,Os,Fs,Ls,Hs,Js]),Ks,Us,Ys,$s])])]),a(`
`),s("div",Qs,[a(`
  `),(t(),n("svg",Zs,[a(`
    `),js,a(`
`)])),a(`
  `),Gs,a(`
`)])]),a(`
`),s("div",Ws,[s("pre",sa,[aa,s("div",oa,[s("code",null,[na,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(),n("svg",fa,[a(`
    `),Da,a(`
`)])),a(`
  `),Ta,a(`
`)])])])]),wa]),Aa])]),qa,s("div",Ca,[xa,s("div",ka,[s("div",Sa,[Pa,Ea,s("pre",null,[s("code",Ia,[s("div",Va,[s("pre",Na,[Ra,s("div",za,[s("code",null,[Ma,s("div",Xa,[Oa,Fa,La,s("span",Ha,[e(l,null,{default:p(()=>[Ja]),_:1})]),Ka,Ua,Ya,$a,Qa,Za]),ja,Ga,Wa,so])])]),a(`
`),s("div",ao,[a(`
  `),(t(),n("svg",oo,[a(`
    `),no,a(`
`)])),a(`
  `),to,a(`
`)])]),a(`
`),s("div",lo,[s("pre",eo,[po,s("div",ro,[s("code",null,[co,s("div",io,[_o,yo,ho,s("span",uo,[e(l,null,{default:p(()=>[mo]),_:1})]),go,Bo,vo,bo,fo,Do]),To,wo,Ao,qo])])]),a(`
`),s("div",Co,[a(`
  `),(t(),n("svg",xo,[a(`
    `),ko,a(`
`)])),a(`
  `),So,a(`
`)])])])]),Po]),Eo])])])}const Lo=r(i,[["render",Io]]);export{Fo as __pageData,Lo as default};