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

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