diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 00000000..8092823a --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,85 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #267F99; + --dark-hl-8: #4EC9B0; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 00000000..d0aa8d5f --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}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,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},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),n=1,r=0;n0){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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.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(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},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,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<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 n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,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 n=e.peekLexeme();if(n!=null)switch(n.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 r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.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 n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.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 '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;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 n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;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,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 00000000..768d8fc4 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4WSXU+DMBRA/0ufF+eIm7pXfVniskQTfTA+NLWwG+FC6G0Qjf/dMgaDUtrXeziHfr3/MpLfxLbsIUfigLJkC1ZwOpqRSLlSUi17dHWkLDX8C/CTbVfR3d+i9x+hlILysp76PfL5O1TEUcip3hGf/ayRIHPIZ+BzX/NUu9R27jPfuMpcB9bO/bsFOmgqNF1sQJJlzMVpyx0eR6L1xorscNSgujjrJ2DZ1/e3q3U0KOw5QizVJNDNQ769hdZ2rnzimpsxDyuGxNZ7ECq8FLyaaQxQsFKjmD3JEQyV2mt3L2jIQh0wP7z4sUZBkKNaNvOxu7mxtGa9c2rDAjrwFH7kU54kw2c9zgy/8eRKja6CGXukilNUmZNymR2b6B//8JYHL8UEAAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 00000000..cdbe9289 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA81dW4/jOo7+L+nXmjqRfO/Hnb3gYOcCzMHOAms0Anfiqg46iQtJqmt6Gv3f15ItmZRJWU4qOfNU3TFFUvxIiqJl+8fi2LydFh/LH4uv28Nm8VEui0wk8mFxqPb14uPi18P2/Ovh5fW8eFi8HnftL+fvL/XpF/v745fzftdeXO+q06luWS0WPx8MtzS2jLbtAMvj6fWwPm+bw+kX9XMoi+PrgeDQ/hrK4K06y7fqtCe4mEtzprOtdtt/1n9qnp/rIzM1SDKH9W/fD2uGpbrkZeVC+NfX8xi/7ke/SkkSpZbLaqUG8lw+WALA7GHxUh3rw3nQYmAvlnKY87rZTPN+7Kl8Ah57NRg5zddpKZrmChmn86bx2dvIsXTXyaqPxyBZHd08Wa4r/bk6bJ/qkzs58/O17oT4TDmU1YVX97eX6u3wx+bwtH12JIErs2Lpf9sUUR9JlvDStYYY8ZoyBtKL8ZWXptn91majQFmPgH5a6ISfVi/b/66/h0q21FfLPdbP29P5+P1/jrtQ4XjI1Roc6vNbc/z6X9W5fquCLTAadYkervP+7ZUOBvv7tW6LGU357KAO57DH5vlY7UOEPA60E8KmHPX4fAoS2BNeJ60+fAsS1tFdJ6tdAraHIGmG8jp5++b14C4UtDxDeZ28tg48b/dBLvk40M6XKXMrsqU5V9sDqP56dr/YKxOrSzwwezo2+5VJPhMMP7jE9DQG/QaZiZCg6jq041/X52ZqBh8wabg4Z4p1PT2zmsdlUsLeLVAYKYDuQknVuUVA/fs0JQtRXijtuT6vFJ8pWYDuQknfmt3rvg6bmUN7xdw6TiGzs5Th0mDI/vv2WCsnHkeYvTIvZP9NbaCJDIDZfcCktO6DbvPD1REXEq6UuOlwHc3LE66TElarFtI/qrH6hwlZI+oLpR7ratMSTYkbyC6U83bcnuv/3O4mJwYJr5hTiChAd6GkdcviXAfYDxKGy4LB+mvrxNVhPZ6UueAN1dDQQcyCIsfqNSdwsBhv3Ezxf6u24xUO8+9Jgvn7ugq0hImWQoAMUI6yIjyFaIAE2IdhRfiaMJQM4KB/c2pOI6P//V3cE/IK8k6j1BznREK8vjnBfSKjIzmB+XxC4qktCtiyGclzKC+W1m/OV8/Onp4VOh5wkeyX4/ZwXp3P31fNi+4H+yVT5KFyoZP/na7Nup/fxcUBqyAP7zWa4+BQhNe/R7yhKbp+y4h59/O7mAKwCjJFr9EcU0ARXlP4eZ9UC9XL3FBcwt3dzVP8p3bxYwlJCmqL7dm5M9KGS318qtb97a2AWyRovVmt3j4/r7b9irFCtudZf6CHccuRVTqwMTdPcN/u+INIA1R4pDT32kbt3yw5LgAm9STH3s1KY+nWVDLcVMQcZtmrCXJWRmV/mXNzizX2/tIfRHy5yRr+HiI9ABays5X2F7g3t1kr3tpsebnN1CwYm1kytKXwKOoOuINtkEhjjywPsQfW1t84XjGlq0czduQdrELLNuYpgtyF0d8bX2bMvOXNGXW3iIJyjW3kjFBCek/4z9v2/GWlbpquTvAuawCGo5F39B8s2/pPUHgx+k/YidywBWgatH27iY2gZGuhoBKJ1D3APtwWM1DZ0A3nzazlKGCNFrTy+2YyYTt+ixygePiG+SZ2G4m3VgsqMflZePP5+YtqCavgVXaujzMTOzf8bhmeVMCm+hnFOT0TxnYj4kP9FqIzM+4O1qIkD8VlkJ1I5UMN9KU6bHaXaWqH/h5m6oQPlgoqHrgpcKcfq0Nz2K6r3ar6vG3XiWq3a9Yh2nID72AoUrQxUxy0ONLa+7PVsXqZm6HAkPtlJSPUZqIZe95BYy64FEFH+6Z7XHpIkHtzI+8RWqTsIbKCLMRMwOs0a3MmYKbnjMbdzX2wZGOiGU05R3X21LWhCly+3AH3yDNQpLFEErQ9wdpO2oA+gBWkWthxrBvZBQm3Fgpap7gZTNpqdM4qSNPJU1c3spCRa40TtjyN9Z60C3EqLEjDgDNiN7LNINku3jODC+g+aZ/RObYgHSdPtd3INkau9ZugMpnQe9Iu5Km7IB2DzuDdyD5Qtl2kZiYepH+Q/zhnBYORnDg5eEMf6iRbLwoqdEjdvWVOb8l5NQ4edLcCB4i1FfKM8gZq7bVJXyPOswkedDebALHWJkGpeKw1Y5OeJLDYQ9R3sMIgb9gTBPkEUNQ/cXxkYVoV/wGGW0xeS7TTD7vph5T1G8A9VTGt0NQZi1sYoZc5eEFQFDgK843iwJ7s3Zq/Zp556D0XFuTj9lx93rWF6rGu9qft4etqvWtOYabnx94DeEb6EAlhiYCbRLjBqs/NMWhX4xn7+xhMSx8MFlRksJMIN5g+u36hymbs72MwLX0wWFiS4Sbhv2deVxswqnk9zj4f5mNxv7vpnBLWijPqFX5G7LO8xICX190uKM96Bt8jzXPibfIPuzPKzmKOzdbqSMzlVrPDfy+7dQpYy4XdHfXMZI7trlLc+zj07e2mH301Vgs7vsDOgrHZxjzRc8FpKs/YO1iMk277GkFuxs7Buz4Mo+YtCqNxd1sJsGTrVOHZ31F90p0C96zugLs6Dti5pkGmwNpO2oB63DRIsZCHT29kEyDa2iYo9dDaT9rIfbYzSMmpJz1vZJterD3SGrTbH2s9aZPxc6hB6k0/lXoju1jB1jJBxRGleZC/zDfN5FO0N/QYZJiZi5LVe9Iu46d8gxScfub3Rpaxgm2Wmekzg+ZsC815eZy3kWVp79I2699dZ/eyQW5hlWQm3BxWp3MV1g0BtHeYsJFm646gzGl1ZJ+FYF7p5302YTTmLk9EOG8WNOkgaGUd6Rx0Ki20MiVH3f08GqxK47D7bWO9/XeWxp2gmXeZWAb3u+NEq2AMF814UIKbDWPDfb1vwg7ZWMoZVhnB1f76XB9W++CDldSgO8GCxFoogm+OYq2nbTLjtCk56r5Wcc6ZRsE7TkfvabvU/3hpjudVNFNBMOxih/2/vwi9MK96ptm6OXyrj+dc3cx4PdYnIbaHb83XWqz2r2eRfVkWRSyzuirq4ikXWfUfQUq/i5h7wH+9oo9W2rSzvINZLgY26zm3XD+vpXiqP2fpZv1ZLp8274TphIR/CTh9OtpF/X2w9JpjOklUm83q3Kiycv119dLoWc9MGAyL+6ZVSgmbY4OfofHNKCThqvq8Oc7VHY67r9WsZGuq4EP+I92vXgukyUbrp6xab4rqqVrWy41457XAJ+ZfInlMKmrPVr3vasAbZtr1u8eFVhtVPTdBVbFv8H2DAIu36Xlu0nBmMW2z4NYEMea+FkKtijh4T4V0hm/Jcd5x/v2wViOpjzSga9SLbD49tHPY1P9YfPyxaL36tG0O7e/yMXosWsqnbb3btITlwtyGa/Z7peun/trfde9MUXQkv7STK5cPcf6YyvjTp4fSjNAX9A+aTLT/ExSZQGStD5XyIY4eE5EiMonI2lq7jCiyCJG1ubmMKbIYkSXt/xJKtwSRtfuxMqXIUkSWtf/LHoR4XAqJyDJE1m5jypziliOyFpSyoMgKbF5lbbGk5iocIDQSgqTEWKiWYilINASGQ0TcnAUGRB1RKkVE+gHGRCjbi5ikxLCoc2KMcAyMUAAIEmiBsVFnWkpBYi0wPELBIDKSEiMkNUIk4hIjJDVCJOjSiRbJTV1igKSCQZJhKjFC6qHFUpKRKjFCUsEgJUmJEVLHvEtJxqvEEEmFgyRRlxgidUy6lC2Yy0eRCEyJIZIKB0mCKTFEqvlVShLMCEMUKRxk/hC1WTPF0iMMUaQzWkFSOjktYsMtwhipmrOMSDQjjFGkgIhINCOMkeo2lRGJZoQxihQQERnDEcZItWrKiEQzwhhFCoiIDM0IYxQvWcvHGKNYsJaPMUaqcinbJZ9aKDBGsV54SA+JnaVHY0SGe4wxijVGZLjHGCP1iHUZk7jHGKNYARGTuMcYozjn7Ykxigvenhgj9SBiGZO+lGCMEn4xSjBGiWRzSIIxSiJ2KUwwRknM5pDEqRAS1koJxihJWSslGKMkY70uwRipR1/LmIy4BGOUKCBiMuISjFGqMSIjLsUYpQqImC58MEapZK2UYozSiLVSijFKdQ1HRlyKMUp5jFKnkOMxSjFGqY4jMopTjFHKr0cpxijVGJHxnmKM1OmQMiHjPcMYZYItOjFE6vRAmZCJIcMQZWxNl2GE1EmNMiGjPcMIZQnLEgOkbmqWCenwmVNs89U2xke9PK5MyMjIMD5ZwbLE8OQaHjKEcgxPzsKTY3hyDQ8ZazmGJ2fhyTE8uYaHDKAcw5Oz8OQYnlzDQ29eMDw5C0/u7IY0PGRQ5BienIUnx/Co9+GVKRk9BYanYOEpMDzqrUxlSkZPgeEpWHgKDI96PVaZktFTYHgKFp4Cw1PojSoZPQWGp2DhKTA86t1wZUpGT+HsV1l4CnfHqvGht2NLZ8+6ZBHqLkFSjRG9d1s629Ylv29dOhvXpcaJ3ugtna3rkkWquwRJNVZkKHXXIC2LVncJkmq8yHDqrkFaFrHuEiDVrYSMDCkxajPwkLl9Bt1NyOjukNtp8LQa3F6D7ihkZGgJt9sgeMjcdkPXb6B7GG7HQfCQuS0H3VjI6IaH23QQPGRO10Ho3kJGR5nTdxCSh0y6rSENGR1lTu9BSB4yp/kgdIsho6PMaT8IyUPm9B+E7jJkdJQ5HQghecicFoTQjYaMjjKnCSEkD5nThRBdG4JsuzltCBHxiDl9CKG7DTkdu5HbzvP08xzEdMMhp2PXaUaIiEfM6UYI3XPI6dh1+hEi4hFzGhJCtx1yOnadloSIeMScnoTQnYecjl2nKyFiHjKnLSF08yGnY9dpTIiYhyx2e7AaMjp2nd6EiHnInOaE0C2InI5dpz0hYh4ypz8hdBcip2PX6VCImIfMaVEI3YjI6dh1mhQi4SFzuhRC9yIKOsqcPoVIeMicRoXQ7YiCjrLEbZzzkDm9CqE7EgUdZU63QiQ8ZE67QuimREFHmdOwEAkPmdOxELovUdBR5vQsRMpD5jQthG5NkI0l4XQtRMoj5rQthG5OFHTsOo0LkfKIpe69Dt0CpJV1AEt5wJzehdAdioLOCE73QqQ8YE77QugmRUFnBKeBIfgOhnBaGEI3Kgo6IzhNDKF7FQUd5k4fQ+huBaOCg5juV7S7FJqvg1nG36DK3DtU+hbVkg50p6MhdN+i3dPQxA5sfFdDOG0NkXf3Eun4dTobgm9tCKe3IXQHo90s0Xwd4Pj+hnAaHEK3MdqdFc3XQY5vcginyyF0L6PdhdF8HeT4TodwWh0i73Cj48Lpdgi+3SGcfocoOtzowHBaHoLveQin6SGKDjc6iPq+hz5VoA7J1Jtfu9MFZdl9GGw9PNP7Y7Hqjx4M5yt+LNpK5uOPnw+LdhVp//4cjhyo/ylZ5gTGMDwbRmfd4Hbv1/1Nu7+yZ9rmju5vf72Nze5vP671ff037+nyni7v6fKeLu/pip6u6OmKnq7o6YqeTrUl+n8YzZaJ+YfReWmIhSG20xCGWBhiYYilIZaGWBpiaYilIY4McWSII0McWdMZ4tgQx4Y4NsSxIY4NcWKIE0OcGOLEECeGODXEqcXJEKeGODXEBjOVdft/pOYfhsbgJQxgwiAmDGTCYCY60EjPot75OvhZChxNdXl8XNwHswcueQ64tCWrjwv5NZqBVRIBz09ncVIfTwKMBGAkZzHSHxUCnCTg5DeR88ErwGMJeCy9PDwvRQEWB2ZS+zovQ/SZEqATSFG530LMC/GBHwFrFxO8hldXg/EJ9EO/gdDb/UDKhCyknwV6GR5gkUIW/mmwTzoN7AoYXF7UvcemB4aqtBg4ejEbnyOGbKCpcp9Ljx4AgVwEnB6/to0eOgIWKiCLaJqFfUQH6rGETJJpJv2JScgCJrAiACn3fCrkBVHP2dD85+HKJzIcSCU0wvVSuZO/jlQYMDmbrielep5YcATCvJdzQFUv2681RgUpyg07Pp/gIAkcXHJRAl9yDMo/4JMRN5R6qhTEBlQ55XRmPpYAMitIGQXLpcF2BuHADwHf8QQ2A0NNaRYv+79599eUUWlfwqZczNq6BUkAdumqQN/IFY1PBnOX4BIp+y50YF6YwZYeY43e+gyUgbErWG8h3/sLuMC1gfVx6r3lgAdMpYILL+eF+cAYMI0uuXTAveYZqAGjXLB89MsNNlvkHTGYQcyNtJUsCllgP7aicl6FRG79crgATOuwIudRQDRTDgn8PpnP5m04gA0ENOH83HnBEJgK9O5kWgu1KLoTgZGWcM6NWTzpt5AAHtAfkmls9KtSRkxglCUcLPXhG0o2YJDk0pSbuSWwWtTnOLPzNLvLpN/wme1iyinEZh4J3CzioGHcIgIFYMTlUCpVRQDNiLMHnZ8iAGLEVYvqNQ5o3QaYeYZ0b37Y9W+rANkAJIPOzoI1tObTPW8yMADhw5lYjWu6J2ygZOADKWdhNfT0/YDWa4AMZ1+zy0TygKVi3rroO6dAKDAUWzxSC4aAQdW7esTV8eatByAm4YLB7tL3TbuDRa4P1JXcZPuP7NmvBQKlgVR2o9h8RYqCIoobQGwsCrjRSrnkN/YeUOJw7qo2492HNcHEoDjOLsQHAYEbAQ7sqvNybJ6PFcoLEgSK5PD3vngTLDpwFjHnFJ53nwJWcBWNufl4XmsJWMFyPOagJBbACOTp2Gcad8GKgNPFXC4wK4N6Qg56AqxBOI/V7wMHGAII+2TJrivt0LaMe9o+I6FAYcmla/vudSAYAC7NHqHP1+zGB33ml6zDEsCW3Sp6PpMJwhF4N9sd8H6qFGgFjMR2B+ivwwImcIPGZQjuQ7yADfAStg00MZ8YhFjCeRo3jxjUBGxd13+wAIwCs0+5NKdHET4KS0l2yqO2tED7xd5FORcf9aIlECr7wo8txscNaAGL+H4vnXCZRNUTZCmj7m+BnMCJZz9UCcIBTKfgvI/+KChgAtJNwQHBfdkPsIFpeclNalyNxnCJ5YDk9qcR0D3iDODWWDEYxG6lulmiYSBG2QoCftUEbKPhIsA2sNxvYoDx0GEkF574syJgNKztJG8lNZqIU7hyc4vf8EZCgA2Apl/FUs4t+M8dgHUfRj7byuO/NAE4wTCOZujUf1EAcIJVN++A1C44AqjQVcynh8XL9qXebQ8tUfnp58//B4fgRr9PoQAA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 00000000..108428c3 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + 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: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/Container.html b/classes/Container.html new file mode 100644 index 00000000..d9a18baf --- /dev/null +++ b/classes/Container.html @@ -0,0 +1,11 @@ +Container | @wasmer/wasix

