diff --git a/@types/index.d.ts b/@types/index.d.ts
index 8866aae..d0341a3 100644
--- a/@types/index.d.ts
+++ b/@types/index.d.ts
@@ -1,4 +1,5 @@
///
+///
/**
* indicates if SharedWorker is supported, in the global scope
*/
diff --git a/docs/assets/main.js b/docs/assets/main.js
index 99f331b..b13205a 100644
--- a/docs/assets/main.js
+++ b/docs/assets/main.js
@@ -1,5 +1,5 @@
-(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&(r||i!=="default")&&J(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t},Ae=(t,e)=>De(Me(J(t!=null?Ce(Re(t)):{},"default",!e&&t&&t.__esModule?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ce,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index.
-`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof ce=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var fe=Ae(de());function pe(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ue(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=fe.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${ve(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function me(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))} `),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",ye="mousemove",_="mouseup",G={x:0,y:0},xe=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",ye="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var oe=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},ae=class extends oe{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends oe{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new ae("inherited",!0),this.optionExternals=new ae("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function be(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),we(t.value)})}function we(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}pe();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&be(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})();
+(()=>{var Ce=Object.create;var ue=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!_e.call(t,i)&&i!==r&&ue(t,i,{get:()=>e[i],enumerable:!(n=Pe(e,i))||n.enumerable});return t};var Fe=(t,e,r)=>(r=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ue(r,"default",{value:t,enumerable:!0}):r,t));var pe=Me((de,fe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index.
+`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?h+=2:a==u&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),p=s.str.charAt(1),v;p in s.node.edges?v=s.node.edges[p]:(v=new t.TokenSet,s.node.edges[p]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof de=="object"?fe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ce=[];function N(t,e){ce.push({selector:e,constructor:t})}var Y=class{constructor(){this.createComponents(document.body)}createComponents(e){ce.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var k=class{constructor(e){this.el=e.el}};var J=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ie=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let r=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(r)}onScroll(){this.scrollTop=window.scrollY||0;let r=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(r),this.hideShowToolbar()}hideShowToolbar(){var n;let r=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,r!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(n=this.secondaryNav)==null||n.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},Q=ie;Q.instance=new ie;var X=class extends k{constructor(r){super(r);this.anchors=[];this.index=-1;Q.instance.addEventListener("resize",()=>this.onResize()),Q.instance.addEventListener("scroll",n=>this.onScroll(n)),this.createAnchors()}createAnchors(){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substr(0,r.indexOf("#"))),this.el.querySelectorAll("a").forEach(n=>{let i=n.href;if(i.indexOf("#")==-1||i.substr(0,r.length)!=r)return;let s=i.substr(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=n.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let r;for(let i=0,s=this.anchors.length;ii.position-s.position);let n=new CustomEvent("scroll",{detail:{scrollTop:Q.instance.scrollTop}});this.onScroll(n)}onScroll(r){let n=r.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>n;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var he=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var ge=Fe(pe());function ye(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ae(t,n,r,s)}function Ae(t,e,r,n){r.addEventListener("input",he(()=>{He(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?ze(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function Ve(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ge.Index.load(window.searchData.index))}function He(t,e,r,n){if(Ve(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0,a=Math.min(10,s.length);o${ve(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes;let p=document.createElement("a");p.href=n.base+u.url,p.classList.add("tsd-kind-icon"),p.innerHTML=l,h.append(p),e.appendChild(h)}}function me(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function ze(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(se(t.substring(s,o)),`${se(t.substring(o,o+n.length))} `),s=o+n.length,o=r.indexOf(n,s);return i.push(se(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function se(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var oe=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},Z=class extends k{constructor(r){super(r);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(n=>{n.addEventListener("touchstart",i=>this.onClick(i)),n.addEventListener("click",i=>this.onClick(i))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(r){if(r<0&&(r=0),r>this.groups.length-1&&(r=this.groups.length-1),this.index==r)return;let n=this.groups[r];if(this.index>-1){let i=this.groups[this.index];i.removeClass("current").addClass("fade-out"),n.addClass("current"),n.addClass("fade-in"),Q.instance.triggerResize(),setTimeout(()=>{i.removeClass("fade-out"),n.removeClass("fade-in")},300)}else n.addClass("current"),Q.instance.triggerResize();this.index=r}createGroups(){let r=this.el.children;if(r.length<2)return;this.container=this.el.nextElementSibling;let n=this.container.children;this.groups=[];for(let i=0;i{n.signature===r.currentTarget&&this.setIndex(i)})}};var C="mousedown",Le="mousemove",_="mouseup",K={x:0,y:0},xe=!1,ae=!1,je=!1,A=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(je=!0,C="touchstart",Le="touchmove",_="touchend");document.addEventListener(C,t=>{ae=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;K.y=e.pageY||0,K.x=e.pageX||0});document.addEventListener(Le,t=>{if(!!ae&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=K.x-(e.pageX||0),n=K.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ae=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var ee=class extends k{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(C,n=>this.onDocumentPointerDown(n)),document.addEventListener(_,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){A||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!A&&this.active&&r.target.closest(".col-menu")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substr(0,i.indexOf("#"))),n.href.substr(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},re=class extends te{initialize(){let r=document.querySelector("#tsd-filter-"+this.key);!r||(this.checkbox=r,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(r,n){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(r){return r=="true"}toLocalStorage(r){return r?"true":"false"}},le=class extends te{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let r=document.querySelector("#tsd-filter-"+this.key);if(!r)return;this.select=r;let n=()=>{this.select.classList.add("active")},i=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,n),this.select.addEventListener("mouseover",n),this.select.addEventListener("mouseleave",i),this.select.querySelectorAll("li").forEach(s=>{s.addEventListener(_,o=>{r.classList.remove("active"),this.setValue(o.target.dataset.value||"")})}),document.addEventListener(C,s=>{this.select.contains(s.target)||this.select.classList.remove("active")})}handleValueChange(r,n){this.select.querySelectorAll("li.selected").forEach(o=>{o.classList.remove("selected")});let i=this.select.querySelector('li[data-value="'+n+'"]'),s=this.select.querySelector(".tsd-select-label");i&&s&&(i.classList.add("selected"),s.textContent=i.textContent),document.documentElement.classList.remove("toggle-"+r),document.documentElement.classList.add("toggle-"+n)}fromLocalStorage(r){return r}toLocalStorage(r){return r}},j=class extends k{constructor(r){super(r);this.optionVisibility=new le("visibility","private"),this.optionInherited=new re("inherited",!0),this.optionExternals=new re("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function we(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,be(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),be(t.value)})}function be(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}ye();N(X,".menu-highlight");N(Z,".tsd-signatures");N(ee,"a[data-toggle]");j.isSupported()?N(j,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&we(Te);var Be=new Y;Object.defineProperty(window,"app",{value:Be});})();
/*!
* lunr.Builder
* Copyright (C) 2020 Oliver Nightingale
diff --git a/docs/assets/style.css b/docs/assets/style.css
index a16ed02..6127b27 100644
--- a/docs/assets/style.css
+++ b/docs/assets/style.css
@@ -766,12 +766,13 @@ footer .tsd-legend {
.tsd-flag {
display: inline-block;
- padding: 1px 5px;
+ padding: 0.25em 0.4em;
border-radius: 4px;
color: var(--color-comment-tag-text);
background-color: var(--color-comment-tag);
text-indent: 0;
- font-size: 14px;
+ font-size: 75%;
+ line-height: 1;
font-weight: normal;
}
diff --git a/docs/classes/SharedWorkerPolyfill.html b/docs/classes/SharedWorkerPolyfill.html
index 48b2bb6..730b915 100644
--- a/docs/classes/SharedWorkerPolyfill.html
+++ b/docs/classes/SharedWorkerPolyfill.html
@@ -1,33 +1,33 @@
-SharedWorkerPolyfill | @okikio/sharedworker - v1.0.3 Class SharedWorkerPolyfill
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Class SharedWorkerPolyfill
A polyfill class for
-SharedWorker
, it accepts a URL/string as well as any other options the spec. allows forSharedWorker
. It supports all the same methods and properties as the original, except it adds compatibility methods and properties for older browsers that don't supportSharedWorker
, so, it can switch to normalWorkers
instead.Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
url: string | External.URL
Optional opts: WorkerOptions
Returns SharedWorkerPolyfill
Properties
ActualWorker
Hierarchy
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
url: string | URL
Optional opts: WorkerOptions
Returns SharedWorkerPolyfill
Properties
ActualWorker
The actual worker that is used, depending on browser support it can be either a
-SharedWorker
or a normalWorker
.Accessors
onerror
Accessors
onerror
Is an EventListener that is called whenever an ErrorEvent of type error event occurs.
-Returns (ev: External.ErrorEvent) => any
Parameters
ev: External.ErrorEvent
Returns any
Returns (this: AbstractWorker, ev: External.ErrorEvent) => any
Parameters
this: AbstractWorker
ev: External.ErrorEvent
Returns any
Is an EventListener that is called whenever an ErrorEvent of type error event occurs.
-Parameters
value: (ev: External.ErrorEvent) => any
Parameters
ev: External.ErrorEvent
Returns any
Returns void
onmessage
Parameters
value: (this: AbstractWorker, ev: External.ErrorEvent) => any
Parameters
this: AbstractWorker
ev: External.ErrorEvent
Returns any
Returns void
onmessage
An EventListener called when MessageEvent of type message is fired on the port—that is, when the port receives a message.
-Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
Returns ((this: External.MessagePort, ev: MessageEvent<any>) => any) | ((this: External.Worker, ev: MessageEvent<any>) => any)
An EventListener called when MessageEvent of type message is fired on the port—that is, when the port receives a message.
-Parameters
value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
Returns void
onmessageerror
Parameters
value: ((this: External.MessagePort, ev: MessageEvent<any>) => any) | ((this: External.Worker, ev: MessageEvent<any>) => any)
Returns void
onmessageerror
An EventListener called when a MessageEvent of type MessageError is fired—that is, when it receives a message that cannot be deserialized.
-Returns ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
Returns ((this: External.MessagePort, ev: MessageEvent<any>) => any) | ((this: External.Worker, ev: MessageEvent<any>) => any)
An EventListener called when a MessageEvent of type MessageError is fired—that is, when it receives a message that cannot be deserialized.
-Parameters
value: ((ev: MessageEvent<any>) => any) | ((ev: MessageEvent<any>) => any)
Returns void
port
Parameters
value: ((this: External.MessagePort, ev: MessageEvent<any>) => any) | ((this: External.Worker, ev: MessageEvent<any>) => any)
Returns void
port
Returns a MessagePort object used to communicate with and control the shared worker.
-Returns External.MessagePort
Methods
addEventListener
Returns External.MessagePort
Methods
addEventListener
Registers an event handler of a specific event type on the EventTarget
-Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (ev: WorkerEventMap[K]) => any
Parameters
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (ev: MessagePortEventMap[K]) => any
Parameters
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
close
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (this: External.Worker, ev: WorkerEventMap[K]) => any
Parameters
this: External.Worker
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (this: External.MessagePort, ev: MessagePortEventMap[K]) => any
Parameters
this: External.MessagePort
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
close
Disconnects the port, so it is no longer active.
-Returns void
dispatchEvent
Returns void
dispatchEvent
Dispatches an event to this EventTarget.
-Parameters
event: External.Event
Returns boolean
postMessage
Parameters
event: External.Event
Returns boolean
postMessage
Clones message and transmits it to worker's global environment. transfer can be passed as a list of objects that are to be transferred rather than cloned.
-Parameters
message: any
Optional transfer: Transferable[] | StructuredSerializeOptions
Returns void
removeEventListener
Parameters
message: any
Optional transfer: Transferable[] | StructuredSerializeOptions
Returns void
removeEventListener
Removes an event listener from the EventTarget.
-Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (ev: WorkerEventMap[K]) => any
Parameters
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (ev: MessagePortEventMap[K]) => any
Parameters
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
start
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (this: External.Worker, ev: WorkerEventMap[K]) => any
Parameters
this: External.Worker
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (this: External.MessagePort, ev: MessagePortEventMap[K]) => any
Parameters
this: External.MessagePort
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
start
Starts the sending of messages queued on the port (only needed when using EventTarget.addEventListener; it is implied when using MessagePort.onmessage.)
-Returns void
terminate
Returns void
terminate
Immediately terminates the worker. This does not let worker finish its operations; it is halted at once. ServiceWorker instances do not support this method.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3@okikio/sharedworker - v1.0.3
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3@okikio/sharedworker - v1.0.3
@okikio/sharedworker
diff --git a/docs/interfaces/External.AbstractWorker.html b/docs/interfaces/External.AbstractWorker.html index f567d86..7235b54 100644 --- a/docs/interfaces/External.AbstractWorker.html +++ b/docs/interfaces/External.AbstractWorker.html @@ -1 +1 @@ -- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AbstractWorker
Hierarchy
Implemented by
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
ev: External.ErrorEvent
Returns any
Methods
addEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (ev: AbstractWorkerEventMap[K]) => any
Parameters
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
removeEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (ev: AbstractWorkerEventMap[K]) => any
Parameters
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AbstractWorker
Hierarchy
Implemented by
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
this: AbstractWorker
ev: External.ErrorEvent
Returns any
Methods
addEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (this: AbstractWorker, ev: AbstractWorkerEventMap[K]) => any
Parameters
this: AbstractWorker
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
removeEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (this: AbstractWorker, ev: AbstractWorkerEventMap[K]) => any
Parameters
this: AbstractWorker
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AbstractWorkerEventMap
Hierarchy
Index
Properties
Properties
error
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AbstractWorkerEventMap
Hierarchy
Index
Properties
Properties
error
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AddEventListenerOptions
Hierarchy
Index
Properties
Properties
Optional capture
Optional once
Optional passive
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface AddEventListenerOptions
Hierarchy
Index
Properties
Properties
Optional capture
Optional once
Optional passive
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface ArrayBufferView
Hierarchy
Index
Properties
Properties
buffer
The ArrayBuffer instance referenced by the array.
-byteLength
The length in bytes of the array.
-byteOffset
The offset in bytes of the array.
-Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface ErrorEvent
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface ErrorEvent
Events providing information related to errors in scripts or in files.
-Hierarchy
Index
Properties
Methods
Properties
Readonly AT_TARGET
Readonly BUBBLING_PHASE
Readonly CAPTURING_PHASE
Readonly NONE
Readonly bubbles
Hierarchy
Index
Properties
Methods
Properties
Readonly AT_TARGET
Readonly BUBBLING_PHASE
Readonly CAPTURING_PHASE
Readonly NONE
Readonly bubbles
Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
-cancelBubble
Readonly cancelable
cancelBubble
Readonly cancelable
Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
-Readonly colno
Readonly composed
Readonly colno
Readonly composed
Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
-Readonly currentTarget
Readonly currentTarget
Returns the object whose event listener's callback is currently being invoked.
-Readonly defaultPrevented
Readonly defaultPrevented
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
-Readonly error
Readonly eventPhase
Readonly error
Readonly eventPhase
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
-Readonly filename
Readonly isTrusted
Readonly filename
Readonly isTrusted
Returns true if event was dispatched by the user agent, and false otherwise.
-Readonly lineno
Readonly message
returnValue
Readonly srcElement
Readonly target
Readonly lineno
Readonly message
returnValue
Readonly srcElement
Readonly target
Returns the object to which event is dispatched (its target).
-Readonly timeStamp
Readonly timeStamp
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
-Readonly type
Readonly type
Returns the type of event, e.g. "click", "hashchange", or "submit".
-Methods
composedPath
Methods
composedPath
Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
-Returns External.EventTarget[]
initEvent
Parameters
type: string
Optional bubbles: boolean
Optional cancelable: boolean
Returns void
preventDefault
Returns External.EventTarget[]
initEvent
Parameters
type: string
Optional bubbles: boolean
Optional cancelable: boolean
Returns void
preventDefault
If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.
-Returns void
stopImmediatePropagation
Returns void
stopImmediatePropagation
Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.
-Returns void
stopPropagation
Returns void
stopPropagation
When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface Event
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface Event
An event which takes place in the DOM.
-Hierarchy
Index
Properties
Methods
Properties
Readonly AT_TARGET
Readonly BUBBLING_PHASE
Readonly CAPTURING_PHASE
Readonly NONE
Readonly bubbles
Hierarchy
Index
Properties
Methods
Properties
Readonly AT_TARGET
Readonly BUBBLING_PHASE
Readonly CAPTURING_PHASE
Readonly NONE
Readonly bubbles
Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.
-cancelBubble
Readonly cancelable
cancelBubble
Readonly cancelable
Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.
-Readonly composed
Readonly composed
Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.
-Readonly currentTarget
Readonly currentTarget
Returns the object whose event listener's callback is currently being invoked.
-Readonly defaultPrevented
Readonly defaultPrevented
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.
-Readonly eventPhase
Readonly eventPhase
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.
-Readonly isTrusted
Readonly isTrusted
Returns true if event was dispatched by the user agent, and false otherwise.
-returnValue
Readonly srcElement
Readonly target
returnValue
Readonly srcElement
Readonly target
Returns the object to which event is dispatched (its target).
-Readonly timeStamp
Readonly timeStamp
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.
-Readonly type
Readonly type
Returns the type of event, e.g. "click", "hashchange", or "submit".
-Methods
composedPath
Methods
composedPath
Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.
-Returns External.EventTarget[]
initEvent
Parameters
type: string
Optional bubbles: boolean
Optional cancelable: boolean
Returns void
preventDefault
Returns External.EventTarget[]
initEvent
Parameters
type: string
Optional bubbles: boolean
Optional cancelable: boolean
Returns void
preventDefault
If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.
-Returns void
stopImmediatePropagation
Returns void
stopImmediatePropagation
Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.
-Returns void
stopPropagation
Returns void
stopPropagation
When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListener
Hierarchy
Callable
Parameters
evt: External.Event
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListener
Hierarchy
Callable
Parameters
evt: External.Event
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListenerObject
Hierarchy
Index
Methods
Methods
handleEvent
Parameters
object: External.Event
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListenerObject
Hierarchy
Index
Methods
Methods
handleEvent
Parameters
object: External.Event
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListenerOptions
Hierarchy
Index
Properties
Properties
Optional capture
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventListenerOptions
Hierarchy
Index
Properties
Properties
Optional capture
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventTarget
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface EventTarget
EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.
-Hierarchy
Index
Methods
Methods
addEventListener
Hierarchy
Index
Methods
Methods
addEventListener
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.
The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.
When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.
@@ -8,8 +8,8 @@When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.
If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.
The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.
-Parameters
type: string
callback: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Parameters
type: string
callback: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
removeEventListener
Parameters
event: External.Event
Returns boolean
removeEventListener
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
type: string
callback: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface ImageBitmap
Hierarchy
Index
Properties
Methods
Properties
Readonly height
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface ImageBitmap
Hierarchy
Index
Properties
Methods
Properties
Readonly height
Returns the intrinsic height of the image, in CSS pixels.
-Readonly width
Readonly width
Returns the intrinsic width of the image, in CSS pixels.
-Methods
close
Methods
close
Releases imageBitmap's underlying bitmap data.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MediaSource
This Media Source Extensions API interface represents a source of media data for an HTMLMediaElement object. A MediaSource object can be attached to a HTMLMediaElement to be played in the user agent.
-Hierarchy
Index
Properties
Methods
Properties
Readonly activeSourceBuffers
duration
onsourceclose
Type declaration
Parameters
ev: External.Event
Returns any
onsourceended
Type declaration
Parameters
ev: External.Event
Returns any
onsourceopen
Type declaration
Parameters
ev: External.Event
Returns any
Readonly readyState
Readonly sourceBuffers
Methods
addEventListener
Type parameters
K: keyof MediaSourceEventMap
Parameters
type: K
listener: (ev: MediaSourceEventMap[K]) => any
Parameters
ev: MediaSourceEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
addSourceBuffer
Parameters
type: string
Returns External.SourceBuffer
clearLiveSeekableRange
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
endOfStream
Parameters
Optional error: EndOfStreamError
Returns void
removeEventListener
Type parameters
K: keyof MediaSourceEventMap
Parameters
type: K
listener: (ev: MediaSourceEventMap[K]) => any
Parameters
ev: MediaSourceEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
removeSourceBuffer
Parameters
sourceBuffer: External.SourceBuffer
Returns void
setLiveSeekableRange
Parameters
start: number
end: number
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MediaSourceEventMap
Hierarchy
Index
Properties
Properties
sourceclose
sourceended
sourceopen
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MessagePort
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MessagePort
This Channel Messaging API interface represents one of the two ports of a MessageChannel, allowing messages to be sent from one port and listening out for them arriving at the other.
-Hierarchy
Index
Properties
Methods
Properties
onmessage
Type declaration
Parameters
ev: MessageEvent<any>
Returns any
onmessageerror
Type declaration
Parameters
ev: MessageEvent<any>
Returns any
Methods
addEventListener
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (ev: MessagePortEventMap[K]) => any
Parameters
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
close
Hierarchy
Index
Properties
Methods
Properties
onmessage
Type declaration
Parameters
this: External.MessagePort
ev: MessageEvent<any>
Returns any
onmessageerror
Type declaration
Parameters
this: External.MessagePort
ev: MessageEvent<any>
Returns any
Methods
addEventListener
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (this: External.MessagePort, ev: MessagePortEventMap[K]) => any
Parameters
this: External.MessagePort
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
close
Disconnects the port, so that it is no longer active.
-Returns void
dispatchEvent
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
postMessage
Parameters
event: External.Event
Returns boolean
postMessage
Posts a message through the channel. Objects listed in transfer are transferred, not just cloned, meaning that they are no longer usable on the sending side.
Throws a "DataCloneError" DOMException if transfer contains duplicate objects or port, or if message could not be cloned.
-Parameters
message: any
transfer: Transferable[]
Returns void
Parameters
message: any
Optional options: StructuredSerializeOptions
Returns void
removeEventListener
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (ev: MessagePortEventMap[K]) => any
Parameters
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
start
Parameters
message: any
transfer: Transferable[]
Returns void
Parameters
message: any
Optional options: StructuredSerializeOptions
Returns void
removeEventListener
Type parameters
K: keyof MessagePortEventMap
Parameters
type: K
listener: (this: External.MessagePort, ev: MessagePortEventMap[K]) => any
Parameters
this: External.MessagePort
ev: MessagePortEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
start
Begins dispatching messages received on the port.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MessagePortEventMap
Hierarchy
Index
Properties
Properties
message
messageerror
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface MessagePortEventMap
Hierarchy
Index
Properties
Properties
message
messageerror
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface SharedWorker
Hierarchy
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
ev: External.ErrorEvent
Returns any
Readonly port
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface SharedWorker
Hierarchy
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
this: AbstractWorker
ev: External.ErrorEvent
Returns any
Readonly port
Returns sharedWorker's MessagePort object which can be used to communicate with the global environment.
-Methods
addEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (ev: AbstractWorkerEventMap[K]) => any
Parameters
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Methods
addEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (this: External.SharedWorker, ev: AbstractWorkerEventMap[K]) => any
Parameters
this: External.SharedWorker
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
removeEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (ev: AbstractWorkerEventMap[K]) => any
Parameters
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
Parameters
event: External.Event
Returns boolean
removeEventListener
Type parameters
K: "error"
Parameters
type: K
listener: (this: External.SharedWorker, ev: AbstractWorkerEventMap[K]) => any
Parameters
this: External.SharedWorker
ev: AbstractWorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface SourceBuffer
A chunk of media to be passed into an HTMLMediaElement and played, via a MediaSource object. This can be made up of one or several media segments.
-Hierarchy
Index
Properties
Methods
Properties
appendWindowEnd
appendWindowStart
Readonly buffered
mode
onabort
Type declaration
Parameters
ev: External.Event
Returns any
onerror
Type declaration
Parameters
ev: External.Event
Returns any
onupdate
Type declaration
Parameters
ev: External.Event
Returns any
onupdateend
Type declaration
Parameters
ev: External.Event
Returns any
onupdatestart
Type declaration
Parameters
ev: External.Event
Returns any
timestampOffset
Readonly updating
Methods
abort
Returns void
addEventListener
Type parameters
K: keyof SourceBufferEventMap
Parameters
type: K
listener: (ev: SourceBufferEventMap[K]) => any
Parameters
ev: SourceBufferEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
appendBuffer
Parameters
data: BufferSource
Returns void
changeType
Parameters
type: string
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
remove
Parameters
start: number
end: number
Returns void
removeEventListener
Type parameters
K: keyof SourceBufferEventMap
Parameters
type: K
listener: (ev: SourceBufferEventMap[K]) => any
Parameters
ev: SourceBufferEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface SourceBufferEventMap
Hierarchy
Index
Properties
Properties
abort
error
update
updateend
updatestart
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface StructuredSerializeOptions
Hierarchy
Index
Properties
Properties
Optional transfer
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface StructuredSerializeOptions
Hierarchy
Index
Properties
Properties
Optional transfer
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface TimeRanges
Used to represent a set of time ranges, primarily for the purpose of tracking which portions of media have been buffered when loading it for use by the
-Hierarchy
Index
Properties
Methods
Properties
Readonly length
Returns the number of ranges in the object.
-Methods
end
Returns the time for the end of the range with the given index.
-Throws an "IndexSizeError" DOMException if the index is out of range.
-Parameters
index: number
Returns number
start
Returns the time for the start of the range with the given index.
-Throws an "IndexSizeError" DOMException if the index is out of range.
-Parameters
index: number
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface URL
The URLÂ interface represents an object providing static methods used for creating object URLs.
-Hierarchy
Index
Properties
Methods
Properties
hash
host
hostname
href
Readonly origin
password
pathname
port
protocol
search
Readonly searchParams
username
Methods
toJSON
Returns string
toString
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface Worker
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface Worker
This Web Workers API interface represents a background task that can be easily created and can send messages back to its creator. Creating a worker is as simple as calling the Worker() constructor and specifying a script to be run in the worker thread.
-Hierarchy
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
ev: External.ErrorEvent
Returns any
onmessage
Type declaration
Parameters
ev: MessageEvent<any>
Returns any
onmessageerror
Type declaration
Parameters
ev: MessageEvent<any>
Returns any
Methods
addEventListener
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (ev: WorkerEventMap[K]) => any
Parameters
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Hierarchy
Index
Properties
Methods
Properties
onerror
Type declaration
Parameters
this: AbstractWorker
ev: External.ErrorEvent
Returns any
onmessage
Type declaration
Parameters
this: External.Worker
ev: MessageEvent<any>
Returns any
onmessageerror
Type declaration
Parameters
this: External.Worker
ev: MessageEvent<any>
Returns any
Methods
addEventListener
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (this: External.Worker, ev: WorkerEventMap[K]) => any
Parameters
this: External.Worker
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | AddEventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | AddEventListenerOptions
Returns void
dispatchEvent
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
-Parameters
event: External.Event
Returns boolean
postMessage
Parameters
event: External.Event
Returns boolean
postMessage
Clones message and transmits it to worker's global environment. transfer can be passed as a list of objects that are to be transferred rather than cloned.
-Parameters
message: any
transfer: Transferable[]
Returns void
Parameters
message: any
Optional options: StructuredSerializeOptions
Returns void
removeEventListener
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (ev: WorkerEventMap[K]) => any
Parameters
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
terminate
Parameters
message: any
transfer: Transferable[]
Returns void
Parameters
message: any
Optional options: StructuredSerializeOptions
Returns void
removeEventListener
Type parameters
K: keyof WorkerEventMap
Parameters
type: K
listener: (this: External.Worker, ev: WorkerEventMap[K]) => any
Parameters
this: External.Worker
ev: WorkerEventMap[K]
Returns any
Optional options: boolean | EventListenerOptions
Returns void
Parameters
type: string
listener: EventListenerOrEventListenerObject
Optional options: boolean | EventListenerOptions
Returns void
terminate
Aborts worker's associated global environment.
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface WorkerEventMap
Hierarchy
Index
Properties
Properties
error
message
messageerror
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface WorkerEventMap
Hierarchy
Index
Properties
Properties
error
message
messageerror
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface WorkerOptions
Hierarchy
Index
Properties
Properties
Optional credentials
Optional name
Optional type
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Interface WorkerOptions
Hierarchy
Index
Properties
Properties
Optional credentials
Optional name
Optional type
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3@okikio/sharedworker - v1.0.3
Index
References
Namespaces
Classes
Variables
References
default
Renames and re-exports SharedWorkerPolyfillVariables
SharedWorkerSupported
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3@okikio/sharedworker - v1.0.3
Index
References
Namespaces
Classes
Variables
References
default
Renames and re-exports SharedWorkerPolyfillVariables
Const SharedWorkerSupported
indicates if SharedWorker is supported, in the global scope
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Namespace External
Index
Interfaces
Type aliases
Variables
Type aliases
AppendMode
ArrayBufferLike
BufferSource
EndOfStreamError
EventListenerOrEventListenerObject
ReadyState
RequestCredentials
Transferable
WorkerType
Variables
ErrorEvent
Type declaration
prototype: External.ErrorEvent
Event
Type declaration
Readonly AT_TARGET: number
Readonly BUBBLING_PHASE: number
Readonly CAPTURING_PHASE: number
Readonly NONE: number
prototype: External.Event
EventTarget
Type declaration
prototype: External.EventTarget
ImageBitmap
Type declaration
prototype: External.ImageBitmap
MediaSource
Type declaration
prototype: External.MediaSource
isTypeSupported:function
Parameters
type: string
Returns boolean
MessagePort
Type declaration
prototype: External.MessagePort
SharedWorker
Type declaration
prototype: External.SharedWorker
SourceBuffer
Type declaration
prototype: External.SourceBuffer
TimeRanges
Type declaration
prototype: External.TimeRanges
URL
Type declaration
prototype: External.URL
createObjectURL:function
Parameters
obj: Blob | External.MediaSource
Returns string
revokeObjectURL:function
Parameters
url: string
Returns void
Worker
Type declaration
prototype: External.Worker
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@okikio/sharedworker - v1.0.3Namespace External
Index
Interfaces
Type aliases
Variables
Type aliases
EventListenerOrEventListenerObject
RequestCredentials
Transferable
WorkerType
Variables
ErrorEvent
Type declaration
prototype: External.ErrorEvent
Event
Type declaration
Readonly AT_TARGET: number
Readonly BUBBLING_PHASE: number
Readonly CAPTURING_PHASE: number
Readonly NONE: number
prototype: External.Event
EventTarget
Type declaration
prototype: External.EventTarget
ImageBitmap
Type declaration
prototype: External.ImageBitmap
MessagePort
Type declaration
prototype: External.MessagePort
SharedWorker
Type declaration
prototype: External.SharedWorker
Worker
Type declaration
prototype: External.Worker
Generated using TypeDoc