diff --git a/docs/dev/assets/icons.js b/docs/dev/assets/icons.js index b79c9e8..e88e8ca 100644 --- a/docs/dev/assets/icons.js +++ b/docs/dev/assets/icons.js @@ -1,15 +1,18 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/dev/assets/icons.svg b/docs/dev/assets/icons.svg index 7dead61..e371b8b 100644 --- a/docs/dev/assets/icons.svg +++ b/docs/dev/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/dev/assets/main.js b/docs/dev/assets/main.js index d6f1388..21a5d74 100644 --- a/docs/dev/assets/main.js +++ b/docs/dev/assets/main.js @@ -1,8 +1,9 @@ "use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=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=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_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),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,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.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}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()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}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&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}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(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(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 Ve(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 y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}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 Ne(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 He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!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&&(Be=!0,F="touchstart",fe="touchmove",H="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(fe,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(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),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 n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.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,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(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.showPage(),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.pathname===r.pathname&&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();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(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),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,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 ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.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()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}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&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}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)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}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=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(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=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){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",()=>{ce(e,t)}),ce(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");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}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=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(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),te(e)}}function he(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(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!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(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),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 n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){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();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(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-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(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)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&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-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/dev/assets/navigation.js b/docs/dev/assets/navigation.js index 604939e..171539c 100644 --- a/docs/dev/assets/navigation.js +++ b/docs/dev/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72X32/TMBDH/5XJz4XSjg3o2yYNMTStEoXxMO3BTZzE4NiRc5lWIf535LQ0dnx2otLyVCn3vU98P+K7Pv4iwF6ALMgnnheC5wXUZEKSgotUM0kWj3vBraxBNyWTQCakolCQBUkErWtWTzvb6wJKQSbkJ5cpWczm739P9oQ7umHad24fx/zuFTDfzTyNea2UzH0v8zTmlWlVXmlNN9dNltmnzRqZAFeynvYkLu3yrQUDNYByBB7oyY8GK8xhgRp7m/ka993aYoSbF14Dl3lXfAvFJTCd0YTVU0TnYucXl72DXTWgVvSZoTxbMAS6U6oKQoxxCLBc/2AJBBFbcwySsow2AvyInqnmdC1YPe1JXNr53Ie5UXkgPy4HctQWN8rPq+V9iGJs0cZ2rpXT3DumUGiT2v0e7E6Xdd1wAbfS/KR27qy+cCWx3jjRF9TJllVbCRTqqWLIXUwdCDZVF2rP882Hd7MLu+PWgaR1nesqXs2Gv4FIkN4HMRDq+dzpyL9jCmvGQ0dYKzATC+m+zvZ/7uveMZA+Qw7jtkP7slhz2YIRtyPO8y+2ILVXwt3GEKzgP1XisHXkiNk3gljyLfuI3KM0L/VBZi/z7dQ4208WrAIf3eESiwSXxoL6qkaiMeGIbA0d3kvcmBCw+y0eiPea4XBOtwMccc3drRLoHpBLpVn6QEUT+IAcxckXO46fp6uMI4iOtIOWKDv/IeetZWD/AqYlFWffgAsOnIX+/22r94XRFJuAtjW+Pxndd02rKozZmcdwOMQwxhqjqJLDTVnBpj9ZuxT2JEgun/4AnreBEkUPAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72XXU/bMBSG/wrydUdp+RjrHUhMVEIgAdMuKi5M4zTWHDuyTxDVtP+OHLrGHydO1LW7qpTznqfn462dLn4TYO9AZuSWrwrBVwUYMiLLgotMM0lmi61gLg3oumQSyIhUFAoyI0tBjWFm3MaOCygFGZFfXGZkNple/hltCXd0zXSc3DxO5d0rYHGafZrKelJyFWfZp6msXKvySmu6vq7z3K02r+USuJJmHEh82sWZAwPVg/IEEegl7gZbzG6N2ngzeYPnfsZShJt3boDLVbt8B8UlMJ3TJTNjROdjp+cXQWFXNagn+sZQnivoA90pVXVCbDAFyFhOawFxMW9Uc/oqmBkHEp92Oo1hfkERKC7Jg+zBna6pvJ/0YX7zds6oQVyvdTrDZ13XXMBc2o/Mbd5Zqy9JLfdA7m1lD1WzEBQaqVLITU8tCNZV22qQefLt6+Tctcxrx9Ba6/mKL5N+EyeajBzd0+rp1HPk3ysCM+Ou10cjsLcF4r429n/OyqAMxGdIMb4dmi9LmcsVDDjecF58MnVSgxVubuvODf7TJnZ7Fdjj9K0gNXwnPmD2KC0afSczmHxz7B9trwZsA9/92yHVCS5NNfWsBqIx4YBp9RUfDW5IC9j5lm4k+pr+dvZ9iR/kFXNuFySpOPoBXHDgrOufwCfrkdEMO4/daPo2t7qfmlZVN2YTHsLhkMLYaIqiSg43ZQXr8JxvJxlIkFm+fACUc8p9Tw0AAA==" \ No newline at end of file diff --git a/docs/dev/assets/search.js b/docs/dev/assets/search.js index 2715f1f..360a22b 100644 --- a/docs/dev/assets/search.js +++ b/docs/dev/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA61dXZPcto79K1vtV6UjUKQ+5i25H1XezSa3rrN3H6ZcrvaMZqzrntaUpHHidfm/b5GSWgAFSFT3PDkZgQDJA4DgEan+tmvqP9rdze233efqdL+7AZVHu9Phqdzd7H5+eXgom/9tDs/PZbOLdi/NcXezuzse2rZsfyRP95+6p+MuGh/ubna779Go04A667yrT23XvNx1dYjGN1QcaY92z4emPHWzbk5mIVb6bPejEwoxeZa8wtqXqvwjzNpZcrLWtfc/VO0Pz03dlXddeb/Z+qn8s/v5a1eG2Eey28arYj15SlO21f8F2TtLXjnemZv+szzci1PeP3xFJ0UKRR8dxlWdPpVNxY5r6LM4qYf7BRhxF5DoEorr9v7n1FaPp3KLXa/JdfbffaqbLtDwKHudxbenUHu95JXj65rq9Bg6wFF4k83wtIftMVnvAv8NT4LYdkAO/I9rO7OSE3F32JR4fTAvZEgK/GqCvGgymHW96hbWKPvwVVf1s8JNi7rrozCnf9iniwvdZBPLXmkxIEfOLG9IkgE9WMqSM9MhaTLAppwnZxbXE2XIGJcy5XyQIalyZnVLhTgZvChVLtteqRcn26+TKpc7s1o+Tt25MFUuw79STE7WXydVzjqTTlPR1T81zeHrz9Q1Hl5Od11Vn9ofyfPFbKlMetb6O27127NTdVZenbqyeTjcle2PnNyiEQJj9Xiqm/JvT8/d118OX8tmm4k3XHM+uNjhTJ1KpmXivnw4vBy7xfF/OTTV4eOxbH9ckF6cBYLff7777VcWOPsgGLG3bjLu/3U4vpTsPBKBYLXv6tPjbx//Xd51nM7paTjox/L02H0K0PbmLMmDirom5ayyaav6FGJrEr3UmPsnwNIgd6mZw0v3CZUwC4bOkpeaqpvqsTodjj8Fm5y1uNT0fdneNZWLpBC7VPxSo9XTc910vwbiSKQvNXms6+egUOjlrnCa+t3hS9C4kOyl5p6q00tXtu+ey1NI2njjyV88meVD95djdfeZzX/z7IKkLzXZVI+fNtik4pca/Xis7z63P93fu1ph1SgVv87oP8un+ssWs1ODi1PBS3MIzgOT7MVOdGi7/y4P7UsTFC1U/FKjXfVUvqseT4cu0Kzf4GLD5dNzHWRwELxmhP8om9+ru8+h45vELzX66dC+q49B45tEL149HGPwVJ66oFRAxS/3VqlsnjvqYoXMmkJ1ccWWl1MlTJ7/AKHV70NTPy3vXzyJ4ML177Tdwh6Gl3zlXcyCkQ37GGFQSzuZlXmY7WUumA0PT2E/Mz4KRvDnl+rYvT3Zf/BrEzSpVGK5j8Ykk+oPH7qvz2yiZVS++fChOt2Xf+7PrSQGhzQdWm3dLqx3YL+4g+B7MfZd6Exbv5zu/14dL+0Rbn9dt5ADf+TxnzyWCqwkHRUXGRjle9dZre3Heazhu+5zFl9IMDOh8NwieQmvcnlvOe/rJd4gWF73gGDzn8uvGwz30leafG7Ktv2vTXZRk+3G52ladqRZht7oTuitytRyRl1Oj8Kd86MXQoKuN5Pc2kxd8O7GNxby5oY1SNf01s8Pkj0seak1EuWSocDYDg9qydCWUA6JYclOWOQGh6xkZkOgCkn+b39WbVedHt8uV/iMWHBk2vKbUz8Oynv+Km89OZ1B4eN3ViKdjscwm73gVbYeqqbt/vLSdvXTW1d1BRlmWm3tBXkt9Fh2v9fdIXDYSPoqq205T+eswV7wKluH+/tATO+XOZ8AW3dNeWBe8fFuO8peZfG+PJahFs+yV1m8tS/2Dl3dvA+z+mGU/3CJZZTT3EZzoWbFz68vV2fallcz0jlxhf6lvvvMU5Fzc0j6GpMSm8QZXKSTQsx9qY8vodN5lr3cXNuVTRk4urPsJnPzqpf1wlnBG+6LaEV1jWZB5f76KqvnpClozey7I4VN3ZXzNR9ZGAUu0c3Vllj1aiAGRyCjPSzuAgOO1b8eZoHxxWgPiarAcGK0hwTRQrnocY142egfvVqRiNQF14dD7zaWhtjSWlU4sxBeimEzQVXYsq2FQoVM3XqNsmxHKr7IrK3UXcsWFgogbCSg9lm2s1L2YFuBFc/cHrOB+5XkWWbr5gS2LTG/yrl7XdumxWZSF77i9L3bEIW+paUoZC2ERaFvZjUKeVupAq2JNfImfsna4jv49ZFxmy7fzNJ+a90CF+0zdBaifd2CkLdmzract9btCFnFt7OSVdbtLGQV31ZAVuHtoaxiny3soNDj8A2UwH37uha5M9wv8WDcsb6rujBbSPhig8+H0wmflV6yN8lebq7q7tgjhnNjg+QWU/N9DOcKs21MsEOgJca2mTmz/eOrLCtnRUELiuvL6uGHBSNEaLsNjlOelK9FRHAozFUHBUCo58/Vh/h7mKMzulfde+Hc708rpwbH5+HprTzZiBCPjxGFbyZhuew7d1H0y65svqACZNEikt5k0p+4XxZOddpnrzZhZ2VBk+W6JW5XD023dDprMoVFLzPW2VLPCognlyZrRDbY3DxFz5x5lp+D3JnhsDDYc+5qFW5vW89uiF5tK79tEy/h94YeG5wb+DA/Lni+9lJ96avJQEvMuUHOnnBeMNiqv235hd5SmJvEMttn0L+ZMNcfciFhE+c3qV6k/Jb0encP5poDrhxsvGwwt7HhjsGW2wVzQ6GXCjZcJ5gbCbxFEHR/YK599dpA8IUBFuv1ewKbbgjMbQRfDNhwJYCZpbCbAFvuAMyNhB7933Lof24l9Kz/tlP+kp2Qw/0LOfav/sl+Nsv+NeRM/1ImZw708+k88Cj/tkP8c1PhZ/eXaLWVFRiJbNffrutvr9Hv+LeQdX0meNlYgmzNBLfb8u8bzI2EXDPYcsGAWVAC7xUE3ihgsuX6RQL+bHj9VHXcKfnpiLgnwVW976Ndf6z65tu5iLrZqX2yL3bR7qEqj/f2W1FjCXRXPzm+4f3w7F+lLXqtRC/yY7yLbuMozfaxMu/fR7djC/fA/cGJwS66hUjlew0pEQMipnbRrYoM7JVKiJgiYskuuk04sYSI6V10qzkxTcTMLro1kc72KldEzBCxdBfdptxIUyKWSSPNiFi+i26zyGR7TZXlRKrYRbc5I1XQybVzXTBi4IHgUIg5QQoD2OkG4AQpEJBIgAGFArQEGVAwwEigAYUDUgk2oICAQ0RxyAHFBHLRSyksYOcfEm5+KDLKAgCaEVQUGuWgMZygFyEOmpQTpNAoCwBwLqYoNEqLQUehUUbCUFFoVCphqCg0KpMwVBQZ5ZCxkaD3uiioKMVGOWyKqDD7zBs3xSaxCKg4MmZvioymEQpOYiFQEEFs9onnQgmFJ3EZTEUAek+7mXgpzEVOEuVmbxIviVF8EoePjpJc7Qtv7AlFKLE4KBOlaq8Sb0gUosQCoVJ28BSjxCKhskjDPgFv7BSkxAKhclYnxSixSKiClaQgaYtEwoKkKUjaApEAK0kx0haJRLGSFCTtFpqElfSWGpffNCtJMdIuigwrSTHSFoiExUhTjLQFIslYSYqRtkAkLEaaYqQtEEnB+ZKmGBkLhI45SUMxMhYIzWJkKEbGAqFZjAzFyFggNIuRoRgZVw+wGBmvInCLEIuRoRgZl+pYjAzFyGR9wBd6H+eeJMXIWCB0FilVZPuioCuRoSgZC4XOmWxnKEipnO1SClLqQCrYbJdSlFILhYkjbYq98VJTSmFKLRYGIlD5nqa7lKKUWiiMsotC7g0ppSilRsxMqVe6uVqBXbpSilKaDd3UsAdPkqKUWiCM5gZEIUotEMZEoJN96s8nBSmLxRFlFKQMxBFlFKPMYZTa+SyMp5NClDmI2CySUYwyh1Eegcn2hefMGQUpc9V1EeVFvgcqSDHK0n4+OetehS2X2BSizAKRsokpoxhlhTzxFKI8Fic+pxDlIE58TiHKlTjxOYUotzikwNZBOcUotzikKlIx7GMvkHKKUW6kCc0pRrnbA/GDpxjlFolUc1OfexshBxJbBOYUpNwikabWeuIJUowKC0SacSoLilFhgUhzVpJiVFgg0oKVpBgVFocsZiUpRIWFIQM2MxQUokLOdQXFqLBAZOzKWVCMCgtExq6cBcWocLtVNjYLb8NqkcjYlbPwN60Wiixlk0j/EAtbNLIsgtiuSpm3M4y97WusxI1c7G1gY4dWzjlq/wzLahGE/hmWNSIM/TMsm4pA9M+wbCZC0T/DsrkIRv8MyzrgiiiP9V55maV/iIQdr8DP74xyADFlgM86OHKBTwXgEw+OX+AjF3zuwVEMfD4An35wLAMf5+AzEI5o4CMdfBLCUQ15HOkk3ueZ9oQ94BzdkEOUxsleKV/YQ64nI3gwPNwc6SCA4RES4HgHAQzl00UWnJyt2cCjJcCxD2wWB4+YALWAm8dNgKMgBH/w6AlwLISAscdQgCMiBIw9kgIcE5EnbD4Hj6YAx0bw5QF4TAU4PiLng97jKsAREjkf9B5ZAY6TyNndCyQ+02fByTM+XXuUBTheIs+FdO2xFpCI9Qd4tAU4csKwzAF4xAU4ekKYYY+6AEdQSDPsIecoCmmGPeQcSSHMsEdggKMp8iKCAvZedz0GAxxPUbC7OfA4DHBMRQHsCqd9ltYiUyi2Cx5ojqyQuuCh5uiKIuG74KHmCIuCrRzBIzPAURaFiRTE+9Tvr4eaIy2KlJf1UHO0RZFFkOh4r4ucSnukBhj55YbHasACrQEerwELxAZ4zAY4/qLg3hSA8fl1IzJ/4JEb4CgMoeDx6A3o+Q2WWQKP4ABHYvD8H3gEBzgeg2cAweM4wDEZPAcIHssBjsrgWUDwaA5wXAbPA4LHc4CjM3gmEDyqAxyhwXOB4JEd4CgNng2E1H81kop8IHiEBzhag2cEwaM8wDEbBfumySM9wDEbELMvmzzWAxy3wdOC4PEekPXvsNh3Ux7zAY7fgFixsh5sjuGAmH2n47Ef4CgOiLnXOuDRH+BYDq25cscjQMDRHDzrCJn/TisTeUfwWBBwXAfE3MslGHgQ91b4S9l05X3/IQf7fnf8XNe33fAlrpvp80/fdqne3Xz7/n16RWz/z+p2d2qmNmk2tSliKxXtbNXd/4cStdh7U0hLMmnJ01ELjFpiSctwxm1SNJ0W/bZL8qG9yeT2devOaE0aEtQVnQwaUiVo6A/6HPoDRUgJmhWdjUrSRSXNeFoIqUGj0eNoUmk041ft0WxMzdXQehiRCEyvpBl+igchhFxjsekf449NTW3jqa2E5Ni2/0GLqSmgIYA88OrYVSfiyhr1d5i5TO64a/9x/JIaUgNIzTB14vyTY8NoCGgEQ0cGLMZ+Df+fm+Hv8QgWnAOqGOEbZQxIvRiuoyHokBcVY0yNjmB3T7yi4YQ2FyOFQWPqHVNWYD9seLBfTOwxrsd7QJM6XaBZlsY1aJvO7zCKDBppJnn4oMid02F0ZMjTLU+1rMQdIEUTgxvrYrmx/WoB04Ec5Q6781rU0dXLU6uQ9yXy1PY3C5HLIESKszeOvqekQCJHglEaQwlAjy5txNk5H2hEGlB/xGk93/FAeMQYj3EgWnL5crjnTA6JoVlBk5lLwIw6hm9SIFxxX8Rc5r65dOe+udS3w/ZRUstFBTTcSJwhzzJS1AaEK4oyEUWr5t8tRdGgGRBX1Mey4zygQB4AqdT5x7KzX5x+Go+poiwc4+lPpW5bBcO1BWQbDdhuuMSmw7UObBVn/0wKQNu0P/mM3AWvfGphtux52eey6dypTGw6waYld7UK+pvlyM9Qes/HsgPG6FHSKD4d2tYd3kSugjzWjEVhJoXf8JHkL8NHlFEWQ0NJhoVLLOp6LaU9JzmexUSakBckQypKpSTfXz5w4jgXIUj1uJzKOtClThQJyJuzMa0mUlpdXvMQWKJbCwlNo7Zm7IZYJk3X/1BoYP/WkpNVLVOipQiKTAroqj0OH8hBKzSKjGLcLMSiU82cMkPeVIy1WCyOergJTzSgrhdjIQVjV5Tkme4OLkIOFQvZEF35ec9zrvgkbUKi06hvRvLKY//1JzQiXHTEUoS7ZvOFDfsASEiK9RZqXUi5dR7IGk2eGWc+E+eqfOjujn6KTZD769H9xY3vfF1QqH0i+Z9fIibIe88ViVj1Djd82mcvgSQoseoxsaZS/PkpTCG0kyEC0mECsiErZoMDFuddyWjGSKFif0vs41daSeJ+ju37f8Uq8lRTFTlefhMJHqmaxqugkpxz5tMZthlL82oP5AsLjSVk0PIrGR5v6zFMBloikjEZiFXb+ZI8GjnuQDLmlURaIoar8Kg93ssk59pZSinuO7J+hkN+lg15MpdKGcs5+N6D2ksjt80qGhxAKu2Fdm3/w4poOcOoLzUcfqwQ2cRJcGmIL8PvSPpDxZt0sXn/a3loglESHJPAEF1SKnQX7ZhciNDWYz5NpaTmPt2DlnLUOB99VUlR07KFMiF6pAlsF8pdjRVIWaKtKWwFXvfE5dK24niQHPuLljzNtpZ2lGjU+VKf5wkmI74quYxr65MUeKr1ktV6+GU7lJXQLIup2H0h+8F9IRu5KkrE6eBg2ZCVcnHi7bcUfKgLnNK1tIqMnw9EM4aipRi9NJbyysxFNZo2M6ZDI3mq4KYa9d2MlaORIsUqaaerkEgNyjZmTO2ZNIuEJCJBg5KOuDauUUyAHFFJftjVPhmg0HQm4izaremx/7oFcgAc6lpKdNNnaVDA4pbj/g8SaejnjwygbqNUl4x50kh5cvyxV5RnUfNxSR0ytqhk+Mwm8mQ0jGLcoMfSRDhW3V9uAAeRhJpr6S+uaAJEWsI1nK2ugAJQZBH6pvP1FSVqcWVxbaUFFtCk8W+U3ke75+q5PFancndz+/779/8HTW13F1yDAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62dW4/buJKA/8rCedU44lViv82cPQcY7Ozs4mR296ERBE5b6QhxWw1LnZmcIP99IUqyqsiiXLL7KUiLrOLlq2KRJdHfN6fmz3Zzd/9986U+7jd3QpbZ5rh7qjZ3m19ePn2qTv932j0/V6dNtnk5HTZ3m4fDrm2r9i16uv3cPR022fRwc7fZ/MgmmUbIs8yH5th2p5eHruFIfIOLA+nZ5nl3qo5d1MxZrcilPuv96AtxVJ5L3qDta139ydN2Ljlr69r9T3X70/Op6aqHrtqv1n6s/up++dZVHP2g7Lr+ylzPpJyqtv4XS9+55I39jTD9Z7XbJ4d8ePiKkAKBKxgd25gcxN1+YdqgSlD0Nn3/c2zrx2O1Rm9Q5Tb97z43p46peCp7m8Zfj1x9Q8kb+9ed6uMjt4NT4VU6+W4O6iO83GiH9fFzdapJO1zWvej0oG6Gz/u3WxtzwQfC5pAu8Ar9fI+IJ/6iQ7xqMIh1vO4W1qT+4auu4meBqxZx38bEmP7ZP11c2GadsOyNGhk+MtK8wkkyWrDkJSPVHDfJ0Jn2k5HGy46S08clTxl3kuMqI61rIsJZ4VWucln3hfhw1v06rnK5MRfDxbk5V7rK5em/EDzO2l/HVUaNsfNQdM3Pp9Pu2y8YjU8vx4eubo7tW/R80VtKY89S/4C1/uvZizoLr49ddfq0e6jat1S5RSVoGuvHY3Oq/v703H37bfetOq1T8YaqThsX2Z25UWpeJvbVp93LoVvs/9fdqd59PFTt24XSi6MA5u/TqXlansGgBHsO/4HrLcwiXfKV53FByYqZTHRqaS4vjEM0m1eMBhz2X17qQ/frsf8H7u7ASOASy6AYo2bRHz50354rpsg3Hz7Ux3311/ZcK7XwoKpjraTn7f+5qgHbseqaVkxtTzSmbV6O+3/Uh2tbBOvf1ixA3Ud6/mfMcIGfxDJZuSuEkSFdZ7F9O859ZTP6q49un6pjt+AVokJ8h5CihBb5ZpGMuK3X0JDQfJkAtvov1bcViofSN6p8PlVt+x+r9IIq65XHvjUNUuRWV+IENoNzzSjimh/x4fwYmFBC1pu53KWRumLLGSrjbDhJhXghbkP/kNIHS16rDVl5ShHTtvlGnVK0xpQ5NpzSw7Nctsmm1Kww1IST//tfddvVx8e5IOnmiWJsy3zX0OKnTgXPX+WwhpLJMp+wsYkZ2h0OPJ1DwZt0fapPbfe3l7Zrnn71URdLMVFrbSvQbvax6v5ouh2z26D0TVrbKnbnpMKh4E26dvs9c059wZt0PZyqHXEyQWM7lb1J4746VFyN57I3abzvzyN2XXN6z9P6YSr/4RrNwKf53eFCzAqf3x6uRtKWVzPUuOQK/Vvz8KXa89SB0reofNccGq7Csez16r42hxfucJ7LXq+u7apTxezduewqdXHUS1IYBbx8FsGK6itFRuX/+iqr5yyJtWYOzUmZTdNV8ZoPNEwFrpFNxZZQ9EVDZFsgIZ1nd0yDI+VfNjOmfRHSOVbFNCdCOseIFsLF4IAQLhvDo1cLEoE4dnw4tm5laAg1XYoKIw38UAyqYUVhy7oWAhU0dJdjlGU9qeALjdqFuGtZw0IABJUwYp9lPRfCHqiLGfHE+ogN3O/IzxJbN19g3RLze9p3X5a2arGZxfFXnKF1K6ww1LRkhaQGnhWGai5aIa3LSqE10lY/fLk4G29AwWt7Rm26QjVL+63LGihrj2Znwdova0j4rQi2Zb91WU/Cq4R6LniVy3oWvEqoi+FVaH3Aq/TPFnZQ4DF/A5U4+w5lLZ6dwXalQp/q0DzUHU8XKHy1wufd8Qhf8VjSN5e9Xl3dPXzmKRtLrlEV72MoFKJtDBsIsMT0dSKY+z++yrJyFsRaUHxbUpF6OrMwK0GF1uugzpRn4Zcsgm0KsWiWAXDJj8VzeOeBTsi+iHfCufUx1c8vXfNu95U8goDP+e6tOvYWQZ7ZRALfzIXTYd+5iUkuu+r0FQQgixpB6VUqw4H7rWmeUxr7Z682YGdhrMHyzUpuV3cnHxRdVgWLXqes60O9vgC5cGJtqCxbXeyiI5gj/8zCmTjDgpMdn11dnO5gW09uiF5tK79uE78Q1v9WHR+72PPMOmAZlobAK5/auomzr7P8ucR66eSZ2Cx68UhsSe7upfu8OPDnAutlN6f6sT7uDj9f0hEVXK9rX7UPp9qHKguKcKn1Wuqn5+bU/b48F6jQeh0HaJyx9PHxVTONvQk511OR9fKf6uNLV7XvnqmIatYRFLtifKpP3d8O5KYZjBIstF7HqX78fFkJLrVey8dD8/Cl/Xm/Jw6kZy241LVa/lk9NV8ZeuZyV/nYf3857S7YIC51nSfftd1/Vrv25bREc1Rw/dh19VP1rn487rplVWG5q3r1R/X0HJ++o/5MRdbLby/Lb2+R78+nnqr/rk4oIqN7gQpe1xeWrqjgel2fd3RCZ1Yyl7hiPbnw/ky4Cb3OzxzSaZfRWy6/dx3IBi+wN091R736Pb/AHpSgosL32WZ47fju+zmIutvIrdq6Tbb5VFeHff/J9xQCPTRP43583zwMW/P3Y7H/rfr4sC88lH6bb7L7PLN6a6x5/z67nyr7B/4Pk4z5L76i2GT3IpN2a41DFUVUUaCKcpPdy0yXW6dwRRlVlKii2mT3iqqooooKVdSb7F5TFXVUUaOKZpPdm0ybrSg0qmiiigZVtJvs3lKjaqOKFlUsUqNaRBULVLHcZPdFZsxWaYkqllHFElV0m+y+pCq6qKLDAPQ8OKqmiNkRATyenpysTPCDARI9FkKQlWOGBIZIqBR+IsZIYI6EThEoYpIERkmYFIQihklgmoRNcShingQGSniiJMWiiJkSGCpRJo08xkpgrkRPi1DkLMVoCcyW7HERmqosY7gkhkt6uAxZOYZLBt7Jw2XJyoSDwnDJnhdBmqGM6ZKYLqmTjjGmS2K6pEmRKWO6JKZL2hSZMqZLYrpkkSJTxnBJDJf0cPWuR221KHHtGC+J8ZIeL5c5uZXK4soxXhLjpXpgZJ4ZtVVC4bUkxkthvFQPjBSZyMVWY80qxkthvJRf/WQmpVBbWwhcPQZMBUug916K6rUiVkEMmNLpXseEKUyY6qGRmux1jJjCiKmeGmkyIdU2DzTHjCnMmOqxkTbTdisCTFQMmcKQqZ4aWWQ635YuGO2YMYUZUz01siRDjpgxhRnT+dhnZbZK4U7rGDKNIdMeMkeNmI4h0xgy3UOj8kyocqsMtksdM6YxY1olh0zHjOkg1NLJIdNEtIUZ096Lid6d2AK7Tx0zpjFjuqdGSYpuHTOmMWO6p0apTBi5FUGzY8Y0Zkz31CidlVZsZY4J1TFkGkOm3TDTVLtjyDSGzOSpBdrEiBmMmOmhUSYzbusCSEyMmMGIGZmExMSEGUyYUUlITEyYwYQZnYTExISZIKA3SUgMEdNjwownzJILlokRMxgx4xErMuHU1jrsQU3MmMGMmWQkZmLCDCbM9MwoerhjwgwmzPbQKEdRYmPELEbM9tDonIoPbIyYxYjZHhotMu22UuCJtjFiFiNme2i0JDXHiFmMmPUbRkVWjhGzGDHrA31NVo4Rs8G+0cdiZEBlia0jJsz2yGhLun0bE2YxYTa9UtoYMYsRsz00uqDsysaIWYxY0UOjS6pyESNWYMQKjxjpPosYsQIjVvTQGDIiKmLECoxY0UNjBLVmFDFiBUas6KExMnO23OoSD3cRM1ZgxgqTPCaIESswYoXfTCrKoIsYsSI4niiSkBTECQUmrCiTkBQxYQUmrHBpSGLCCkxYmSchKWPCSkxYKZKQlDFhJSas9ITprCj0tijx/ruMESsxYqVKzXMZE1Ziwkqd9PplDFiJAStN0nGXMWElJqy0SfdZxoSVmLCySDruMiasDA7ByqTvLYlzMExY6ZK+t4wJKzFhrmfGmEwLs80tpsTFiDmMmPOI2cyUYpuXeLJczJjDjDmZosTFhDlMmFNJSlyMmMOIOZ2kxMWIOYyY84erBbWtczFiDiPmbDI2cDFiDiPm0oi5GDGHEXNlEm4XI+aCs1aX5NMRx63heWueBHR4hquDv431PWUlGR8MD0MBwblrLpOh9/AsrB8cveZ+xSTd8PAsrB8cv+Y9QZb0xMOzsH5wBJv3EFlB1ydOYfPgGDb3x/qSWvGHZ2H94Cg271Gyilz0h4ehgOA4Nk+fx+bEgWwenMjmbtiokv0nzmTzAEB/iJ+Yf+rMPzr0F+n5J4/9A/78UX5i/qmT//Do3x/nJ+afOv0Pj//9kb7VmSj1VhehAALAMAfgz/WtoRtAABjmAfzZvrVU7CaoVECYC/DH+7ZIdIAAMMwH+DP+VAcIAsOcgD/mtyXdAYLAIC0g/Em/JXejgkgMiCAzIPxhf5FnMpdbF6aOCAKD5IDw5/2FoOtTuaeAQH/kX8hMSCe2KjgrEkSOQARJAuEP/mkXQKQJRJAnEP7sv6CzMkSqQAS5AuHP/wtNTwBBYJAvEDK9gRBEykAEOQPhswAFeWgliKSBCLIGwicCCtqCiLyBCBIHwucCioKsT6QORJA7ED4dUNAGQGQPRJA+ED4fUNAGQKQPRJA/ED4lUOZ0fSoBGuDnswKloOsT/AVZBOETA6Wk6xP8BYkE4XMDJbl7FUQqQQS5BOHTAyXNL5FNEEE6QfgMQUnzRyQURJBRED5JUJLpRUHkFESQVBA+TVCSGUZBZBVEkFYQPlNQ0vwRiQURZBaEzxWUdNafSC2IILcgfLrA0Yl/IrsggvSC8BkDR+f+iQSDCDIMwicNnKTrE/wFSQbh8waO9p9EmkEEeQbhUweO5o/INIgg1SB88sDR/BG5BhEkG4TPHziaPyLdMP3Nv4D0tTp11X64U6d/f2i6OfH7ZrwU8U6ev5j4vlHF5u77jx/z20h333+AF5L6Z70q/7HjLEHLWYJVQ52yGP51TIn9x62zRFXOEo0bJepRouJJHF+6noUWZhbarzFMKU3rXx2e5ZQ5kKN4rRneQt0Nb7sCURqK4g3VIOo0vdAKhMH+KV7/pluVAQ6zEDlUEuOUSr1C5Gn8IYhZMMDMrhD05/TDJ7MkMP75KknD1euzIAE6K5ij318xVx/RiLlZihZDPe3WSPs4XawJhILJVHYUyust+qYEdBb0dag5mqgoh39NPv47/r8wo+GN8+8mHvKxgGASMX22DDyGAjCMdl2OvXQ8cseveigDLaCBSrFGXH8x8a6/KHdAppm+JAUTA0xWmTWy5/ddCbEKjIjmoTiK9W+5EhINmPCC56Umif5bDDCeEB0p14jqr8sh2mah4eU8dzBK7JoL8wMaq7hzP3zuDvgEk2wnMxipdzzTRt/kgLEsoJPmGfT5i0IwgNDXi7GFQvBMpxrv2EAvYAMUgac2vLmZJI63IwEIQTsdr7f+KsAHfxXgIAQ2DbhayxSHLRqhAihUPKwZ/gEYMjM4eKy6/fnTEbCeW4gKj7rHqjvs2u5p+jgESIPgMVeSXtr45SAgWEFvwPOAj1XXDd9ggAY52CDe8Pdyhu+SAGKgY47fnPqpeq5Onf+AYhbmoKvTvOWtlzbcmAIcCFiC7LjclqOZOp7Yz7u29R9ggNbBodc80xzuoa/6bxWm7yEArKCZalz+Fa95w+eAvjKEo4TM8twvvIwAmDpwwXoKOHKeFSyvtKDPTOwSjtLB6J25aM8ftgNnDg1dMKe1JSJRBbytYQ5+exivhQPwAouy4+6r4C0tdcSsBkQUI2IFcxrHm2GQONBFO0aMpZvw4Lk1f0EFGDVg83q0UaMnkVPQK3iyD8Nlh8A9gUWm4JmWlxEvpYASx5vcVGio4V6Mx23sOxwMQTQPj/771YdD6MFLGA0yY+ooRoWrCXMxH7/ZbZ8D11PCRYDpDkNHKIENqdF96XEjZUam7LTRmjZikjcX/e//fPwWRKyA4VHaiLLkOZRjgwVauNbkzIbR0b6Bi0LOQzfGH7Sn4HWp/0gvsfA56HKZm/Xpc37iZAlKkzxp57tmwJDDfWs+TaPgwTzeLwOkQYrz8xaBF5L6q9pDPwnMVI+u1/CstT8NCokFBsJzHr2QGluqgCPGA6uX0g4/zgZwgEPFFzP+/BloD9opswW9jL9TFw4RsBseVNNvcwGzARHBiMA4dUxn428DIHw2dA+KZ4/+Fj7gssBg2dElOrakaD/hIAuah3mb3gjANUnzKG8bTEMBZUhmi5rjI3WmZWGsKXhrUi8rtccH1md4IPTSYkdqQLtKHvFeULB8W7g7ZR7F+l/H+OR/HQOsu8Bm1BgX6tGVGuYU9LcqhTxYuIYJnjVO1wqD0QKMFiPyJc9v9Zy2810MwBJhyzRTWJM4EhFAGDNFculATgDnylwb/Xb6MNw0BaYAemnJc9PzhXFgEpC3V9PCyBu582VHwMyhaTKjrekXJYFFAm7HJo3YMs9YpiuygYMFHS2mQwjeuPlcSbgcCejzeTPp5YSLNoiWmKfJXky0aguwuDGP+QdB8boN3A/TUXtJqYVbACQ4pL7PNs/1c3Woj9Xm7v79jx//D6uYYn8SgAAA"; \ No newline at end of file diff --git a/docs/dev/assets/style.css b/docs/dev/assets/style.css index 778b949..9d619a6 100644 --- a/docs/dev/assets/style.css +++ b/docs/dev/assets/style.css @@ -10,6 +10,7 @@ --light-color-text: #222; --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; @@ -35,6 +36,7 @@ --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-color-document: #000000; --light-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; @@ -50,6 +52,7 @@ --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; @@ -75,6 +78,7 @@ --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-color-document: #ffffff; --dark-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; @@ -92,6 +96,7 @@ --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -116,6 +121,7 @@ --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); + --color-document: var(--light-color-document); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -134,6 +140,7 @@ --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -158,6 +165,7 @@ --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); + --color-document: var(--dark-color-document); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); @@ -183,6 +191,7 @@ body { --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -207,6 +216,7 @@ body { --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); + --color-document: var(--light-color-document); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -223,6 +233,7 @@ body { --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -247,11 +258,17 @@ body { --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); + --color-document: var(--dark-color-document); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + .always-visible, .always-visible .tsd-signatures { display: inherit !important; @@ -266,16 +283,6 @@ h6 { line-height: 1.2; } -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -306,10 +313,6 @@ h6 { margin: 2.33rem 0; } -.uppercase { - text-transform: uppercase; -} - dl, menu, ol, @@ -333,7 +336,7 @@ footer { padding-bottom: 1rem; max-height: 3.5rem; } -.tsd-generator { +footer > p { margin: 0 1em; } @@ -421,6 +424,9 @@ a.external[target="_blank"] { background-repeat: no-repeat; padding-right: 13px; } +a.tsd-anchor-link { + color: var(--color-text); +} code, pre { @@ -580,13 +586,13 @@ dl.tsd-comment-tag-group p { } .tsd-filter-input { display: flex; - width: fit-content; width: -moz-fit-content; + width: fit-content; align-items: center; - user-select: none; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } .tsd-filter-input input[type="checkbox"] { @@ -609,11 +615,8 @@ dl.tsd-comment-tag-group p { 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-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); } .tsd-checkbox-background { fill: var(--color-accent); @@ -630,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { stroke: var(--color-accent); } -.tsd-theme-toggle { - padding-top: 0.75rem; +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; } -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; } .tsd-hierarchy { @@ -769,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding: 0; max-width: 100%; } +.tsd-navigation .tsd-nav-link { + display: none; +} .tsd-nested-navigation { margin-left: 3rem; } @@ -782,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } +.tsd-page-navigation-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} .tsd-page-navigation ul { padding-left: 1.75rem; } @@ -812,10 +832,10 @@ a.tsd-index-link { } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } @@ -828,8 +848,9 @@ a.tsd-index-link { padding-top: 0; padding-bottom: 0; } -.tsd-index-accordion .tsd-accordion-summary > svg { +.tsd-accordion .tsd-accordion-summary > svg { margin-left: 0.25rem; + vertical-align: text-top; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -877,7 +898,7 @@ a.tsd-index-link { } .tsd-panel-group { - margin: 4rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group { margin: 2rem 0; @@ -885,6 +906,9 @@ a.tsd-index-link { .tsd-panel-group.tsd-index-group details { margin: 2rem 0; } +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} #tsd-search { transition: background-color 0.2s; @@ -1034,6 +1058,12 @@ a.tsd-index-link { border-width: 1px 0; transition: background-color 0.1s; } +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} .tsd-description .tsd-signatures .tsd-signature { border-width: 1px; } @@ -1347,6 +1377,12 @@ img { .has-menu .tsd-navigation { max-height: 100%; } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } } /* one sidebar */ diff --git a/docs/dev/classes/BufferReader.html b/docs/dev/classes/BufferReader.html index 80cac18..527eb27 100644 --- a/docs/dev/classes/BufferReader.html +++ b/docs/dev/classes/BufferReader.html @@ -1,4 +1,4 @@ -BufferReader | nbs.js - v6.0.0-beta2

Class BufferReaderInternal

Represents an ArrayBuffer reader.

-

Hierarchy (view full)

Properties

buffer +

Class BufferReaderInternal

Represents an ArrayBuffer reader.

+

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

readByte @@ -166,21 +166,21 @@ readString readUnsignedByte resize -

Constructors

constructor -

Properties

Readonly buffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protected viewer

viewer: DataView

Data view for the buffer.

-

Methods

readByte

readInt

readShort

readString

readUnsignedByte

  • readUnsignedByte(): number

  • Read the next unsigned byte.

    -

    Returns number

Protected resize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    +

Constructors

constructor +

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

+

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

readByte

readInt

readShort

readString

readUnsignedByte

  • readUnsignedByte(): number

  • Read the next unsigned byte.

    +

    Returns number

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

buffernextByteviewerreadBytereadIntreadShortreadStringreadUnsignedByteresizeconstructor
\ No newline at end of file + diff --git a/docs/dev/classes/BufferWrapper.html b/docs/dev/classes/BufferWrapper.html index 308f741..1901f71 100644 --- a/docs/dev/classes/BufferWrapper.html +++ b/docs/dev/classes/BufferWrapper.html @@ -1,4 +1,4 @@ -BufferWrapper | nbs.js - v6.0.0-beta2

Class BufferWrapperInternal

A buffer object wrapper.

-

Hierarchy (view full)

Properties

buffer +

Class BufferWrapperInternal

A buffer object wrapper.

+

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

resize

Constructors

constructor -

Properties

Readonly buffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protected viewer

viewer: DataView

Data view for the buffer.

-

Methods

Protected resize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    +

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

+

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

buffernextByteviewerresizeconstructor
\ No newline at end of file + diff --git a/docs/dev/classes/BufferWriter.html b/docs/dev/classes/BufferWriter.html index 823c90b..2f85507 100644 --- a/docs/dev/classes/BufferWriter.html +++ b/docs/dev/classes/BufferWriter.html @@ -1,4 +1,4 @@ -BufferWriter | nbs.js - v6.0.0-beta2

Class BufferWriterInternal

Represents an ArrayBuffer writer.

-

Hierarchy (view full)

Properties

buffer +

Class BufferWriterInternal

Represents an ArrayBuffer writer.

+

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

writeByte @@ -167,18 +167,18 @@ writeUnsignedByte resize

Constructors

constructor -

Properties

Readonly buffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protected viewer

viewer: DataView

Data view for the buffer.

-

Methods

writeByte

  • writeByte(value?): void

  • Write a byte.

    -

    Parameters

    • value: number = 0

    Returns void

writeInt

  • writeInt(value?): void

  • Write an integer.

    -

    Parameters

    • value: number = 0

    Returns void

writeShort

  • writeShort(value?): void

  • Write a short.

    -

    Parameters

    • value: number = 0

    Returns void

writeString

  • writeString(value?): void

  • Write a string.

    -

    Parameters

    • value: string = ""

    Returns void

writeUnsignedByte

  • writeUnsignedByte(value?): void

  • Write an unsigned byte.

    -

    Parameters

    • value: number = 0

    Returns void

Protected resize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    +

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

+

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

writeByte

  • writeByte(value?): void

  • Write a byte.

    +

    Parameters

    • value: number = 0

    Returns void

writeInt

  • writeInt(value?): void

  • Write an integer.

    +

    Parameters

    • value: number = 0

    Returns void

writeShort

  • writeShort(value?): void

  • Write a short.

    +

    Parameters

    • value: number = 0

    Returns void

writeString

  • writeString(value?): void

  • Write a string.

    +

    Parameters

    • value: string = ""

    Returns void

writeUnsignedByte

  • writeUnsignedByte(value?): void

  • Write an unsigned byte.

    +

    Parameters

    • value: number = 0

    Returns void

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

buffernextByteviewerwriteBytewriteIntwriteShortwriteStringwriteUnsignedByteresizeconstructor
\ No newline at end of file + diff --git a/docs/dev/classes/Instrument.html b/docs/dev/classes/Instrument.html index cae17c7..3b73451 100644 --- a/docs/dev/classes/Instrument.html +++ b/docs/dev/classes/Instrument.html @@ -1,4 +1,4 @@ -Instrument | nbs.js - v6.0.0-beta2

Class Instrument

Represents an instrument of a Note.

-

Example


import { Instrument, Song } from "@encode42/nbs.js";

const instrument = new Instrument({
    "name": "Sandple",
    "soundFile": "sand.ogg" // Just a string in nbs.js, no IO is performed
});

// Note Block Studio's built-in instruments are provided
console.dir(Instrument.builtIn);

// You'll want to add that instrument to a song, otherwise it won't do much!
const song = new Song();
song.instruments.add(instrument);

+
Class Instrument
Represents an instrument of a Note.

+
Example

import { Instrument, Song } from "@nbsjs/core";

const instrument = new Instrument({
	"name": "Sandple",
	"soundFile": "sand.ogg" // Just a string in nbs.js, no IO is performed
});

// Note Block Studio's built-in instruments are provided
console.dir(Instrument.builtIn);

// You'll want to add that instrument to a song, otherwise it won't do much!
const song = new Song();
song.instruments.add(instrument);

 

-
Properties
builtIn
+
+
Properties
builtIn
 isBuiltIn
 key
 name?
 pressKey
 soundFile
 
Constructors
constructor
-
Properties
Static Readonly builtIn
builtIn: BuiltIn = ...
Instruments built into Note Block Studio.

-
Readonly Internal isBuiltIn
isBuiltIn: boolean = false
Whether the instrument is a built-in instrument.

-
key
key: number = defaultInstrumentOptions.key
Key of the sound file.

-
Remarks
Just like note blocks, this ranges from 0-87.

-
See
Note#key

-
Optional name
name?: string
Name of the instrument.

-
pressKey
pressKey: boolean = defaultInstrumentOptions.pressKey
Whether the on-screen piano should visually press keys when these notes are played.

-
soundFile
soundFile: string
Sound file of the instrument.

-
Remarks
Relative to the Data/Sounds/ directory of Note Block Studio installations.

-
See
This property is not used within nbs.js for anything other than storage.

+
 Properties
Static ReadonlybuiltIn
builtIn: BuiltIn = ...
Instruments built into Note Block Studio.

+
Readonly InternalisBuiltIn
isBuiltIn: boolean = false
Whether the instrument is a built-in instrument.

+
key
key: number = defaultInstrumentOptions.key
Key of the sound file.

+
Remarks
Just like note blocks, this ranges from 0-87.

+
See
Note#key

+
Optionalname
name?: string
Name of the instrument.

+
pressKey
pressKey: boolean = defaultInstrumentOptions.pressKey
Whether the on-screen piano should visually press keys when these notes are played.

+
soundFile
soundFile: string
Sound file of the instrument.

+
Remarks
Relative to the Data/Sounds/ directory of Note Block Studio installations.

+
See
This property is not used within nbs.js for anything other than storage.

 
It only exists to work with other applications that implement functionality.

-
Constructors
constructor
 Constructors
constructor
Settings
Member Visibility
Theme
On This Page
builtInisBuiltInkeynamepressKeysoundFileconstructor

\ No newline at end of file
+        
diff --git a/docs/dev/classes/Layer.html b/docs/dev/classes/Layer.html
index 21c7a40..6dabc26 100644
--- a/docs/dev/classes/Layer.html
+++ b/docs/dev/classes/Layer.html
@@ -1,4 +1,4 @@
-Layer | nbs.js - v6.0.0-beta2
Class Layer
Represents a layer.

-
Example

import { Layer } from "@encode42/nbs.js";

const layer = new Layer({
    "name": "Demo"
});

// The "notes" property provides helper functions such as...
layer.notes.add(0, 0, {
    "key": 42
});

layer.notes.add(8, 0, {
    "key": 24
});

// Deletes the note on tick 8 (which was just added)
layer.notes.delete(8);

// These properties are only used in Note Block Studio and do not affect the functions above
layer.isSolo = true;
layer.isLocked = true;

+
Class Layer
Represents a layer.

+
Example

import { Layer } from "@nbsjs/core";

const layer = new Layer({
	"name": "Demo"
});

// The "notes" property provides helper functions such as...
layer.notes.add(0, 0, {
	"key": 42
});

layer.notes.add(8, 0, {
	"key": 24
});

// Deletes the note on tick 8 (which was just added)
layer.notes.delete(8);

// These properties are only used in Note Block Studio and do not affect the functions above
layer.isSolo = true;
layer.isLocked = true;

 

-
Properties
isLocked
+
+
Properties
isLocked
 isSolo
 name
 notes
 stereo
 volume
 
Constructors
constructor
-
Properties
isLocked
isLocked: boolean = defaultLayerOptions.isLocked
Whether this layer has been marked as locked.

-
See
This property is not used within nbs.js for anything other than storage.

+
 Properties
isLocked
isLocked: boolean = defaultLayerOptions.isLocked
Whether this layer has been marked as locked.

+
See
This property is not used within nbs.js for anything other than storage.

 
It only exists to work with other applications that implement functionality.

-
isSolo
isSolo: boolean = defaultLayerOptions.isSolo
Whether this layer has been marked as solo.

-
See
This property is not used within nbs.js for anything other than storage.

+
isSolo
isSolo: boolean = defaultLayerOptions.isSolo
Whether this layer has been marked as solo.

+
See
This property is not used within nbs.js for anything other than storage.

 
It only exists to work with other applications that implement functionality.

-
name
name: string = defaultLayerOptions.name
Name of the layer.

-
notes
notes: LayerNotes = ...
Array of every note in the layer.

-
stereo
stereo: number = defaultLayerOptions.stereo
How much this layer is panned to the left or right.

-
Example
-100 is 2 blocks right, 0 is center, 100 is 2 blocks left.
-

-
volume
volume: number = defaultLayerOptions.volume
Volume percentage of the layer.

-
Constructors
constructor
Settings
Member Visibility
Theme
On This Page
isLockedisSolonamenotesstereovolumeconstructor

\ No newline at end of file
+        
diff --git a/docs/dev/classes/LayerNotes.html b/docs/dev/classes/LayerNotes.html
index d2a8ef2..e268a4d 100644
--- a/docs/dev/classes/LayerNotes.html
+++ b/docs/dev/classes/LayerNotes.html
@@ -1,4 +1,4 @@
-LayerNotes | nbs.js - v6.0.0-beta2
Class LayerNotes
Represents the Notes of a Layer with helper methods.

-
Example

import { readFileSync, writeFileSync } from "node:fs";
import { fromArrayBuffer, toArrayBuffer } from "@encode42/nbs.js";

// Read a NBS file named "song.nbs"
const originalFile = readFileSync("song.nbs");
const originalBuffer = new Uint8Array(originalFile).buffer;
const song = fromArrayBuffer(originalBuffer);

// "get" is a getter function and should be cached during these operations
const instruments = song.instruments.get;

for (const layer of song.layers) {
    // Every layer
    for (const [tick, note] of layer.notes) {
        // Every note in the layer
        const songInstrument = instruments[note.instrument];
        console.log(`Note on layer ${layer.name}, tick ${tick}, is a ${songInstrument.name}`);

        note.key++;
        console.log(`The note's key has been increased to ${note.key}`);

        // Delete notes above or below the octave limit
        if (note.key < 33 || note.key > 57) {
            layer.notes.delete(tick);
        }
    }

    console.log(`There are now ${layer.notes.total} notes in this layer.`);
}

// Done transforming! Write the result to "transformed.nbs"
const exportedBuffer = toArrayBuffer(song);
writeFileSync("transformed.nbs", new Uint8Array(exportedBuffer));

+
Class LayerNotes
Represents the Notes of a Layer with helper methods.

+
Example

import { readFileSync, writeFileSync } from "node:fs";
import { fromArrayBuffer, toArrayBuffer } from "@nbsjs/core";

// Read a NBS file named "song.nbs"
const originalFile = readFileSync("song.nbs");
const originalBuffer = new Uint8Array(originalFile).buffer;
const song = fromArrayBuffer(originalBuffer);

// "get" is a getter function and should be cached during these operations
const instruments = song.instruments.get;

for (const layer of song.layers) {
	// Every layer
	for (const [tick, note] of layer.notes) {
		// Every note in the layer
		const songInstrument = instruments[note.instrument];
		console.log(`Note on layer ${layer.name}, tick ${tick}, is a ${songInstrument.name}`);

		note.key++;
		console.log(`The note's key has been increased to ${note.key}`);

		// Delete notes above or below the octave limit
		if (note.key < 33 || note.key > 57) {
			layer.notes.delete(tick);
		}
	}

	console.log(`There are now ${layer.notes.total} notes in this layer.`);
}

// Done transforming! Write the result to "transformed.nbs"
const exportedBuffer = toArrayBuffer(song);
writeFileSync("transformed.nbs", new Uint8Array(exportedBuffer));

 

-
Properties
all
+
+
Properties
all
 
Methods
[iterator]
 add
 create
@@ -168,28 +169,29 @@
 set
 
Accessors
getTicks
 
Constructors
constructor
-
Properties
Readonly all
all: ExistingNotes = {}
Tick-note pair of every note in the layer.

-
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

-
Methods
[iterator]
  • [iterator](): Iterator<[number, Note], any, undefined>
  • Iterate each tick-note pair.
    
-
    Returns Iterator<[number, Note], any, undefined>
    Example
    This is intended for use in for loops.
    
-
    for (const [id, note] in layer.notes) { ... }
-
    
-
add
  • add(tick, note): Note
  • Create and add a Note to a tick.
    
+
 Properties
Readonlyall
all: ExistingNotes = {}
Tick-note pair of every note in the layer.

+
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

+
 Methods
[iterator]
  • [iterator](): Iterator<[number, Note], any, any>
  • Iterate each tick-note pair.
    
+
    Returns Iterator<[number, Note], any, any>
    Example
    This is intended for use in for loops.
    
+
    for (const [id, note] in layer.notes) { ... }
+
    
+
+
add
create
  • create(tick, instrument, options?): Note
  • Create and add a Note to a tick.
    
+
Returns Note
create
  • create(tick, instrument, options?): Note
  • Create and add a Note to a tick.
    
 
    Parameters
    • tick: number
      Tick to set the note at
      
 
    • instrument: number
      The ID of the instrument for the note to use.
      
 
    • options: NoteOptions = defaultNoteOptions
      Options for the note
      
-
    Returns Note
delete
  • delete(tick): void
  • Delete a Note at the specified tick.
    
+
Returns Note
delete
  • delete(tick): void
  • Delete a Note at the specified tick.
    
 
    Parameters
    • tick: number
      Tick to remove the note from
      
-
    Returns void
getTotal
set
  • set(tick, note): Note
  • Set an existing Note at the specified tick.
    
+
Returns void

getTotal

set

  • set(tick, note): Note

  • Set an existing Note at the specified tick.

    Parameters

    • tick: number

      Tick to set the note on

    • note: Note

      Note to set on tick

      -

    Returns Note

    Remarks

    Any existing note at the same tick as the added note will be overwritten.

    -

Accessors

getTicks

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

all[iterator]addcreatedeletegetTotalsetgetTicksconstructor
\ No newline at end of file + diff --git a/docs/dev/classes/Note.html b/docs/dev/classes/Note.html index 52a1d0e..1911266 100644 --- a/docs/dev/classes/Note.html +++ b/docs/dev/classes/Note.html @@ -1,4 +1,4 @@ -Note | nbs.js - v6.0.0-beta2

Class Note

Represents a note.

-

Example


import { Note } from "@encode42/nbs.js";

// Instrument ID 0 is always harp
new Note(0, {
    "key": 42,
    "velocity": 80
});

new Note(0, {
    "key": 42,
    "velocity": 20,
    "panning": 50
});

// Notes do not have tick information tied to them!
// This is stored within the layer's "notes" object

+
Class Note
Represents a note.

+
Example

import { Note } from "@nbsjs/core";

// Instrument ID 0 is always harp
new Note(0, {
	"key": 42,
	"velocity": 80
});

new Note(0, {
	"key": 42,
	"velocity": 20,
	"panning": 50
});

// Notes do not have tick information tied to them!
// This is stored within the layer's "notes" object

 

-
Properties
instrument
+
+
Properties
instrument
 key
 panning
 pitch
 velocity
 
Constructors
constructor
-
Properties
instrument
instrument: number = 0
ID of the instrument used by the note.

-
key
key: number = defaultNoteOptions.key
Key of the note block.

-
Remarks
From 0 to 87. 33 to 57 is within the 2-octave limit.

-
Example
0 is A0 and 87 is C8.
-

-
panning
panning: number = defaultNoteOptions.panning
Stereo position of the note block.

-
Remarks
From -100 to 100.

-
Example
0 means center panning.
-

-
pitch
pitch: number = defaultNoteOptions.pitch
Fine pitch of the note block.

-
Remarks
The max in Note Block Studio is limited to -1200 and +1200.

-
Example
0 designates no fine-tuning. ±100 cents is a single semitone difference.
-

-
velocity
velocity: number = defaultNoteOptions.velocity
Velocity (volume) of the note block.

-
Remarks
From 0% to 100%.

-
Constructors
constructor
  • new Note(instrument, options?): Note
  • Construct a new note.
    
+
 Properties
instrument
instrument: number = 0
ID of the instrument used by the note.

+
key
key: number = defaultNoteOptions.key
Key of the note block.

+
Remarks
From 0 to 87. 33 to 57 is within the 2-octave limit.

+
Example
0 is A0 and 87 is C8.
+

+
+
panning
panning: number = defaultNoteOptions.panning
Stereo position of the note block.

+
Remarks
From -100 to 100.

+
Example
0 means center panning.
+

+
+
pitch
pitch: number = defaultNoteOptions.pitch
Fine pitch of the note block.

+
Remarks
The max in Note Block Studio is limited to -1200 and +1200.

+
Example
0 designates no fine-tuning. ±100 cents is a single semitone difference.
+

+
+
velocity
velocity: number = defaultNoteOptions.velocity
Velocity (volume) of the note block.

+
Remarks
From 0% to 100%.

+
 Constructors
constructor
  • new Note(instrument, options?): Note
  • Construct a new note.
    
 
    Parameters
    • instrument: number
      ID of the instrument used by the note.
      
 
    • options: NoteOptions = defaultNoteOptions
      Options for the note
      
-
    Returns Note
Settings
Member Visibility
Theme
On This Page
instrumentkeypanningpitchvelocityconstructor

\ No newline at end of file
+        
diff --git a/docs/dev/classes/Song.html b/docs/dev/classes/Song.html
index 42d7f77..d74821d 100644
--- a/docs/dev/classes/Song.html
+++ b/docs/dev/classes/Song.html
@@ -1,4 +1,4 @@
-Song | nbs.js - v6.0.0-beta2
Class Song
Represents a note block song with helper methods.

-
Example

import { Note, Song } from "@encode42/nbs.js";

// Create the song
const song = new Song();
song.name = "Hello";
song.description = "World!";

// Add a layer and a note
const layer = song.layers.create();
const note = new Note(0, {
    "key": 42
});

// Add the note to the layer
layer.notes.set(0, note);

// Alternatively, create a note directly on the layer
layer.notes.add(4, 0, {
    "key": 24
});

console.dir(song.layers);

+
Class Song
Represents a note block song with helper methods.

+
Example

import { Note, Song } from "@nbsjs/core";

// Create the song
const song = new Song();
song.name = "Hello";
song.description = "World!";

// Add a layer and a note
const layer = song.layers.create();
const note = new Note(0, {
	"key": 42
});

// Add the note to the layer
layer.notes.set(0, note);

// Alternatively, create a note directly on the layer
layer.notes.add(4, 0, {
	"key": 24
});

console.dir(song.layers);

 

-
Properties
author?
+
+
Properties
author?
 autoSave
 blocksAdded
 blocksRemoved
@@ -175,8 +176,6 @@
 rightClicks
 timeSignature
 version
-#tempo
-#timePerTick
 
Methods
getDuration
 getLastMeasure
 getLength
@@ -186,49 +185,48 @@
 setTempo
 setTimePerTick
 
Constructors
constructor
-
Properties
Optional author
author?: string
Author of the song.

-
Readonly autoSave
autoSave: SongAutoSave = ...
Auto-save options for the song.

-
See
SongAutoSave

-
blocksAdded
blocksAdded: number = 0
Number of times the user has added a note block.

-
Remarks
This value does not update when methods such as LayerNotes#add is used!

-
blocksRemoved
blocksRemoved: number = 0
Number of times the user have removed a note block.

-
Remarks
This value does not update when methods such as LayerNotes#delete is used!

-
Optional description
description?: string
Description of the song.

-
Optional importName
importName?: string
Imported MIDI/Schematic file name.

-
Readonly instruments
instruments: SongInstruments = ...
Instruments of the song.

-
Readonly layers
layers: SongLayers = ...
Layers within the song.

-
leftClicks
leftClicks: number = 0
Number of times the user has left-clicked on the song.

-
Remarks
This value does not update when methods such as LayerNotes#add is used!

-
Readonly loop
loop: SongLoop = ...
Looping options for the song.

-
See
SongLoop

-
minutesSpent
minutesSpent: number = 0
Number of minutes spent on the song.

-
Remarks
This value is not updated by nbs.js!

-
Optional name
name?: string
Name of the song.

-
Optional originalAuthor
originalAuthor?: string
Original author of the song.

-
rightClicks
rightClicks: number = 0
Number of times the user has right-clicked on the song.

-
Remarks
This value does not update when methods such as LayerNotes#delete is used!

-
timeSignature
timeSignature: number = 4
Time signature of the song.

-
Remarks
From 2 to 8.

-
Example
If this is 3, then the signature is 3/4.
-

-
version
version: number = 5
Version of NBS the song has been made with.

-
Remarks
Currently, this does not affect the exported song structure properly, and should always be upgraded to 5.

-
See
https://opennbs.org/nbs

-
Private #tempo
#tempo: number = 10
Tempo of the song in ticks per second.

-
Private #timePerTick
#timePerTick: number = 100
Amount of milliseconds each tick takes.

-
Methods
getDuration
  • getDuration(): number
  • Playtime of the song in milliseconds.
    
-
    Returns number
    Remarks
    This currently does not support Note Block Studio's unofficial tempo changer layer.
    
-
getLastMeasure
  • getLastMeasure(): number
  • Tick of the last measure of the song.
    
-
    Returns number
getLength
  • getLength(): number
  • Length of the song in ticks.
    
-
    Returns number
getTempo
  • getTempo(): number
  • Tempo of the song in ticks per second.
    
-
    Returns number
getTimePerTick
  • getTimePerTick(): number
  • Amount of milliseconds each tick takes.
    
-
    Returns number
hasSolo
setTempo
  • setTempo(ticksPerSecond): void
  • Sets the song's tempo in ticks per second.
    
-
    Parameters
    • ticksPerSecond: number
    Returns void
    Remarks
    Adjusts the time per tick upon modification.
    
-
setTimePerTick
  • setTimePerTick(milliseconds): void
  • Sets the song's amount of milliseconds per tick.
    
-
    Parameters
    • milliseconds: number
    Returns void
    Remarks
    Adjusts the tempo upon modification.
    
-
Constructors
constructor
Settings
Member Visibility
Theme
On This Page
authorautoSaveblocksAddedblocksRemoveddescriptionimportNameinstrumentslayersleftClicksloopminutesSpentnameoriginalAuthorrightClickstimeSignatureversion#tempo#timePerTickgetDurationgetLastMeasuregetLengthgetTempogetTimePerTickhasSolosetTemposetTimePerTickconstructor

\ No newline at end of file
+        
diff --git a/docs/dev/classes/SongInstruments.html b/docs/dev/classes/SongInstruments.html
index 0d49f9a..7779423 100644
--- a/docs/dev/classes/SongInstruments.html
+++ b/docs/dev/classes/SongInstruments.html
@@ -1,4 +1,4 @@
-SongInstruments | nbs.js - v6.0.0-beta2
Class SongInstruments
Represents the Instruments of a Song with helper methods.

-
Properties
all
+
Class SongInstruments
Represents the Instruments of a Song with helper methods.

+
Properties
all
 firstCustomIndex
 
Methods
[iterator]
 add
@@ -166,29 +166,30 @@
 getTotal
 set
 
Constructors
constructor
-
Properties
Readonly all
all: ExistingInstruments = ...
ID-instrument pair of the song's instruments.

-
Remarks
Currently, this always includes the built-in instruments from Note Block Studio v5.

-
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

-
Readonly Internal firstCustomIndex
firstCustomIndex: number = ...
The ID of the first custom instrument.

-
Methods
[iterator]
add
 Properties
Readonlyall
all: ExistingInstruments = ...
ID-instrument pair of the song's instruments.

+
Remarks
Currently, this always includes the built-in instruments from Note Block Studio v5.

+
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

+
Readonly InternalfirstCustomIndex
firstCustomIndex: number = ...
The ID of the first custom instrument.

+
 Methods
[iterator]
add
create
Returns Instrument
create
delete
Returns Instrument

delete

  • delete(id): void

  • Delete an Instrument.

    Parameters

    • id: number

      ID of the instrument to be deleted

      -

    Returns void

    Remarks

    Does not protect built-in instruments. This may not be desirable!

    -

    See

    According to the NBS specification, instrument IDs must be consecutive! Make sure to update any proceeding instrument IDs.

    -

getTotal

set

Returns void

Remarks

Does not protect built-in instruments. This may not be desirable!

+

See

According to the NBS specification, instrument IDs must be consecutive! Make sure to update any proceeding instrument IDs.

+

getTotal

set

  • set(id, instrument): Instrument

  • Set an existing Instrument at an ID.

    Parameters

    • id: number

      ID of the instrument to be set

    • instrument: Instrument

      The instrument to set at id.

      -

    Returns Instrument

    Remarks

    Any existing instrument with the same ID as the added instrument will be overwritten. This includes built-in instruments, which may not be desirable!

    -

    See

    According to the NBS specification, instrument IDs must be consecutive!

    -

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

allfirstCustomIndex[iterator]addcreatedeletegetTotalsetconstructor
\ No newline at end of file + diff --git a/docs/dev/classes/SongLayers.html b/docs/dev/classes/SongLayers.html index dd923b4..a45bc0e 100644 --- a/docs/dev/classes/SongLayers.html +++ b/docs/dev/classes/SongLayers.html @@ -1,4 +1,4 @@ -SongLayers | nbs.js - v6.0.0-beta2

Class SongLayers

Represents the Layers of a Song with helper methods.

-

Example


import { Song, toJSON } from "@encode42/nbs.js";

const song = new Song();
song.name = "Chaos";
song.description = "A randomly generated song.";
song.author = "Pseudorandomness";

// Create four random layers
for (let i = 0; i < 4; i++) {
    createRandomLayer(i);
}

// Create a new layer with random notes
function createRandomLayer(number: number) {
    const layer = song.layers.create();
    layer.name = `Randomness ${number}`;
    layer.stereo = number % 2 === 0 ? -100 : 100;

    // Add ten notes with random key and instrument, four ticks apart
    for (let i = 0; i < 10; i++) {
        layer.notes.add(i + 4, random(1, song.instruments.total - 1), {
            "key": random(0, 87)
        });
    }
}

// Ye Olde RNG
function random(min: number, max: number) {
    return Math.floor(Math.random() * (max - min)) + min;
}

console.dir(JSON.stringify(toJSON(song), undefined, 4));

+
Class SongLayers
Represents the Layers of a Song with helper methods.

+
Example

import { Song, toJSON } from "@nbsjs/core";

const song = new Song();
song.name = "Chaos";
song.description = "A randomly generated song.";
song.author = "Pseudorandomness";

// Create four random layers
for (let i = 0; i < 4; i++) {
	createRandomLayer(i);
}

// Create a new layer with random notes
function createRandomLayer(number: number) {
	const layer = song.layers.create();
	layer.name = `Randomness ${number}`;
	layer.stereo = number % 2 === 0 ? -100 : 100;

	// Add ten notes with random key and instrument, four ticks apart
	for (let i = 0; i < 10; i++) {
		layer.notes.add(i + 4, random(1, song.instruments.total - 1), {
			"key": random(0, 87)
		});
	}
}

// Ye Olde RNG
function random(min: number, max: number) {
	return Math.floor(Math.random() * (max - min)) + min;
}

console.dir(JSON.stringify(toJSON(song), undefined, 4));

 

-
Properties
all
+
+
Properties
all
 
Methods
[iterator]
 add
 create
 delete
 getTotal
 
Constructors
constructor
-
Properties
Readonly all
all: Layer[] = []
Array of every layer in the song.

-
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

-
Methods
[iterator]
add
  • add(layer): void
  • Add an existing Layer.
    
+
 Properties
Readonlyall
all: Layer[] = []
Array of every layer in the song.

+
See
This should not be modified directly! Instead, utilize the various helper methods in this class.

+
 Methods
[iterator]
add
  • add(layer): void
  • Add an existing Layer.
    
 
    Parameters
    • layer: Layer
      Layer to add
      
-
    Returns void
    Remarks
    Any existing layer with the same ID as the added layer will be overwritten.
    
-
create
delete
Returns void
Remarks
Any existing layer with the same ID as the added layer will be overwritten.

+

create

delete

getTotal

Constructors

constructor

Settings

Member Visibility

Theme

On This Page

all[iterator]addcreatedeletegetTotalconstructor
\ No newline at end of file + diff --git a/docs/dev/functions/fromArrayBuffer.html b/docs/dev/functions/fromArrayBuffer.html index 1807d75..f8f8d16 100644 --- a/docs/dev/functions/fromArrayBuffer.html +++ b/docs/dev/functions/fromArrayBuffer.html @@ -1,4 +1,4 @@ -fromArrayBuffer | nbs.js - v6.0.0-beta2

Function fromArrayBuffer

  • fromArrayBuffer(arrayBuffer, options?): Song

  • Parse and return a Song from a file array buffer.

    -

    Example


    import { readFileSync } from "node:fs";
    import { fromArrayBuffer } from "@encode42/nbs.js";

    // Read a NBS file named "song.nbs"
    const originalFile = readFileSync("song.nbs");
    const originalBuffer = new Uint8Array(originalFile).buffer;
    const song = fromArrayBuffer(originalBuffer);

    console.dir(song); // Here's ya song!
    
+
    Function fromArrayBuffer
    • fromArrayBuffer(arrayBuffer, options?): Song
    • Parse and return a Song from a file array buffer.
      
+
      Example

      import { readFileSync } from "node:fs";
      import { fromArrayBuffer } from "@nbsjs/core";

      // Read a NBS file named "song.nbs"
      const originalFile = readFileSync("song.nbs");
      const originalBuffer = new Uint8Array(originalFile).buffer;
      const song = fromArrayBuffer(originalBuffer);

      console.dir(song); // Here's ya song!
      
 
      
+
 
      Parameters
      • arrayBuffer: ArrayBufferLike
        Array buffer to parse from
        
 
      • options: FromArrayBufferOptions = defaultFromArrayBufferOptions
        Options for parsing
        
 
      Returns Song
      Parsed song, empty if unsuccessful
      
-
    Settings
    Member Visibility
    Theme
    On This Page
    Example
    
\ No newline at end of file
+        
diff --git a/docs/dev/functions/fromJSON.html b/docs/dev/functions/fromJSON.html
deleted file mode 100644
index 8b2f991..0000000
--- a/docs/dev/functions/fromJSON.html
+++ /dev/null
@@ -1,178 +0,0 @@
-fromJSON | nbs.js - v6.0.0-beta2
    Function fromJSON
    • fromJSON(json): Song
    • Parse and return a Song from a JSON object.
      
-
      Parameters
      • json: object
        JSON object to parse from
        
-
      Returns Song
      Parsed song
      
-
      See
      Currently untested!
      
-
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/dev/functions/omitEmptyLayers.html b/docs/dev/functions/omitEmptyLayers.html
index 6b75387..f05bac0 100644
--- a/docs/dev/functions/omitEmptyLayers.html
+++ b/docs/dev/functions/omitEmptyLayers.html
@@ -1,4 +1,4 @@
-omitEmptyLayers | nbs.js - v6.0.0-beta2
    Function omitEmptyLayers
    • omitEmptyLayers(song, makeClone?): Song
    • Internal 
      Deletes all layers without notes from a Song.
      
+
      Function omitEmptyLayers
      • omitEmptyLayers(song, makeClone?): Song
      • Internal
        Deletes all layers without notes from a Song.
        
 
        Parameters
        • song: Song
          Song to remove empty layers from
          
 
        • makeClone: boolean = true
          Whether to create a clone of the song, preventing modification of the original song
          
 
        Returns Song
        The song without empty layers (new Song if cloned, original Song otherwise)
        
-
      Settings
      Member Visibility
      Theme
      
\ No newline at end of file
+        
diff --git a/docs/dev/functions/toArrayBuffer.html b/docs/dev/functions/toArrayBuffer.html
index cd17320..a42015d 100644
--- a/docs/dev/functions/toArrayBuffer.html
+++ b/docs/dev/functions/toArrayBuffer.html
@@ -1,4 +1,4 @@
-toArrayBuffer | nbs.js - v6.0.0-beta2
      Function toArrayBuffer
      • toArrayBuffer(song, options?): ArrayBufferLike
      • Generate an ArrayBuffer from a Song.
        
-
        Example

        import { writeFileSync } from "node:fs";
        import { Song, toArrayBuffer } from "@encode42/nbs.js";

        const song = new Song();

        // ...do what you need with the song

        const exportedBuffer = toArrayBuffer(song, {
            "ignoreEmptyLayers": true
        });

        writeFileSync("output.nbs", new Uint8Array(exportedBuffer));
        
+
        Function toArrayBuffer
        • toArrayBuffer(song, options?): ArrayBufferLike
        • Generate an ArrayBuffer from a Song.
          
+
          Example

          import { writeFileSync } from "node:fs";
          import { Song, toArrayBuffer } from "@nbsjs/core";

          const song = new Song();

          // ...do what you need with the song

          const exportedBuffer = toArrayBuffer(song, {
          	"ignoreEmptyLayers": true
          });

          writeFileSync("output.nbs", new Uint8Array(exportedBuffer));
          
 
          
+
 
          Parameters
          • song: Song
            Song to parse from
            
 
          • options: ToArrayBufferOptions = defaultToArrayBufferOptions
            Optional arguments that impact export behavior
            
 
          Returns ArrayBufferLike
          Generated array buffer, empty if unsuccessful
          
-
        Settings
        Member Visibility
        Theme
        On This Page
        Example
        
\ No newline at end of file
+        
diff --git a/docs/dev/functions/toJSON.html b/docs/dev/functions/toJSON.html
deleted file mode 100644
index 880d682..0000000
--- a/docs/dev/functions/toJSON.html
+++ /dev/null
@@ -1,180 +0,0 @@
-toJSON | nbs.js - v6.0.0-beta2
        Function toJSON
        • toJSON(song): object
        • Generate a JSON object from a Song.
          
-
          Example

          import { format, parse } from "node:path";
          import { readFileSync, writeFileSync } from "node:fs";
          import { fromArrayBuffer, toJSON } from "@encode42/nbs.js";

          // We will be converting a file named "song.nbs"
          const songPath = parse("song.nbs");
          const inputPath = format(songPath);
          const outputPath = format({
              ...songPath,
              "ext": ".json"
          });

          // Read the file into a song
          const originalFile = readFileSync(inputPath);
          const originalBuffer = new Uint8Array(originalFile).buffer;
          const song = fromArrayBuffer(originalBuffer);

          // Export the song into a JSON object
          const exportedJSON = toJSON(song);
          writeFileSync(outputPath, JSON.stringify(exportedJSON));
          
-
          
-
          Parameters
          • song: Song
            Song to parse from
            
-
          Returns object
          Generated JSON object
          
-
          See
          Currently untested!
          
-
        Settings
        Member Visibility
        Theme
        On This Page
        Example
        
\ No newline at end of file
diff --git a/docs/dev/hierarchy.html b/docs/dev/hierarchy.html
index b017de6..0354246 100644
--- a/docs/dev/hierarchy.html
+++ b/docs/dev/hierarchy.html
@@ -1,4 +1,4 @@
-nbs.js - v6.0.0-beta2
        nbs.js - v6.0.0-beta2
        Class Hierarchy
        Settings
        Member Visibility
        Theme
        nbs.js - v6.0.0
        Class Hierarchy
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/index.html b/docs/dev/index.html
index ffe5930..2082e4a 100644
--- a/docs/dev/index.html
+++ b/docs/dev/index.html
@@ -1,4 +1,4 @@
-nbs.js - v6.0.0-beta2
        nbs.js - v6.0.0-beta2
        Index
        Highlights
        Instrument
+
        nbs.js - v6.0.0
        Index
        Highlights
        Instrument
 Layer
 Note
 Song
@@ -167,11 +167,9 @@
 ExistingInstruments
 SongAutoSave
 SongLoop
-SongObject
 defaultAutoSave
 defaultLoop
 fromArrayBuffer
-fromJSON
 
        Instrument
        Instrument
 SongInstruments
 BuiltInBuilder
@@ -197,16 +195,11 @@
 defaultToArrayBufferOptions
 fromArrayBuffer
 toArrayBuffer
-
        JSON
        IgnoredValues
-SongObject
-ignoredValues
-fromJSON
-toJSON
 
        Internal Utilities
        BufferReader
 BufferWrapper
 BufferWriter
 omitEmptyLayers
-
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/BuiltInBuilder.html b/docs/dev/interfaces/BuiltInBuilder.html
index 4e6e3f6..96f4930 100644
--- a/docs/dev/interfaces/BuiltInBuilder.html
+++ b/docs/dev/interfaces/BuiltInBuilder.html
@@ -1,4 +1,4 @@
-BuiltInBuilder | nbs.js - v6.0.0-beta2
        Interface BuiltInBuilderInternal 
        Structure of builtInBuilder.
        
-
        interface BuiltInBuilder { 
            [id: number]: { 
                name: string; 
                soundFile: string; 
            }; 
        }
        Indexable
        [id: number]: { 
            name: string; 
            soundFile: string; 
        }
        ID-instrument pair.
        
+
        Interface BuiltInBuilderInternal
        Structure of builtInBuilder.
        
+
        Indexable
        • [id: number]: { 
              name: string; 
              soundFile: string; 
          }
          ID-instrument pair.
          
 
          • name: string
            Name of the instrument.
            
 
          • soundFile: string
            Sound file of the instrument.
            
-
            Remarks
            Relative to the Data/Sounds/ directory of Note Block Studio installations.
            
-
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/ExistingInstruments.html b/docs/dev/interfaces/ExistingInstruments.html
index 8b95cdb..f8623cb 100644
--- a/docs/dev/interfaces/ExistingInstruments.html
+++ b/docs/dev/interfaces/ExistingInstruments.html
@@ -1,4 +1,4 @@
-ExistingInstruments | nbs.js - v6.0.0-beta2
        Interface ExistingInstruments
        The existing Instruments.
        
-
        See
        SongInstruments#all
        
-
        interface ExistingInstruments { 
            [id: number]: Instrument; 
        }
        Hierarchy (view full)
        Indexable
        [id: number]: Instrument
        ID-Instrument pair.
        
-
        See
        Instrument
        
-
        Settings
        Member Visibility
        Theme
        Interface ExistingInstruments
        The existing Instruments.
        
+
        See
        SongInstruments#all
        
+
        Hierarchy (view full)
        Indexable
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/ExistingNotes.html b/docs/dev/interfaces/ExistingNotes.html
index cb3a28c..3ebc911 100644
--- a/docs/dev/interfaces/ExistingNotes.html
+++ b/docs/dev/interfaces/ExistingNotes.html
@@ -1,4 +1,4 @@
-ExistingNotes | nbs.js - v6.0.0-beta2
        Interface ExistingNotes
        The existing Notes of the layer.
        
-
        See
        LayerNotes#all
        
-
        interface ExistingNotes { 
            [tick: number]: Note; 
        }
        Indexable
        [tick: number]: Note
        Each tick-note pair.
        
-
        See
        Note
        
-
        Settings
        Member Visibility
        Theme
        Interface ExistingNotes
        The existing Notes of the layer.
        
+
        See
        LayerNotes#all
        
+
        Indexable
        • [tick: number]: Note
          Each tick-note pair.
          
+
          See
          Note
          
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/FromArrayBufferOptions.html b/docs/dev/interfaces/FromArrayBufferOptions.html
index a978584..f9f39f0 100644
--- a/docs/dev/interfaces/FromArrayBufferOptions.html
+++ b/docs/dev/interfaces/FromArrayBufferOptions.html
@@ -1,4 +1,4 @@
-FromArrayBufferOptions | nbs.js - v6.0.0-beta2
        Interface FromArrayBufferOptionsInternal 
        Options for fromArrayBuffer.
        
-
        interface FromArrayBufferOptions { 
            ignoreEmptyLayers?: boolean; 
        }
        Properties
        ignoreEmptyLayers?
-
        Properties
        Optional ignoreEmptyLayers
        ignoreEmptyLayers?: boolean
        Whether to ignore (delete) unpopulated leading layers.
        
-
        Remarks
        Note Block Studio automatically generates extra layers past the last populated layer.
        
+
        Interface FromArrayBufferOptionsInternal
        Options for fromArrayBuffer.
        
+
        interface FromArrayBufferOptions { 
            ignoreEmptyLayers?: boolean; 
        }
        Properties
        ignoreEmptyLayers?
+
         Properties
        OptionalignoreEmptyLayers
        ignoreEmptyLayers?: boolean
        Whether to ignore (delete) unpopulated leading layers.
        
+
        Remarks
        Note Block Studio automatically generates extra layers past the last populated layer.
        
 
        This option skips those layers upon import.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        ignoreEmptyLayers
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/IgnoredValues.html b/docs/dev/interfaces/IgnoredValues.html
deleted file mode 100644
index c2fbdd0..0000000
--- a/docs/dev/interfaces/IgnoredValues.html
+++ /dev/null
@@ -1,176 +0,0 @@
-IgnoredValues | nbs.js - v6.0.0-beta2
        Interface IgnoredValuesInternal 
        Structure for ignoredValues.
        
-
        interface IgnoredValues { 
            [key: string]: unknown; 
        }
        Indexable
        [key: string]: unknown
        Key to ignore if equal to value.
        
-
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/docs/dev/interfaces/InstrumentOptions.html b/docs/dev/interfaces/InstrumentOptions.html
index b145070..d921140 100644
--- a/docs/dev/interfaces/InstrumentOptions.html
+++ b/docs/dev/interfaces/InstrumentOptions.html
@@ -1,4 +1,4 @@
-InstrumentOptions | nbs.js - v6.0.0-beta2
        Interface InstrumentOptions
        Options available for an Instrument.
        
-
        interface InstrumentOptions { 
            key?: number; 
            name?: string; 
            pressKey?: boolean; 
            soundFile?: string; 
        }
        Properties
        key?
+
        Interface InstrumentOptions
        Options available for an Instrument.
        
+
        interface InstrumentOptions { 
            key?: number; 
            name?: string; 
            pressKey?: boolean; 
            soundFile?: string; 
        }
        Properties
        key?
 name?
 pressKey?
 soundFile?
-
        Properties
        Optional key
        key?: number
        Key of the sound file.
        
-
        Remarks
        Just like note blocks, this ranges from 0-87.
        
-
        Optional name
        name?: string
        Name of the instrument.
        
-
        Optional pressKey
        pressKey?: boolean
        Whether the on-screen piano should visually press keys when these notes are played.
        
-
        Optional soundFile
        soundFile?: string
        Sound file of the instrument.
        
-
        Remarks
        Relative to the Data/Sounds/ directory of Note Block Studio installations.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        keynamepressKeysoundFile
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/LayerOptions.html b/docs/dev/interfaces/LayerOptions.html
index 4ff991d..14b5aa7 100644
--- a/docs/dev/interfaces/LayerOptions.html
+++ b/docs/dev/interfaces/LayerOptions.html
@@ -1,4 +1,4 @@
-LayerOptions | nbs.js - v6.0.0-beta2
        Interface LayerOptions
        Options available for a Layer.
        
-
        interface LayerOptions { 
            isLocked?: boolean; 
            isSolo?: boolean; 
            name?: string; 
            stereo?: number; 
            volume?: number; 
        }
        Properties
        isLocked?
+
        Interface LayerOptions
        Options available for a Layer.
        
+
        interface LayerOptions { 
            isLocked?: boolean; 
            isSolo?: boolean; 
            name?: string; 
            stereo?: number; 
            volume?: number; 
        }
        Properties
        isLocked?
 isSolo?
 name?
 stereo?
 volume?
-
        Properties
        Optional isLocked
        isLocked?: boolean
        Whether this layer has been marked as locked.
        
-
        Optional isSolo
        isSolo?: boolean
        Whether this layer has been marked as solo.
        
-
        Optional name
        name?: string
        Name of the layer.
        
-
        Optional stereo
        stereo?: number
        How much this layer is panned to the left or right.
        
-
        Optional volume
        volume?: number
        Volume percentage of the layer.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        isLockedisSolonamestereovolume
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/NoteOptions.html b/docs/dev/interfaces/NoteOptions.html
index b5800ff..1374d89 100644
--- a/docs/dev/interfaces/NoteOptions.html
+++ b/docs/dev/interfaces/NoteOptions.html
@@ -1,4 +1,4 @@
-NoteOptions | nbs.js - v6.0.0-beta2
        Interface NoteOptions
        Options available for a Note.
        
-
        interface NoteOptions { 
            key?: number; 
            panning?: number; 
            pitch?: number; 
            velocity?: number; 
        }
        Properties
        key?
+
        Interface NoteOptions
        Options available for a Note.
        
+
        interface NoteOptions { 
            key?: number; 
            panning?: number; 
            pitch?: number; 
            velocity?: number; 
        }
        Properties
        key?
 panning?
 pitch?
 velocity?
-
        Properties
        Optional key
        key?: number
        Key of the note block.
        
-
        Remarks
        From 0 to 87. 33 to 57 is within the 2-octave limit.
        
-
        Optional panning
        panning?: number
        Stereo position of the note block.
        
-
        Remarks
        From -100 to 100.
        
-
        Optional pitch
        pitch?: number
        Fine pitch of the note block.
        
-
        Remarks
        The max in Note Block Studio is limited to -1200 and +1200.
        
-
        Optional velocity
        velocity?: number
        Velocity (volume) of the note block.
        
-
        Remarks
        From 0% to 100%.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        keypanningpitchvelocity
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/SongAutoSave.html b/docs/dev/interfaces/SongAutoSave.html
index 0e65076..a7c578c 100644
--- a/docs/dev/interfaces/SongAutoSave.html
+++ b/docs/dev/interfaces/SongAutoSave.html
@@ -1,4 +1,4 @@
-SongAutoSave | nbs.js - v6.0.0-beta2
        Interface SongAutoSave
        Options available for Song#autoSave.
        
-
        Remarks
        These properties are not used within nbs.js for anything other than storage.
        
+
        Interface SongAutoSave
        Options available for Song#autoSave.
        
+
        Remarks
        These properties are not used within nbs.js for anything other than storage.
        
 
        They only exist as data fields to work with other applications that implement functionality.
        
-
        interface SongAutoSave { 
            enabled: boolean; 
            interval: number; 
        }
        Properties
        enabled
+
        interface SongAutoSave { 
            enabled: boolean; 
            interval: number; 
        }
        Properties
        enabled
 interval
-
        Properties
        enabled
        enabled: boolean
        Whether auto-saving has been enabled.
        
-
        interval
        interval: number
        Number of minutes between each auto-save.
        
-
        Remarks
        Ranges from 1 to 60.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        enabledinterval
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/SongLoop.html b/docs/dev/interfaces/SongLoop.html
index 2889657..a6c0121 100644
--- a/docs/dev/interfaces/SongLoop.html
+++ b/docs/dev/interfaces/SongLoop.html
@@ -1,4 +1,4 @@
-SongLoop | nbs.js - v6.0.0-beta2
        Interface SongLoop
        Options available for Song#loop.
        
-
        Remarks
        These properties are not used within nbs.js for anything other than storage.
        
+
        Interface SongLoop
        Options available for Song#loop.
        
+
        Remarks
        These properties are not used within nbs.js for anything other than storage.
        
 
        They only exist as data fields to work with other applications that implement functionality.
        
-
        interface SongLoop { 
            enabled: boolean; 
            startTick: number; 
            totalLoops: number; 
        }
        Properties
        enabled
+
        interface SongLoop { 
            enabled: boolean; 
            startTick: number; 
            totalLoops: number; 
        }
        Properties
        enabled
 startTick
 totalLoops
-
        Properties
        enabled
        enabled: boolean
        Whether looping is enabled.
        
-
        startTick
        startTick: number
        Where the song should loop back to.
        
-
        Remarks
        Unit is ticks.
        
-
        totalLoops
        totalLoops: number
        Number of times the song should loop.
        
-
        Remarks
        0 designates infinite.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        enabledstartTicktotalLoops
        
\ No newline at end of file
+        
diff --git a/docs/dev/interfaces/SongObject.html b/docs/dev/interfaces/SongObject.html
deleted file mode 100644
index cf3e32b..0000000
--- a/docs/dev/interfaces/SongObject.html
+++ /dev/null
@@ -1,227 +0,0 @@
-SongObject | nbs.js - v6.0.0-beta2
        Interface SongObject
        A Song represented by basic JSON notation.
        
-
        interface SongObject { 
            author?: string; 
            autoSave: SongAutoSave; 
            blocksAdded: number; 
            blocksRemoved: number; 
            description?: string; 
            duration: number; 
            hasSolo: boolean; 
            importName?: string; 
            instruments: SongInstruments; 
            lastMeasure: number; 
            layers: SongLayers; 
            leftClicks: number; 
            length: number; 
            loop: SongLoop; 
            minutesSpent: number; 
            name?: string; 
            originalAuthor?: string; 
            rightClicks: number; 
            tempo: number; 
            timePerTick: number; 
            timeSignature: number; 
            version: number; 
        }
        Properties
        author?
-autoSave
-blocksAdded
-blocksRemoved
-description?
-duration
-hasSolo
-importName?
-instruments
-lastMeasure
-layers
-leftClicks
-length
-loop
-minutesSpent
-name?
-originalAuthor?
-rightClicks
-tempo
-timePerTick
-timeSignature
-version
-
        Properties
        Optional author
        author?: string
        Author of the song.
        
-
        autoSave
        autoSave: SongAutoSave
        Auto-save options for the song.
        
-
        blocksAdded
        blocksAdded: number
        Number of times the user has added a note block.
        
-
        Remarks
        This value does not update when methods such as LayerNotes#add is used!
        
-
        blocksRemoved
        blocksRemoved: number
        Number of times the user have removed a note block.
        
-
        Remarks
        This value does not update when methods such as LayerNotes#delete is used!
        
-
        Optional description
        description?: string
        Description of the song.
        
-
        duration
        duration: number
        Playtime of the song in milliseconds.
        
-
        Remarks
        This currently does not support Note Block Studio's unofficial tempo changer layer.
        
-
        hasSolo
        hasSolo: boolean
        Whether the song has at least one solo layer.
        
-
        Optional importName
        importName?: string
        Imported MIDI/Schematic file name.
        
-
        instruments
        instruments: SongInstruments
        Instruments of the song.
        
-
        lastMeasure
        lastMeasure: number
        Tick of the last measure of the song.
        
-
        layers
        layers: SongLayers
        Length of the song in ticks.
        
-
        leftClicks
        leftClicks: number
        Number of times the user has left-clicked on the song.
        
-
        Remarks
        This value does not update when methods such as LayerNotes#add is used!
        
-
        length
        length: number
        Length of the song in ticks.
        
-
        loop
        loop: SongLoop
        Looping options for the song.
        
-
        minutesSpent
        minutesSpent: number
        Number of minutes spent on the song.
        
-
        Remarks
        This value is not updated by nbs.js!
        
-
        Optional name
        name?: string
        Name of the song.
        
-
        Optional originalAuthor
        originalAuthor?: string
        Original author of the song.
        
-
        rightClicks
        rightClicks: number
        Number of times the user has right-clicked on the song.
        
-
        Remarks
        This value does not update when methods such as LayerNotes#delete is used!
        
-
        tempo
        tempo: number
        Tempo of the song in ticks per second.
        
-
        timePerTick
        timePerTick: number
        Amount of milliseconds each tick takes.
        
-
        timeSignature
        timeSignature: number
        Time signature of the song.
        
-
        Remarks
        From 2 to 8.
        
-
        version
        version: number
        Version of NBS the song has been made with.
        
-
        Remarks
        Currently, this does not affect the exported song structure properly, and should always be upgraded to 5.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        authorautoSaveblocksAddedblocksRemoveddescriptiondurationhasSoloimportNameinstrumentslastMeasurelayersleftClickslengthloopminutesSpentnameoriginalAuthorrightClickstempotimePerTicktimeSignatureversion
        
\ No newline at end of file
diff --git a/docs/dev/interfaces/ToArrayBufferOptions.html b/docs/dev/interfaces/ToArrayBufferOptions.html
index 0852697..bb0614b 100644
--- a/docs/dev/interfaces/ToArrayBufferOptions.html
+++ b/docs/dev/interfaces/ToArrayBufferOptions.html
@@ -1,4 +1,4 @@
-ToArrayBufferOptions | nbs.js - v6.0.0-beta2
        Interface ToArrayBufferOptionsInternal 
        Options for toArrayBuffer.
        
-
        interface ToArrayBufferOptions { 
            ignoreEmptyLayers?: boolean; 
        }
        Properties
        ignoreEmptyLayers?
-
        Properties
        Optional ignoreEmptyLayers
        ignoreEmptyLayers?: boolean
        Whether to ignore unpopulated leading layers.
        
-
        Remarks
        This skips all layers without notes from the exported song.
        
-
        Settings
        Member Visibility
        Theme
        On This Page
        ignoreEmptyLayers
        Interface ToArrayBufferOptionsInternal
        Options for toArrayBuffer.
        
+
        interface ToArrayBufferOptions { 
            ignoreEmptyLayers?: boolean; 
        }
        Properties
        ignoreEmptyLayers?
+
         Properties
        OptionalignoreEmptyLayers
        ignoreEmptyLayers?: boolean
        Whether to ignore unpopulated leading layers.
        
+
        Remarks
        This skips all layers without notes from the exported song.
        
+
        Settings
        Member Visibility
        On This Page
        Properties
        
\ No newline at end of file
+        
diff --git a/docs/dev/types/BuiltIn.html b/docs/dev/types/BuiltIn.html
index 195f92a..2bcdede 100644
--- a/docs/dev/types/BuiltIn.html
+++ b/docs/dev/types/BuiltIn.html
@@ -1,4 +1,4 @@
-BuiltIn | nbs.js - v6.0.0-beta2
        Type alias BuiltIn
        BuiltIn: {
            [Id in keyof typeof builtInBuilder]: Instrument
        }
        Every built-in instrument.
        
-
        See
        Instrument.builtIn
        
-
        Settings
        Member Visibility
        Theme
        Type Alias BuiltIn
        BuiltIn: {
            [Id in keyof typeof builtInBuilder]: Instrument
        }
        Every built-in instrument.
        
+
        See
        Instrument.builtIn
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/builtInBuilder-1.html b/docs/dev/variables/builtInBuilder-1.html
index 1e27c4b..4e1b145 100644
--- a/docs/dev/variables/builtInBuilder-1.html
+++ b/docs/dev/variables/builtInBuilder-1.html
@@ -1,4 +1,4 @@
-builtInBuilder | nbs.js - v6.0.0-beta2
        Variable builtInBuilderConst Internal 
        builtInBuilder: BuiltInBuilder = ...
        Used to construct Instrument.builtIn.
        
-
        Settings
        Member Visibility
        Theme
        Variable builtInBuilderConst Internal
        builtInBuilder: BuiltInBuilder = ...
        Used to construct Instrument.builtIn.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultAutoSave.html b/docs/dev/variables/defaultAutoSave.html
index b426cf3..f6de49f 100644
--- a/docs/dev/variables/defaultAutoSave.html
+++ b/docs/dev/variables/defaultAutoSave.html
@@ -1,4 +1,4 @@
-defaultAutoSave | nbs.js - v6.0.0-beta2
        Variable defaultAutoSaveConst Internal 
        defaultAutoSave: SongAutoSave = ...
        Default Song#autoSave values.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultAutoSaveConst Internal
        defaultAutoSave: SongAutoSave = ...
        Default Song#autoSave values.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultFromArrayBufferOptions.html b/docs/dev/variables/defaultFromArrayBufferOptions.html
index dd1a28f..4117b9f 100644
--- a/docs/dev/variables/defaultFromArrayBufferOptions.html
+++ b/docs/dev/variables/defaultFromArrayBufferOptions.html
@@ -1,4 +1,4 @@
-defaultFromArrayBufferOptions | nbs.js - v6.0.0-beta2
        Variable defaultFromArrayBufferOptionsConst Internal 
        defaultFromArrayBufferOptions: FromArrayBufferOptions = ...
        Default options for fromArrayBuffer.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultFromArrayBufferOptionsConst Internal
        defaultFromArrayBufferOptions: FromArrayBufferOptions = ...
        Default options for fromArrayBuffer.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultInstrumentOptions.html b/docs/dev/variables/defaultInstrumentOptions.html
index f4d987b..84d61cb 100644
--- a/docs/dev/variables/defaultInstrumentOptions.html
+++ b/docs/dev/variables/defaultInstrumentOptions.html
@@ -1,4 +1,4 @@
-defaultInstrumentOptions | nbs.js - v6.0.0-beta2
        Variable defaultInstrumentOptionsConst 
        defaultInstrumentOptions: InstrumentOptions = ...
        Default Instrument values.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultInstrumentOptionsConst
        defaultInstrumentOptions: InstrumentOptions = ...
        Default Instrument values.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultLayerOptions.html b/docs/dev/variables/defaultLayerOptions.html
index b11130d..bda5e02 100644
--- a/docs/dev/variables/defaultLayerOptions.html
+++ b/docs/dev/variables/defaultLayerOptions.html
@@ -1,4 +1,4 @@
-defaultLayerOptions | nbs.js - v6.0.0-beta2
        Variable defaultLayerOptionsConst Internal 
        defaultLayerOptions: Required<LayerOptions> = ...
        Default Layer values.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultLayerOptionsConst Internal
        defaultLayerOptions: Required<LayerOptions> = ...
        Default Layer values.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultLoop.html b/docs/dev/variables/defaultLoop.html
index 359708e..e7ea853 100644
--- a/docs/dev/variables/defaultLoop.html
+++ b/docs/dev/variables/defaultLoop.html
@@ -1,4 +1,4 @@
-defaultLoop | nbs.js - v6.0.0-beta2
        Variable defaultLoopConst Internal 
        defaultLoop: SongLoop = ...
        Default Song#loop values.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultLoopConst Internal
        defaultLoop: SongLoop = ...
        Default Song#loop values.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultNoteOptions.html b/docs/dev/variables/defaultNoteOptions.html
index d59d15e..074879d 100644
--- a/docs/dev/variables/defaultNoteOptions.html
+++ b/docs/dev/variables/defaultNoteOptions.html
@@ -1,4 +1,4 @@
-defaultNoteOptions | nbs.js - v6.0.0-beta2
        Variable defaultNoteOptionsConst Internal 
        defaultNoteOptions: Required<NoteOptions> = ...
        Default NoteOptions values.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultNoteOptionsConst Internal
        defaultNoteOptions: Required<NoteOptions> = ...
        Default NoteOptions values.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/defaultToArrayBufferOptions.html b/docs/dev/variables/defaultToArrayBufferOptions.html
index 63760d8..3bddc98 100644
--- a/docs/dev/variables/defaultToArrayBufferOptions.html
+++ b/docs/dev/variables/defaultToArrayBufferOptions.html
@@ -1,4 +1,4 @@
-defaultToArrayBufferOptions | nbs.js - v6.0.0-beta2
        Variable defaultToArrayBufferOptionsConst Internal 
        defaultToArrayBufferOptions: ToArrayBufferOptions = ...
        Default options for toArrayBuffer.
        
-
        Settings
        Member Visibility
        Theme
        Variable defaultToArrayBufferOptionsConst Internal
        defaultToArrayBufferOptions: ToArrayBufferOptions = ...
        Default options for toArrayBuffer.
        
+
        Settings
        Member Visibility
        
\ No newline at end of file
+        
diff --git a/docs/dev/variables/ignoredValues-1.html b/docs/dev/variables/ignoredValues-1.html
deleted file mode 100644
index 66d071a..0000000
--- a/docs/dev/variables/ignoredValues-1.html
+++ /dev/null
@@ -1,175 +0,0 @@
-ignoredValues | nbs.js - v6.0.0-beta2
        Variable ignoredValuesConst Internal 
        ignoredValues: IgnoredValues = ...
        Values that will be ignored during export if matched.
        
-
        Settings
        Member Visibility
        Theme
        
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
index 56d62f4..615a77e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -3,7 +3,7 @@
 	
 		nbs.js - Documentation