Class Container

Hierarchy

  • Container

Constructors

constructor +

Methods

atom_names +free +get_atom +get_volume +manifest +volume_names +from_registry +

Constructors

constructor

  • Parse a Container from its binary representation.

    +

    Parameters

    • raw: Uint8Array

    Returns Container

Methods

atom_names

  • Returns string[]

free

  • Returns void

get_atom

  • Parameters

    • name: string

    Returns Uint8Array

get_volume

  • Parameters

    • _name: string

    Returns Volume

manifest

volume_names

  • Returns string[]

Static from_registry

  • Download a package from the registry.

    +

    Parameters

    • package_specifier: string
    • runtime: Runtime

    Returns Promise<Container>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Directory.html b/classes/Directory.html new file mode 100644 index 00000000..822b3fc2 --- /dev/null +++ b/classes/Directory.html @@ -0,0 +1,26 @@ +Directory | @wasmer/wasix

Class Directory

A directory that can be mounted inside a WASIX instance.

+

Hierarchy

  • Directory

Constructors

constructor +

Methods

__getClassname +createDir +free +readDir +readFile +writeFile +fromBrowser +

Constructors

constructor

  • Create a temporary [Directory] that holds its contents in memory.

    +

    Returns Directory

Methods

__getClassname

  • __getClassname(): string

  • Returns string

