https://tsdoc.org/assets/js/1be78505.a30727a0.js

1"use strict";(self.webpackChunktsdoc_org=self.webpackChunktsdoc_org||[]).push([[1417,8714],{5015(e,t,n){n.r(t),n.d(t,{default:()=>Te});var a=n(829),r=n(2663),l=n(6552),o=n(5038),i=n(2866),c=n(3271),d=n(2547),s=n(8155),m=n(4305),u=n(3310),b=n(5485),p=n(3563);const v="backToTopButton_FpDC",h="backToTopButtonShow_VfA9";function f(){var e=function(e){var t=e.threshold,n=(0,a.useState)(!1),r=n[0],l=n[1],o=(0,a.useRef)(!1),i=(0,b.gk)(),c=i.startScroll,d=i.cancelScroll;return(0,b.Mq)(function(e,n){var a=e.scrollY,r=null==n?void 0:n.scrollY;r&&(o.current?o.current=!1:a>=r?(d(),l(!1)):a<t?l(!1):a+window.innerHeight<document.documentElement.scrollHeight&&l(!0))}),(0,p.$)(function(e){e.location.hash&&(o.current=!0,l(!1))}),{shown:r,scrollToTop:function(){return c(0)}}}({threshold:300}),t=e.shown,n=e.scrollToTop;return a.createElement("button",{"aria-label":(0,u.T)({id:"theme.BackToTopButton.buttonAriaLabel",message:"Scroll back to top",description:"The ARIA label for the back to top button"}),className:(0,r.A)("clean-btn",o.G.common.backToTopButton,v,t&&h),type:"button",onClick:n})}var E=n(2762),g=n(4656),A=n(3189),_=n(8078),C=n(6443);function k(e){return a.createElement("svg",(0,C.A)({width:"20",height:"20","aria-hidden":"true"},e),a.createElement("g",{fill:"#7a7a7a"},a.createElement("path",{d:"M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0"}),a.createElement("path",{d:"M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0"})))}const S="collapseSidebarButton_vZ4v",N="collapseSidebarButtonIcon_LMc8";function I(e){var t=e.onClick;return a.createElement("button",{type:"button",title:(0,u.T)({id:"theme.docs.sidebar.collapseButtonTitle",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),"aria-label":(0,u.T)({id:"theme.docs.sidebar.collapseButtonAriaLabel",message:"Collapse sidebar",description:"The title attribute for collapse button of doc sidebar"}),className:(0,r.A)("button button--secondary button--outline",S),onClick:t},a.createElement(k,{className:N}))}var T=n(1450),x=n(8338),y=n(834),w=Symbol("EmptyContext"),L=a.createContext(w);function M(e){var t=e.children,n=(0,a.useState)(null),r=n[0],l=n[1],o=(0,a.useMemo)(function(){return{expandedItem:r,setExpandedItem:l}},[r]);return a.createElement(L.Provider,{value:o},t)}var B=n(573),H=n(7196),P=n(6227),G=n(4564),D=["item","onItemClick","activePath","level","index"];function F(e){var t=e.categoryLabel,n=e.onClick;return a.createElement("button",{"aria-label":(0,u.T)({id:"theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel",message:"Toggle the collapsible sidebar category '{label}'",description:"The ARIA label to toggle the collapsible sidebar category"},{label:t}),type:"button",className:"clean-btn menu__caret",onClick:n})}function V(e){var t=e.item,n=e.onItemClick,l=e.activePath,i=e.level,d=e.index,s=(0,x.A)(e,D),m=t.items,u=t.label,b=t.collapsible,p=t.className,v=t.href,h=(0,A.p)().docs.sidebar.autoCollapseCategories,f=function(e){var t=(0,G.A)();return(0,a.useMemo)(function(){return e.href?e.href:!t&&e.collapsible?(0,c._o)(e):void 0},[e,t])}(t),E=(0,c.w8)(t,l),g=(0,H.ys)(v,l),_=(0,B.u)({initialState:function(){return!!b&&(!E&&t.collapsed)}}),k=_.collapsed,S=_.setCollapsed,N=function(){var e=(0,a.useContext)(L);if(e===w)throw new y.dV("DocSidebarItemsExpandedStateProvider");return e}(),I=N.expandedItem,T=N.setExpandedItem,M=function(e){void 0===e&&(e=!k),T(e?null:d),S(e)};return function(e){var t=e.isActive,n=e.collapsed,r=e.updateCollapsed,l=(0,y.ZC)(t);(0,a.useEffect)(function(){t&&!l&&n&&r(!1)},[t,l,n,r])}({isActive:E,collapsed:k,updateCollapsed:M}),(0,a.useEffect)(function(){b&&null!=I&&I!==d&&h&&S(!0)},[b,I,d,S,h]),a.createElement("li",{className:(0,r.A)(o.G.docs.docSidebarItemCategory,o.G.docs.docSidebarItemCategoryLevel(i),"menu__list-item",{"menu__list-item--collapsed":k},p)},a.createElement("div",{className:(0,r.A)("menu__list-item-collapsible",{"menu__list-item-collapsible--active":g})},a.createElement(P.A,(0,C.A)({className:(0,r.A)("menu__link",{"menu__link--sublist":b,"menu__link--sublist-caret":!v&&b,"menu__link--active":E}),onClick:b?function(e){null==n||n(t),v?M(!1):(e.preventDefault(),M())}:function(){null==n||n(t)},"aria-current":g?"page":void 0,"aria-expanded":b?!k:void 0,href:b?null!=f?f:"#":f},s),u),v&&b&&a.createElement(F,{categoryLabel:u,onClick:function(e){e.preventDefault(),M()}})),a.createElement(B.N,{lazy:!0,as:"ul",className:"menu__list",collapsed:k},a.createElement(O,{items:m,tabIndex:k?-1:0,onItemClick:n,activePath:l,level:i+1})))}var W=n(6275),R=n(9910);const z="menuExternalLink_hvDX";var U=["item","onItemClick","activePath","level","index"];function Y(e){var t=e.item,n=e.onItemClick,l=e.activePath,i=e.level,d=(e.index,(0,x.A)(e,U)),s=t.href,m=t.label,u=t.className,b=t.autoAddBaseUrl,p=(0,c.w8)(t,l),v=(0,W.A)(s);return a.createElement("li",{className:(0,r.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(i),"menu__list-item",u),key:m},a.createElement(P.A,(0,C.A)({className:(0,r.A)("menu__link",!v&&z,{"menu__link--active":p}),autoAddBaseUrl:b,"aria-current":p?"page":void 0,to:s},v&&{onClick:n?function(){return n(t)}:void 0},d),m,!v&&a.createElement(R.A,null)))}const q="menuHtmlItem_Sz6G";function J(e){var t=e.item,n=e.level,l=e.index,i=t.value,c=t.defaultStyle,d=t.className;return a.createElement("li",{className:(0,r.A)(o.G.docs.docSidebarItemLink,o.G.docs.docSidebarItemLinkLevel(n),c&&[q,"menu__list-item"],d),key:l,dangerouslySetInnerHTML:{__html:i}})}var K=["item"];function X(e){var t=e.item,n=(0,x.A)(e,K);switch(t.type){case"category":return a.createElement(V,(0,C.A)({item:t},n));case"html":return a.createElement(J,(0,C.A)({item:t},n));default:return a.createElement(Y,(0,C.A)({item:t},n))}}var Z=["items"];function j(e){var t=e.items,n=(0,x.A)(e,Z);return a.createElement(M,null,t.map(function(e,t){return a.createElement(X,(0,C.A)({key:t,item:e,index:t},n))}))}const O=(0,a.memo)(j),Q="menu_WIc_",$="menuWithAnnouncementBar_DLH3";function ee(e){var t=e.path,n=e.sidebar,l=e.className,i=function(){var e=(0,T.Mj)().isActive,t=(0,a.useState)(e),n=t[0],r=t[1];return(0,b.Mq)(function(t){var n=t.scrollY;e&&r(0===n)},[e]),e&&n}();return a.createElement("nav",{"aria-label":(0,u.T)({id:"theme.docs.sidebar.navAriaLabel",message:"Docs sidebar",description:"The ARIA label for the sidebar navigation"}),className:(0,r.A)("menu thin-scrollbar",Q,i&&$,l)},a.createElement("ul",{className:(0,r.A)(o.G.docs.docSidebarMenu,"menu__list")},a.createElement(O,{items:n,activePath:t,level:1})))}const te="sidebar_tn35",ne="sidebarWithHideableNavbar_b2Iq",ae="sidebarHidden_baiu",re="sidebarLogo_kv8B";function le(e){var t=e.path,n=e.sidebar,l=e.onCollapse,o=e.isHidden,i=(0,A.p)(),c=i.navbar.hideOnScroll,d=i.docs.sidebar.hideable;return a.createElement("div",{className:(0,r.A)(te,c&&ne,o&&ae)}

1,c&&a.createElement(_.A,{tabIndex:-1,className:re}),a.createElement(ee,{path:t,sidebar:n}),d&&a.createElement(I,{onClick:l}))}const oe=a.memo(le);var ie=n(803),ce=n(1972),de=function(e){var t=e.sidebar,n=e.path,l=(0,ce.M)();return a.createElement("ul",{className:(0,r.A)(o.G.docs.docSidebarMenu,"menu__list")},a.createElement(O,{items:t,activePath:n,onItemClick:function(e){"category"===e.type&&e.href&&l.toggle(),"link"===e.type&&l.toggle()},level:1}))};function se(e){return a.createElement(ie.GX,{component:de,props:e})}const me=a.memo(se);function ue(e){var t=(0,g.l)(),n="desktop"===t||"ssr"===t,r="mobile"===t;return a.createElement(a.Fragment,null,n&&a.createElement(oe,e),r&&a.createElement(me,e))}const be="expandButton_xdmQ",pe="expandButtonIcon_yt6W";function ve(e){var t=e.toggleSidebar;return a.createElement("div",{className:be,title:(0,u.T)({id:"theme.docs.sidebar.expandButtonTitle",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),"aria-label":(0,u.T)({id:"theme.docs.sidebar.expandButtonAriaLabel",message:"Expand sidebar",description:"The ARIA label and title attribute for expand button of doc sidebar"}),tabIndex:0,role:"button",onKeyDown:t,onClick:t},a.createElement(k,{className:pe}))}const he={docSidebarContainer:"docSidebarContainer_becJ",docSidebarContainerHidden:"docSidebarContainerHidden_hJmA",sidebarViewport:"sidebarViewport_IVxr"};function fe(e){var t,n=e.children,r=(0,s.t)();return a.createElement(a.Fragment,{key:null!=(t=null==r?void 0:r.name)?t:"noSidebar"},n)}function Ee(e){var t=e.sidebar,n=e.hiddenSidebarContainer,l=e.setHiddenSidebarContainer,i=(0,E.zy)().pathname,c=(0,a.useState)(!1),d=c[0],s=c[1],m=(0,a.useCallback)(function(){d&&s(!1),l(function(e){return!e})},[l,d]);return a.createElement("aside",{className:(0,r.A)(o.G.docs.docSidebarContainer,he.docSidebarContainer,n&&he.docSidebarContainerHidden),onTransitionEnd:function(e){e.currentTarget.classList.contains(he.docSidebarContainer)&&n&&s(!0)}},a.createElement(fe,null,a.createElement("div",{className:(0,r.A)(he.sidebarViewport,d&&he.sidebarViewportHidden)},a.createElement(ue,{sidebar:t,path:i,onCollapse:m,isHidden:d}),d&&a.createElement(ve,{toggleSidebar:m}))))}const ge={docMainContainer:"docMainContainer_tHwK",docMainContainerEnhanced:"docMainContainerEnhanced_GvSV",docItemWrapperEnhanced:"docItemWrapperEnhanced_Dolt"};function Ae(e){var t=e.hiddenSidebarContainer,n=e.children,l=(0,s.t)();return a.createElement("main",{className:(0,r.A)(ge.docMainContainer,(t||!l)&&ge.docMainContainerEnhanced)},a.createElement("div",{className:(0,r.A)("container padding-top--md padding-bottom--lg",ge.docItemWrapper,t&&ge.docItemWrapperEnhanced)},n))}const _e="docPage_Radx",Ce="docsWrapper_zCrY";function ke(e){var t=e.children,n=(0,s.t)(),r=(0,a.useState)(!1),l=r[0],o=r[1];return a.createElement(m.A,{wrapperClassName:Ce},a.createElement(f,null),a.createElement("div",{className:_e},n&&a.createElement(Ee,{sidebar:n.items,hiddenSidebarContainer:l,setHiddenSidebarContainer:o}),a.createElement(Ae,{hiddenSidebarContainer:l},t)))}var Se=n(1417),Ne=n(436);function Ie(e){var t=e.versionMetadata;return a.createElement(a.Fragment,null,a.createElement(Ne.A,{version:t.version,tag:(0,i.tU)(t.pluginId,t.version)}),a.createElement(l.be,null,t.noIndex&&a.createElement("meta",{name:"robots",content:"noindex, nofollow"})))}function Te(e){var t=e.versionMetadata,n=(0,c.mz)(e);if(!n)return a.createElement(Se.default,null);var i=n.docElement,m=n.sidebarName,u=n.sidebarItems;return a.createElement(a.Fragment,null,a.createElement(Ie,e),a.createElement(l.e3,{className:(0,r.A)(o.G.wrapper.docsPages,o.G.page.docsDocPage,e.versionMetadata.className)},a.createElement(d.n,{version:t},a.createElement(s.V,{name:m,items:u},a.createElement(ke,null,i)))))}},1417(e,t,n){n.r(t),n.d(t,{default:()=>i});var a=n(829),r=n(3310),l=n(6552),o=n(4305);function i(){return a.createElement(a.Fragment,null,a.createElement(l.be,{title:(0,r.T)({id:"theme.NotFound.title",message:"Page Not Found"})}),a.createElement(o.A,null,a.createElement("main",{className:"container margin-vert--xl"},a.createElement("div",{className:"row"},a.createElement("div",{className:"col col--6 col--offset-3"},a.createElement("h1",{className:"hero__title"},a.createElement(r.A,{id:"theme.NotFound.title",description:"The title of the 404 page"},"Page Not Found")),a.createElement("p",null,a.createElement(r.A,{id:"theme.NotFound.p1",description:"The first paragraph of the 404 page"},"We could not find what you were looking for.")),a.createElement("p",null,a.createElement(r.A,{id:"theme.NotFound.p2",description:"The 2nd paragraph of the 404 page"},"Please contact the owner of the site that linked you to the original URL and let them know their link is broken.")))))))}},2547(e,t,n){n.d(t,{n:()=>o,r:()=>i});var a=n(829),r=n(834),l=a.createContext(null);function o(e){var t=e.children,n=e.version;return a.createElement(l.Provider,{value:n},t)}function i(){var e=(0,a.useContext)(l);if(null===e)throw new r.dV("DocsVersionProvider");return e}}}]);