createDir

  • Create a directory.

    +

    Parameters

    • path: string

    Returns void

free

  • Returns void

readDir

  • Parameters

    • path: string

    Returns string[]

readFile

  • Read the contents of a file from this directory.

    +

    Note that the path is relative to the directory's root.

    +

    Parameters

    • path: string

    Returns Promise<Uint8Array>

writeFile

  • Write to a file.

    +

    Parameters

    • path: string
    • contents: Uint8Array

    Returns Promise<void>

Static fromBrowser

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Instance.html b/classes/Instance.html new file mode 100644 index 00000000..3f28d079 --- /dev/null +++ b/classes/Instance.html @@ -0,0 +1,13 @@ +Instance | @wasmer/wasix

Class Instance

A handle connected to a running WASIX program.

+

Hierarchy

  • Instance

Constructors

constructor +

Properties

stderr +stdin +stdout +

Methods

free +wait +

Constructors

constructor

Properties

Readonly stderr

stderr: ReadableStream<any>

The WASI program's standard error.

+

Readonly stdin

stdin: WritableStream<any>

The standard input stream, if one wasn't provided when starting the +instance.

+

Readonly stdout

stdout: ReadableStream<any>

The WASI program's standard output.

+

Methods

free

  • Returns void

wait

  • Wait for the process to exit.

    +

    Returns Promise<Output>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Runtime.html b/classes/Runtime.html new file mode 100644 index 00000000..89fd4c2e --- /dev/null +++ b/classes/Runtime.html @@ -0,0 +1,10 @@ +Runtime | @wasmer/wasix

Class Runtime

Runtime components used when running WebAssembly programs.

+

Hierarchy

  • Runtime

Constructors

constructor +

Methods

__getClassname +free +print_tty_options +set_network_gateway +set_registry +

Constructors

constructor

  • Parameters

    • Optional pool_size: number

    Returns Runtime

Methods

__getClassname

  • __getClassname(): string

  • Returns string

free

  • Returns void

print_tty_options

  • Returns void

set_network_gateway

  • Enable networking (i.e. TCP and UDP) via a gateway server.

    +

    Parameters

    • gateway_url: string

    Returns void

set_registry

  • Set the registry that packages will be fetched from.

    +

    Parameters

    • url: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Volume.html b/classes/Volume.html new file mode 100644 index 00000000..c2a7f62a --- /dev/null +++ b/classes/Volume.html @@ -0,0 +1,3 @@ +Volume | @wasmer/wasix

Class Volume

Hierarchy

  • Volume

Constructors

constructor +

Methods

free +

Constructors

constructor

Methods

free

  • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/Wasmer.html b/classes/Wasmer.html new file mode 100644 index 00000000..bf10b261 --- /dev/null +++ b/classes/Wasmer.html @@ -0,0 +1,6 @@ +Wasmer | @wasmer/wasix

Class Wasmer

The entrypoint to the Wasmer SDK.

+

Hierarchy

  • Wasmer

Constructors

constructor +

Methods

free +runtime +spawn +

Constructors

constructor

Methods

free

  • Returns void

runtime

  • Returns Runtime

spawn

  • Parameters

    Returns Promise<Instance>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/init.html b/functions/init.html new file mode 100644 index 00000000..073d9ba5 --- /dev/null +++ b/functions/init.html @@ -0,0 +1,2 @@ +init | @wasmer/wasix

Function init

  • Initialize the underlying WebAssembly module.

    +

    Parameters

    • Optional input: InitInput | Promise<InitInput>
    • Optional maybe_memory: Memory
    • Optional force: boolean

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/initSync.html b/functions/initSync.html new file mode 100644 index 00000000..e8763293 --- /dev/null +++ b/functions/initSync.html @@ -0,0 +1,3 @@ +initSync | @wasmer/wasix

Function initSync

  • Instantiates the given module, which can either be bytes or +a precompiled WebAssembly.Module.

    +

    Parameters

    Returns InitOutput

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/initializeLogger.html b/functions/initializeLogger.html new file mode 100644 index 00000000..e9c64c16 --- /dev/null +++ b/functions/initializeLogger.html @@ -0,0 +1,19 @@ +initializeLogger | @wasmer/wasix

Function initializeLogger

  • Initialize the logger used by @wasmer/wasix.

    +

    This function can only be called once. Subsequent calls will raise an +exception.

    +

    Filtering Logs

    The filter string can be used to tweak logging verbosity, both globally +or on a per-module basis, and follows the $RUST_LOG format.

    +

    Some examples:

    +
      +
    • off - turn off all logs
      • +
    • error, warn, info, debug, trace - set the global log level
      • +
    • wasmer_wasix - enable logs for wasmer_wasix
      • +
    • info,wasmer_wasix_js::package_loader=trace - set the global log level to +info and set wasmer_wasix_js::package_loader to trace
      • +
    • wasmer_wasix_js=debug/flush - turns on debug logging for +wasmer_wasix_js where the log message includes flush
      • +
    • warn,wasmer=info,wasmer_wasix::syscalls::wasi=trace - directives can be +mixed arbitrarily
      • +
    +

    When no filter string is provided, a useful default will be used.

    +

    Parameters

    • Optional filter: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/run.html b/functions/run.html new file mode 100644 index 00000000..45dbf7df --- /dev/null +++ b/functions/run.html @@ -0,0 +1,2 @@ +run | @wasmer/wasix

Function run

  • Run a WASIX program.

    +

    Parameters

    Returns Instance

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/wat2wasm.html b/functions/wat2wasm.html new file mode 100644 index 00000000..c13ed629 --- /dev/null +++ b/functions/wat2wasm.html @@ -0,0 +1 @@ +wat2wasm | @wasmer/wasix

Function wat2wasm

  • Parameters

    • wat: string

    Returns Uint8Array

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 00000000..bed5e64a --- /dev/null +++ b/index.html @@ -0,0 +1,67 @@ +@wasmer/wasix

@wasmer/wasix

Wasmer logo Wasmer JS Wasmer Slack Channel

This repository consists of multiple packages:

+ +

Wasmer WASI

Isomorphic Javascript library for interacting with WASI Modules in Node.js, the Browser and Deno. +The Javascript Package supports:

+
    +
  • WASI (with command args, envs and stdio)
    • +
  • In-Memory filesystem (MemFS)
    • +
+

NPM

For instaling @wasmer/wasi run this command in your shell:

+
npm install --save @wasmer/wasi
+
+

And then import it in your server or client-side code with:

+
import { init, WASI } from '@wasmer/wasi';
+
+
+

Check the Node usage examples in https://github.com/wasmerio/wasmer-js/tree/main/examples/node

+
+

Deno

This package is published in Deno in the wasm package, you can import it directly with:

+
import { init, WASI } from 'https://deno.land/x/wasm/wasi.ts';
+
+
+

Check the Deno usage Examples in https://github.com/wasmerio/wasmer-js/tree/main/examples/deno

+
+

Usage

// This is needed to load the WASI library first (since is a Wasm module)
await init();

let wasi = new WASI({
  env: {
      // 'ENVVAR1': '1',
      // 'ENVVAR2': '2'
  },
  args: [
      // 'command', 'arg1', 'arg2'
  ],
});

const moduleBytes = fetch("https://deno.land/x/wasm/tests/demo.wasm");
const module = await WebAssembly.compileStreaming(moduleBytes);
// Instantiate the WASI module
await wasi.instantiate(module, {});

// Run the start function
let exitCode = wasi.start();
let stdout = wasi.getStdoutString();

 // This should print "hello world (exit code: 0)"
console.log(`${stdout}(exit code: ${exitCode})`);
+
+

API Docs

+ +

Typescript API

export class WASI {
  constructor(config: any);
  readonly fs: MemFS;

  instantiate(module: any, imports: object): WebAssembly.Instance;
  // Start the WASI Instance, it returns the status code when calling the start
  // function
  start(instance: WebAssembly.Instance): number;
  // Get the stdout buffer
  // Note: this method flushes the stdout
  getStdoutBuffer(): Uint8Array;
  // Get the stdout data as a string
  // Note: this method flushes the stdout
  getStdoutString(): string;
  // Get the stderr buffer
  // Note: this method flushes the stderr
  getStderrBuffer(): Uint8Array;
  // Get the stderr data as a string
  // Note: this method flushes the stderr
  getStderrString(): string;
  // Set the stdin buffer
  setStdinBuffer(buf: Uint8Array): void;
  // Set the stdin data as a string
  setStdinString(input: string): void;
}

export class MemFS {
  constructor();
  readDir(path: string): Array<any>;
  createDir(path: string): void;
  removeDir(path: string): void;
  removeFile(path: string): void;
  rename(path: string, to: string): void;
  metadata(path: string): object;
  open(path: string, options: any): JSVirtualFile;
}

export class JSVirtualFile {
  lastAccessed(): BigInt;
  lastModified(): BigInt;
  createdTime(): BigInt;
  size(): BigInt;
  setLength(new_size: BigInt): void;
  read(): Uint8Array;
  readString(): string;
  write(buf: Uint8Array): number;
  writeString(buf: string): number;
  flush(): void;
  seek(position: number): number;
}
+
+

Building

To build this library you will need to have installed in your system:

+ +
npm i
npm run build
+
+

Testing

Build the pkg and run the tests:

+
npm run build
npm run test
+
+

What is WebAssembly?

Quoting the WebAssembly site:

+
+

WebAssembly (abbreviated Wasm) is a binary instruction format for a +stack-based virtual machine. Wasm is designed as a portable target +for compilation of high-level languages like C/C++/Rust, enabling +deployment on the web for client and server applications.

+
+

About speed:

+
+

WebAssembly aims to execute at native speed by taking advantage of +common hardware +capabilities +available on a wide range of platforms.

+
+

About safety:

+
+

WebAssembly describes a memory-safe, sandboxed execution +environment […].

+
+

License

The entire project is under the MIT License. Please read the +LICENSE file.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/InitOutput.html b/interfaces/InitOutput.html new file mode 100644 index 00000000..e1c45a9c --- /dev/null +++ b/interfaces/InitOutput.html @@ -0,0 +1,63 @@ +InitOutput | @wasmer/wasix

Interface InitOutput

Hierarchy

  • InitOutput

Properties

_ZN12wasm_bindgen7convert8closures11invoke1_mut17h099427ea9e9f817aE +_ZN12wasm_bindgen7convert8closures11invoke2_mut17h0cf7acd9afa0e0d1E +_ZN12wasm_bindgen7convert8closures7invoke117hbc21feb76dcb20fdE +__wbg_container_free +__wbg_directory_free +__wbg_get_instance_stderr +__wbg_get_instance_stdin +__wbg_get_instance_stdout +__wbg_instance_free +__wbg_readablestreamsource_free +__wbg_runtime_free +__wbg_threadpoolworker_free +__wbg_trap_free +__wbg_volume_free +__wbg_wasmer_free +__wbg_writablestreamsink_free +__wbindgen_add_to_stack_pointer +__wbindgen_exn_store +__wbindgen_export_3 +__wbindgen_malloc +__wbindgen_realloc +__wbindgen_start +__wbindgen_thread_destroy +canonical_abi_free +canonical_abi_realloc +container_atom_names +container_from_registry +container_get_atom +container_get_volume +container_manifest +container_new +container_volume_names +directory___getClassname +directory_createDir +directory_fromBrowser +directory_new +directory_readDir +directory_readFile +directory_writeFile +initializeLogger +instance_wait +memory +on_start +readablestreamsource_cancel +readablestreamsource_pull +readablestreamsource_type +run +runtime___getClassname +runtime_print_tty_options +runtime_set_network_gateway +runtime_set_registry +runtime_with_pool_size +threadpoolworker_handle +threadpoolworker_new +trap___wbg_wasmer_trap +wasmer_new +wasmer_runtime +wasmer_spawn +wat2wasm +writablestreamsink_abort +writablestreamsink_close +writablestreamsink_write +

Properties

Readonly _ZN12wasm_bindgen7convert8closures11invoke1_mut17h099427ea9e9f817aE

_ZN12wasm_bindgen7convert8closures11invoke1_mut17h099427ea9e9f817aE: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly _ZN12wasm_bindgen7convert8closures11invoke2_mut17h0cf7acd9afa0e0d1E

_ZN12wasm_bindgen7convert8closures11invoke2_mut17h0cf7acd9afa0e0d1E: ((a, b, c, d) => void)

Type declaration

    • (a, b, c, d): void

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns void

Readonly _ZN12wasm_bindgen7convert8closures7invoke117hbc21feb76dcb20fdE

_ZN12wasm_bindgen7convert8closures7invoke117hbc21feb76dcb20fdE: ((a, b, c) => number)

Type declaration

    • (a, b, c): number

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns number

Readonly __wbg_container_free

__wbg_container_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_directory_free

__wbg_directory_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_get_instance_stderr

__wbg_get_instance_stderr: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly __wbg_get_instance_stdin

__wbg_get_instance_stdin: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly __wbg_get_instance_stdout

__wbg_get_instance_stdout: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly __wbg_instance_free

__wbg_instance_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_readablestreamsource_free

__wbg_readablestreamsource_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_runtime_free

__wbg_runtime_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_threadpoolworker_free

__wbg_threadpoolworker_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_trap_free

__wbg_trap_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_volume_free

__wbg_volume_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_wasmer_free

__wbg_wasmer_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbg_writablestreamsink_free

__wbg_writablestreamsink_free: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbindgen_add_to_stack_pointer

__wbindgen_add_to_stack_pointer: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly __wbindgen_exn_store

__wbindgen_exn_store: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly __wbindgen_export_3

__wbindgen_export_3: Table

Readonly __wbindgen_malloc

__wbindgen_malloc: ((a, b) => number)

Type declaration

    • (a, b): number

    • Parameters

      • a: number
      • b: number

      Returns number

Readonly __wbindgen_realloc

__wbindgen_realloc: ((a, b, c, d) => number)

Type declaration

    • (a, b, c, d): number

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns number

Readonly __wbindgen_start

__wbindgen_start: (() => void)

Type declaration

    • (): void

    • Returns void

Readonly __wbindgen_thread_destroy

__wbindgen_thread_destroy: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly canonical_abi_free

canonical_abi_free: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly canonical_abi_realloc

canonical_abi_realloc: ((a, b, c, d) => number)

Type declaration

    • (a, b, c, d): number

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns number

Readonly container_atom_names

container_atom_names: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly container_from_registry

container_from_registry: ((a, b, c) => number)

Type declaration

    • (a, b, c): number

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns number

Readonly container_get_atom

container_get_atom: ((a, b, c) => number)

Type declaration

    • (a, b, c): number

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns number

Readonly container_get_volume

container_get_volume: ((a, b, c) => number)

Type declaration

    • (a, b, c): number

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns number

Readonly container_manifest

container_manifest: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly container_new

container_new: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly container_volume_names

container_volume_names: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly directory___getClassname

directory___getClassname: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly directory_createDir

directory_createDir: ((a, b, c, d) => void)

Type declaration

    • (a, b, c, d): void

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns void

Readonly directory_fromBrowser

directory_fromBrowser: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly directory_new

directory_new: (() => number)

Type declaration

    • (): number

    • Returns number

Readonly directory_readDir

directory_readDir: ((a, b, c, d) => void)

Type declaration

    • (a, b, c, d): void

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns void

Readonly directory_readFile

directory_readFile: ((a, b, c) => number)

Type declaration

    • (a, b, c): number

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns number

Readonly directory_writeFile

directory_writeFile: ((a, b, c, d, e) => number)

Type declaration

    • (a, b, c, d, e): number

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number
      • e: number

      Returns number

Readonly initializeLogger

initializeLogger: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly instance_wait

instance_wait: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly memory

memory: Memory

Readonly on_start

on_start: (() => void)

Type declaration

    • (): void

    • Returns void

Readonly readablestreamsource_cancel

readablestreamsource_cancel: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly readablestreamsource_pull

readablestreamsource_pull: ((a, b) => number)

Type declaration

    • (a, b): number

    • Parameters

      • a: number
      • b: number

      Returns number

Readonly readablestreamsource_type

readablestreamsource_type: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly run

run: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly runtime___getClassname

runtime___getClassname: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly runtime_print_tty_options

runtime_print_tty_options: ((a) => void)

Type declaration

    • (a): void

    • Parameters

      • a: number

      Returns void

Readonly runtime_set_network_gateway

runtime_set_network_gateway: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly runtime_set_registry

runtime_set_registry: ((a, b, c, d) => void)

Type declaration

    • (a, b, c, d): void

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns void

Readonly runtime_with_pool_size

runtime_with_pool_size: ((a, b, c) => void)

Type declaration

    • (a, b, c): void

    • Parameters

      • a: number
      • b: number
      • c: number

      Returns void

Readonly threadpoolworker_handle

threadpoolworker_handle: ((a, b) => number)

Type declaration

    • (a, b): number

    • Parameters

      • a: number
      • b: number

      Returns number

Readonly threadpoolworker_new

threadpoolworker_new: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly trap___wbg_wasmer_trap

trap___wbg_wasmer_trap: (() => void)

Type declaration

    • (): void

    • Returns void

Readonly wasmer_new

wasmer_new: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly wasmer_runtime

wasmer_runtime: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly wasmer_spawn

wasmer_spawn: ((a, b, c, d) => number)

Type declaration

    • (a, b, c, d): number

    • Parameters

      • a: number
      • b: number
      • c: number
      • d: number

      Returns number

Readonly wat2wasm

wat2wasm: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly writablestreamsink_abort

writablestreamsink_abort: ((a, b) => void)

Type declaration

    • (a, b): void

    • Parameters

      • a: number
      • b: number

      Returns void

Readonly writablestreamsink_close

writablestreamsink_close: ((a) => number)

Type declaration

    • (a): number

    • Parameters

      • a: number

      Returns number

Readonly writablestreamsink_write

writablestreamsink_write: ((a, b) => number)

Type declaration

    • (a, b): number

    • Parameters

      • a: number
      • b: number

      Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 00000000..e9c330ad --- /dev/null +++ b/modules.html @@ -0,0 +1,20 @@ +@wasmer/wasix

@wasmer/wasix

Index

Classes

Container +Directory +Instance +Runtime +Volume +Wasmer +

Interfaces

InitOutput +

Type Aliases

InitInput +Manifest +Output +RunConfig +SpawnConfig +SyncInitInput +WasmerConfig +

Functions

init +initSync +initializeLogger +run +wat2wasm +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/InitInput.html b/types/InitInput.html new file mode 100644 index 00000000..f20f5121 --- /dev/null +++ b/types/InitInput.html @@ -0,0 +1 @@ +InitInput | @wasmer/wasix

Type alias InitInput

InitInput: RequestInfo | URL | Response | BufferSource | WebAssembly.Module

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Manifest.html b/types/Manifest.html new file mode 100644 index 00000000..519bc9c9 --- /dev/null +++ b/types/Manifest.html @@ -0,0 +1,2 @@ +Manifest | @wasmer/wasix

Type alias Manifest

Manifest: {}

Metadata associated with a webc file.

+

Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Output.html b/types/Output.html new file mode 100644 index 00000000..ce497773 --- /dev/null +++ b/types/Output.html @@ -0,0 +1 @@ +Output | @wasmer/wasix

    Type alias Output

    Output: {
        code: number;
        ok: boolean;
        stderr: Uint8Array;
        stdout: Uint8Array;
    }

    Type declaration

    • code: number
    • ok: boolean
    • stderr: Uint8Array
    • stdout: Uint8Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/RunConfig.html b/types/RunConfig.html new file mode 100644 index 00000000..df839cdf --- /dev/null +++ b/types/RunConfig.html @@ -0,0 +1,11 @@ +RunConfig | @wasmer/wasix

    Type alias RunConfig

    RunConfig: {
        args?: string[];
        env?: Record<string, string>;
        mount?: Record<string, Directory>;
        program?: string;
        runtime?: Runtime;
        stdin?: string | ArrayBuffer;
    }

    Configuration used when starting a WASI program.

    +

    Type declaration

    • Optional args?: string[]

      Additional command-line arguments to be passed to the program.

      +
    • Optional env?: Record<string, string>

      Environment variables to set.

      +
    • Optional mount?: Record<string, Directory>

      Directories that should be mounted inside the WASIX instance.

      +
    • Optional program?: string

      The name of the program being run (passed in as arg 0)

      +
    • Optional runtime?: Runtime

      The WASIX runtime to use.

      +

      Providing a Runtime allows multiple WASIX instances to share things +like caches and threadpools. If not provided, a default Runtime will be +created.

      +
    • Optional stdin?: string | ArrayBuffer

      The standard input stream.

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/SpawnConfig.html b/types/SpawnConfig.html new file mode 100644 index 00000000..cd8c6a88 --- /dev/null +++ b/types/SpawnConfig.html @@ -0,0 +1,5 @@ +SpawnConfig | @wasmer/wasix

    Type alias SpawnConfig

    SpawnConfig: RunConfig & {
        command?: string;
        uses?: string[];
    }

    Configuration used when starting a WASI program.

    +

    Type declaration

    • Optional command?: string

      The name of the command to be run (uses the package's entrypoint if not +defined).

      +
    • Optional uses?: string[]

      Packages that should also be loaded into the WASIX environment.

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/SyncInitInput.html b/types/SyncInitInput.html new file mode 100644 index 00000000..ce6f51ae --- /dev/null +++ b/types/SyncInitInput.html @@ -0,0 +1 @@ +SyncInitInput | @wasmer/wasix

    Type alias SyncInitInput

    SyncInitInput: BufferSource | WebAssembly.Module

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WasmerConfig.html b/types/WasmerConfig.html new file mode 100644 index 00000000..c51d6b0b --- /dev/null +++ b/types/WasmerConfig.html @@ -0,0 +1,14 @@ +WasmerConfig | @wasmer/wasix

    Type alias WasmerConfig

    WasmerConfig: {
        apiKey?: string;
        networkGateway?: string;
        poolSize?: number;
        registryUrl: string | null | undefined;
    }

    Configuration used when initializing the Wasmer SDK.

    +

    Type declaration

    • Optional apiKey?: string

      An API key to use when interacting with the Wasmer registry.

      +
    • Optional networkGateway?: string

      Enable networking (i.e. TCP and UDP) via a gateway server.

      +
    • Optional poolSize?: number

      The maximum number of threads to use.

      +

      Note that setting this value too low may starve the threadpool of CPU +resources, which may lead to deadlocks (e.g. one blocking operation waits +on the result of another, but that other operation never gets a chance to +run because there aren't any free threads).

      +

      If not provided, this defaults to 16 * navigator.hardwareConcurrency.

      +
    • registryUrl: string | null | undefined

      Set the registry that packages will be fetched from.

      +

      If null, no registry will be used and looking up packages will always +fail.

      +

      If undefined, will fall back to the default Wasmer registry.

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file