From 570648e159bccfed82a23813cbec2468a8233150 Mon Sep 17 00:00:00 2001 From: Jeremy Ruppel Date: Sat, 21 Oct 2023 19:43:36 -0400 Subject: [PATCH] docs --- README.md | 36 + docs/.nojekyll | 1 + docs/assets/highlight.css | 22 + docs/assets/main.js | 59 + docs/assets/navigation.js | 1 + docs/assets/search.js | 1 + docs/assets/style.css | 1383 +++++++++++++++++ docs/classes/events.ChannelPressure.html | 230 +++ docs/classes/events.ControlChange.html | 240 +++ docs/classes/events.NoteOff.html | 247 +++ docs/classes/events.NoteOn.html | 241 +++ docs/classes/events.PitchBend.html | 230 +++ docs/classes/events.PolyPressure.html | 240 +++ docs/classes/events.ProgramChange.html | 230 +++ docs/classes/events.TargetEvent.html | 240 +++ docs/classes/events._Event.html | 217 +++ docs/functions/parameters.GetParameter.html | 56 + docs/functions/parameters.SetParameter.html | 58 + .../parameters.UpdatePluginParameters.html | 51 + docs/functions/timinginfo.GetTimingInfo.html | 55 + docs/functions/trace.Trace.html | 56 + docs/index.html | 50 + docs/interfaces/timinginfo.TimingInfo.html | 170 ++ docs/modules/events.html | 58 + docs/modules/index.html | 43 + docs/modules/parameters.html | 62 + docs/modules/timinginfo.html | 54 + docs/modules/trace.html | 50 + docs/types/parameters.Lin.html | 52 + docs/types/parameters.Log.html | 52 + docs/types/parameters.Menu.html | 52 + docs/types/parameters.Momentary.html | 52 + docs/types/parameters.Parameter.html | 86 + docs/types/parameters.PluginParameter.html | 47 + docs/types/parameters.PluginParameters.html | 47 + package-lock.json | 113 +- package.json | 2 + tsconfig.json | 6 + 38 files changed, 4877 insertions(+), 13 deletions(-) create mode 100644 README.md create mode 100644 docs/.nojekyll create mode 100644 docs/assets/highlight.css create mode 100644 docs/assets/main.js create mode 100644 docs/assets/navigation.js create mode 100644 docs/assets/search.js create mode 100644 docs/assets/style.css create mode 100644 docs/classes/events.ChannelPressure.html create mode 100644 docs/classes/events.ControlChange.html create mode 100644 docs/classes/events.NoteOff.html create mode 100644 docs/classes/events.NoteOn.html create mode 100644 docs/classes/events.PitchBend.html create mode 100644 docs/classes/events.PolyPressure.html create mode 100644 docs/classes/events.ProgramChange.html create mode 100644 docs/classes/events.TargetEvent.html create mode 100644 docs/classes/events._Event.html create mode 100644 docs/functions/parameters.GetParameter.html create mode 100644 docs/functions/parameters.SetParameter.html create mode 100644 docs/functions/parameters.UpdatePluginParameters.html create mode 100644 docs/functions/timinginfo.GetTimingInfo.html create mode 100644 docs/functions/trace.Trace.html create mode 100644 docs/index.html create mode 100644 docs/interfaces/timinginfo.TimingInfo.html create mode 100644 docs/modules/events.html create mode 100644 docs/modules/index.html create mode 100644 docs/modules/parameters.html create mode 100644 docs/modules/timinginfo.html create mode 100644 docs/modules/trace.html create mode 100644 docs/types/parameters.Lin.html create mode 100644 docs/types/parameters.Log.html create mode 100644 docs/types/parameters.Menu.html create mode 100644 docs/types/parameters.Momentary.html create mode 100644 docs/types/parameters.Parameter.html create mode 100644 docs/types/parameters.PluginParameter.html create mode 100644 docs/types/parameters.PluginParameters.html create mode 100644 tsconfig.json diff --git a/README.md b/README.md new file mode 100644 index 0000000..022ab82 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# tslogic + +Type defitions for Logic Pro' Scripter. Check out the [API Docs](./docs) + +### usage + +Create a `tsconfig.json` withe following compiler options: + +```json +{ + "compilerOptions": { + "outDir": "", + "target": "ES6", + "skipLibCheck": true + }, + "include": [""] +} +``` + +If you don't have one, create a `package.json`: + +``` +$ npm init -y +``` + +Install `tslogic` as a devDependency of your project: + +``` +$ npm install --save-dev tslogic +``` + +Finally, in your typescript source files, reference the `tslogic` types like: + +```ts +/// +``` diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..5674cf3 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,22 @@ +:root { + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --code-background: var(--dark-code-background); +} + +pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..d0aa8d5 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..24cff5d --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE5XTXU/CMBQG4P/Sa6JCBJVLjTEmqCTgFSGk2c62xq5d2jMDMf53uylbu49uXtLz9uGcrt19EYQjkiWBTxCoyYRkFBPzO5VhzkFf/q5fJJhyU/xgIiTL2YQECeOhAkGWu4p4SKgQwNcKtM4V1FbAqda11ci59nR2+z2pSSlQSV7siD2gnfJxrxLhLYp6ob/6ICH8gvABa4ZBcg+m0GdUCS8j+WnwpO2QF1MyVjQdOGYn5eO2VMWAj8WuXszK+KiDXzn0AHuLMItwbF/scrlxr61dGTWjAoLqeBN1bdS7WDHrvuApcwVTbShXdzfTud3LSsY+QMZDwAuI3CMU5UFCpuakqTr5nHNmCFuf93iwKjOI8TxmYhTpJv8J6/Fy81606CfAjoajXATIpHBoO+qyi2tL3IwXN+PE9yykCP2H0Gl3b2r9i/0+kaVMmHgk2y+tro16adsy/uxQTJgOIhq4Wp1swPOF+5m6yHpyS3Sy/oGV6aZj1mJ53JguYLVTEts2VHaw/wEZPtmX7gcAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..380d5b4 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE71dW4/bthL+L86ruxVvuuTtNC2KAr0ESNqXRRA4Xu3GqG0ZtpyTRZD/fiiKsmYojkRT3vPkOhpyPs035McZS9tvi2P139Pi9f23xb+b/cPiNV8u9qtduXi9KL+U+/q0WC7Ox63+uqseztvy9GP7z3ef691WX1tvV6dTqSdYLL4vuzkYzy+zfPylsb/MYu27WdqrnsmWi8Pq2Ay84OinV6wHua72p/p4XtfVMcDHK2w+5s8OA255IvvbOpX6nwIcWruZnv7zWJfHPzbb7eZU6lt4OIW69g2ci6X+qVyFEPoKWd8iAs1U1916N2KG9/q4WpchTjvDOb6qd/Vxs38KctfbXueRJVwCj6tjvVmft6t6U+1/+znM82DMDATrz6v9vtwGrd6L6Qx/n3RKvK2C0qg3vdIf2P/+rOryrz3lrb36svsf8EHuf/Xp4YfN6YfN/nN53NTlg+cu7Y0QUT1s6vXnEASd4WhEx319KbfVelM/h7gDttd5DN7tobfBbh8T1/jd34UyvvvfBtuoGgwADdXgdhEaVQdvaIbqMBvNqFpAEEO1mO97Qj2Qe596zN4FQtUEIxlRk9mIJtQF7Y0edZntf0JtoH+f2kT5d9Xn8XHU/ePj/0F/rJNrDuAd9mjF6XyGSw7tLUhzOodXiQ7yeZ3qdP6iZWfc93W6A8HcRngm0E0rD4IULz0BUZrWnkF44sWHxjOtPh2MePkZ8R6iPxcAcwSIXqdXKVCP5QYSRGMK0aDL/jhDhGgEISrUIZgjQxgB0KG31fb57bE8nc5HMj+hzcsq0sDTnLoI3VqMVg3RBAlWiN8vq+05PN6vOvMYv8HKNXQbI1+hKII1zA9rtpAF4xxVMwJclKRdFblRXRsJWZS4hSAbVbghoCiZC8IxoXUeKJGCF7LOQ1XPh2qe9IWgm9A/z24cJ4IhWCaUcIglUg4pLEAT31T7+lht3+ibfSJTGhm9rCoOXc2RRXx3BBv78+5TeQ2gy4BRiQryPaqNHtdB4kh5DlZHj+MYeQzGEayPBLDZAhmOdFQhKXhREnld9EY1cixsUSIZhG1UJT2QomQyDMmETvrARApl0KoPVUovrnlSGYRvQit9e3ScWAahmVBLD5pIuSTRwBryWD0dV7txvURGL1xFDlzNKiPR3UXppQdQmF5SvsNruqHnqKIuFEd4VecHNr+sC0Y6XtcR8OIKu6uiN17ZjYQtrrQLwTZe2w0hxRV3QUimqjsPmNjyLmTdB9d3PlwzC7wQfFMVnmenjCzxQtBM1XhDNLFFHoUGVnntjU41Px2zF670PM5m1XrOPUZVXD5MYTUX6T286vI5j6q7wrGEV14UuPm11xVox6svEmJc/XVlFMcrsNHwxdVgYfjGqzAfrLg6LBDNVCXmBRRbi4XtCMHVmB/bzHosDONURebdSyNrsjBEU1WZD1FsXUYjgpVZ83vVT2P1QWfwwhUZcjOrGrvcUdQvaxhH2M9qHo/h9Rd2GFV7hfgPr7uGgObXXEEIx+stD6y4Wis4WuN1FhGmuBprCtN4fYWhxNVWkwim6ioHRGxNNbV6g+spF8/MWmoK11Qd5exvkTXUFIqp+gmjiK2dfCiAprxfHZ/KevTlIWDysrriOpqjLPC+qOw0JsFgLuaj+hLgd1TTBm6DVM3vNVjXBk5jlC0QQ7C2eUHNVrdQlKP65ocWpXDXRG1U4+hwRalcAK5RnRsunxilC0ExoXVDIJFqF7KjBOqdB9M8xQvANqF5w703TvUCkEzo3gBJpPIRuXOBob+WXy8gutduzb+OvnXbz6A96v/QK2z49m5/aXSutI/Ku7J+2w26TPd43q+bjEATQstxQQYAvT5/Dfb56818/n14WNXl2+35abN/Owyg17t/TAQOnhQZUz2Dw7uvnw+Yvlm3rZRI+1e0PzaTh3p6dTGfctgPJH/PbD6u83tnx4Q7v7OACQzn/aa+FoMdczMMu83+H3T4CsQBxt0Oy+prHJZ+3M2wPJSPq/O2jsLjjL0ZpvYn9b8e39Xl4XR18jqDb4aqLr9encV2zBwM7r71+2ZPo9AXb7A1/l49jbionm7g4o9qp61Xx2fa0cXkFu7K/XnEk756C0WhhG2YLC8gZ3jKYN8xrvslsdHbo57tsRqcgvpLoacgfc54bwb9BufrDwVgRmQ6fgcAIrgD1Uuzx+dmr+/4UdcsyOksj/hdle3qGZYtQf5e9aOm/IKh5EF8W63/fadXFy52w5AMBt8K0C/7h1g4/dBbgfm93D/Vn2OwXEbeAEpd7g5XZuarbswN3JvF/+d5Vx5XsHsXhmMw+FaAfi73lTaMhYSH3wDU+nm9vX5B96NuAGFbPtZv9IRlxAJyx94AznHz9Dkaz2BwHCCgU6hddZGo5l9D1ek9mgKokpnkPTEVRGsm+P5habsPr78tvmhd1ZPoi/xO3BXa+nFTbh/0yPuubltXu+YUtPhgr/1TNh3xxqI1+TFZLO+TpVR3Ra4+fFjedyPMBfMPxozpb8xnxpAZ19/4kmd3imfIjCMzob8Jn5lAZlJ/kz4zicyU/qZ8ZgqZpfpb6jNLkVmmv2VLru5SliKzDJnl+lvumy1HZpqU+8JnVuDwNtFmic+QOUQYJpjXEnPBmpgz7iUN08EERRvDhLAm8EwshbZkHFtiTlgTeyaXMrnLM2dOTAtLqWRgmBiWUenAMDUspxKCYXJYQaUEw/TwhEoKjtnhjEoL7iwUTiUGx9xwQWYGx+RwSWYGx+RwQ47yZQbH5PCUXNCYHJ6RmcExOzwnM4NjenhBZQbH9IiEygyB6RGMygyB6RGcygzh7GSCygyB2RGSygyByRGKygyBuREpmRkCkyMyMjMEJkcYclJfZghMjiiozBCYHJmQmSExO9JsbdlS8LuicCwxPZJTmSExPVKQEuJIjaQyQ2J6pKIyQ2J6ZEplhsTsyIzKDInJkTmVGRJzIwsyMyQmRyVkZihMjjLk5L7MUJgcRR4CFCZHma2t8O0ECrOjJJkZyjkLKCozFKZHpVRmKEyPysjjBaZH5VRmKEyPKqjMUJidNKEyI8XkpIzKjBRzk3IyM1JMTirIzEgxOWnDAPeeIVNMTqqozEido1pKZkaK2Ukziu8Us5PmFN8pZictKL5TzE6WUHxnmJ2MkUdKzE7GKb4zTE4mKL4zzE0mSb4zzE2mSL4zTE5mzgTeYiBzjtIZxXeGyclycn1nmJ2MPBNkmJ2cPBPkmJ2cPBPkmJ2cPBPkmJ2cPBPkmJ2cPBPkmJycPBPkmJucPhPkmJucPhPkTqXTMMC9dUSOycnJM0GOySkSku8Cs1Mwiu8Cs1Nwiu8Cs1MIiu8Cs1NIiu8Cs1Moiu8Cs1OkFN8FJqfIKL4LzE2Rk3wXTiFakHwXbi3aUMCFt3BMnGo0YRTl7SVoas4F0j+tU5AmgkyQ9hq0lVSKtJegqaKSpL0ETVMqTdpL0DSjEqW9BE1zKlXaS9C0oJKlvQRMTYvAmy5s0D1gZMIwt3/QNhCIVoNDWNtC8JaUzG0imFYB9xYZzG0jmGYBz/y2DmWmX8C9R1Tm9hJMy4AXfluHNNM1EN4DDnM7CqZxIPydMqepwEzvQBANGoc30z4Q/jXJ3b6PqY78C83pLjDTQxB+3pz+AjNdBOHnzekwMNNHEH7enB4DM60E4efNaTMw00wQft6cRgMz7QTp581pNTDTUZB+3pxuA2vbDX7enIYDM30F6efN6Tkw01qQft6E27Ezha3y9teczgMzDQbp581pPjDTY6DmdXgzXQbp59jpQDDTZ5B+jp0eBDOdBunn2OlCMNNsUH6OnUYEM+0G5efYaUUw03BQfo6dZgQzPQfl59jpRzDTdlB+jqXbbDU9Cf/adLoSzDQflJ9jpzHB6M4Ec1oTTJLdcGabE+b3iC/lsS4ffmt/l7i/vzyu9m3x0f5YobdEM2Xzs0WzEb7+9v17/+tE862Z/GPZvkzQj4PDiEHNM56H5hlPMAp5ayyXC71DmU+dbeZTJe2nrmbNp65yzGdurxdF+9lIHeG4+a223D98Mj8y9d516vbedcKOjN7aX3r7wTqXwWAqUGbwqfkFfeA8h+MzYvzlCV0QM+jYxobb2OjVbD6ljUnKbcxsTHN7vci7mFFkWceHy7v2PQAOSMtSajx8rQOM7YdaaMxC5xaasNCVvZ5aujNLd97RnZDQ2z+As7Z/3AZEDoRckaO7H2sB1RJEXApioH1Izr7LAVZUCka3ye0Zbd+rAeMAzQkx6KmsD/2DQCDKMLcYRZEeDZ/rAakJEQsKsX22GnhV0CsVpuY36CbGpbsgFBwuKa/b5qk4EFy4hDm1irYV4lPCFcSpdb9bfR1yCTFy6hZ35iE04I/DeFJkGhYf4BMLIDYCxoba58wM+/4xDDAeIpBU6mvHwzuGuc9Jz/1TfuC24ebOqR3SWECHECqngrWv6rJq/hg/WN2AG67GxqEMYsgfNcz+7ScwDCSesltYSq20dnj1eGofVQU3m0HnFGjvGhcwiRmVxPD1BbBS4QJn1FKzfzoZ3DPKQrtt221ZUkyZWT6Zd80AABD0nMTePQcHUgrGS1DhPpgnH71RkzCdBUW3MwGKnYRBENRSOlTbZ592MhB58sRxaP8WzlDAOOA8pWgzD9X4d1hIu6Sy7eRwBe7X5jmzUs2tFEsr1cpKdWpzIrPXC9ZJNoW58blq3mP71L7H1nsHkK1XZmcV1qu0XpU902T2TJTb64XsvFPycPG+Qy8dAs57EN1k9haFdSZtaJQFmVowub1edKedZCzsq8EpEexp9jaZnVnYoEqLSFlEqQ1Pbq8XHWkJtVxO1CkCLjZG4e5emQXj4BpLqDXWjhvUERwur4TaVOyDjyBOUGvIvah9Sh+kNjwncSo+xCEJHgVEF2RBhgm9/bdBKwxIiSWP23QRlnRpSU8tqZn1l9vrhSWfMfLWq5N9I7L3C+7ezs/t/MImleySyqZxZnHl9nrRrcmEknf7RF7vFCSVnZzbybsgSjupssHILKjcXi+6lZB0VUw3gklqibdvGQHmYZpxahc/m3fSxtSAw/Mno7wPTlUMREHa21M2ppm9qyLpbpM6Z/b/bxwwM1x8NlD+I+6HpdbmQ6kP1Nr4/sP37/8DER8rPMB0AAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..108428c --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1383 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/events.ChannelPressure.html b/docs/classes/events.ChannelPressure.html new file mode 100644 index 0000000..ef45f9e --- /dev/null +++ b/docs/classes/events.ChannelPressure.html @@ -0,0 +1,230 @@ +ChannelPressure | tslogic
+
+ +
+
+
+
+ +

Class ChannelPressure

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
value: number
+

Aftertouch value from 0–127.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.ControlChange.html b/docs/classes/events.ControlChange.html new file mode 100644 index 0000000..42fa89e --- /dev/null +++ b/docs/classes/events.ControlChange.html @@ -0,0 +1,240 @@ +ControlChange | tslogic
+
+ +
+
+
+
+ +

Class ControlChange

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
number: number
+

Controller number from 0–127.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
value: number
+

Controller value from 0–127.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.NoteOff.html b/docs/classes/events.NoteOff.html new file mode 100644 index 0000000..e5ef3b2 --- /dev/null +++ b/docs/classes/events.NoteOff.html @@ -0,0 +1,247 @@ +NoteOff | tslogic
+
+ +
+
+
+
+ +

Class NoteOff

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
pitch: number
+

Pitch from 1–127.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
velocity: number
+

Velocity from 0–127.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.NoteOn.html b/docs/classes/events.NoteOn.html new file mode 100644 index 0000000..6f8bdcb --- /dev/null +++ b/docs/classes/events.NoteOn.html @@ -0,0 +1,241 @@ +NoteOn | tslogic
+
+ +
+
+
+
+ +

Class NoteOn

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
pitch: number
+

Pitch from 1–127.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
velocity: number
+

Velocity from 0–127. A velocity value of 0 is interpreted as a note +off event, not a note on.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.PitchBend.html b/docs/classes/events.PitchBend.html new file mode 100644 index 0000000..48abe73 --- /dev/null +++ b/docs/classes/events.PitchBend.html @@ -0,0 +1,230 @@ +PitchBend | tslogic
+
+ +
+
+
+
+ +

Class PitchBend

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
value: number
+

14-bit pitch bend value from -8192–8191. A value of 0 is center.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.PolyPressure.html b/docs/classes/events.PolyPressure.html new file mode 100644 index 0000000..35312a5 --- /dev/null +++ b/docs/classes/events.PolyPressure.html @@ -0,0 +1,240 @@ +PolyPressure | tslogic
+
+ +
+
+
+
+ +

Class PolyPressure

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
pitch: number
+

Pitch from 1–127.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
value: number
+

Define a pressure value from 0–127.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.ProgramChange.html b/docs/classes/events.ProgramChange.html new file mode 100644 index 0000000..1ae6ae2 --- /dev/null +++ b/docs/classes/events.ProgramChange.html @@ -0,0 +1,230 @@ +ProgramChange | tslogic
+
+ +
+
+
+
+ +

Class ProgramChange

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
number: number
+

Program change number from 0–127.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events.TargetEvent.html b/docs/classes/events.TargetEvent.html new file mode 100644 index 0000000..640d02b --- /dev/null +++ b/docs/classes/events.TargetEvent.html @@ -0,0 +1,240 @@ +TargetEvent | tslogic
+
+ +
+
+
+
+ +

Class TargetEvent

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
target: string
+

Create user definable MIDI CC messages or control plug-in parameters.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+ +
value: number
+

Sets the target value.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/classes/events._Event.html b/docs/classes/events._Event.html new file mode 100644 index 0000000..8f6ea47 --- /dev/null +++ b/docs/classes/events._Event.html @@ -0,0 +1,217 @@ +_Event | tslogic
+
+ +
+
+
+
+ +

Class _Event

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
+ +
+
+

Properties

+
+ +
beatPos: any
+

Retrieves the event’s exact beat position.

+
+
+
+ +
channel: number
+

Set MIDI channel 1 to 16.

+
+
+
+ +
toarticulationID: number
+

Sets the articulation ID from 0–254.

+
+
+
+

Methods

+
+ +
    + +
  • +

    Send the event.

    +
    +

    Returns void

    +
+
+ +
    + +
  • +

    As above, but uses the beat value as a delay in beats from the current +position.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event after the specified value has elapsed (can be an integer +or a floating point number).

    +
    +
    +

    Parameters

    +
      +
    • +
      ms: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Send the event at a specific beat (floating point number) in the host +timeline.

    +
    +
    +

    Parameters

    +
      +
    • +
      beat: number
    +

    Returns void

    +
+
+ +
    + +
  • +

    Returns a String representation of the event.

    +
    +

    Returns string

    +
+
+ +
    + +
  • +

    Print the event to the plug-in console. See Use the Trace object.

    +
    +

    Returns void

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/parameters.GetParameter.html b/docs/functions/parameters.GetParameter.html new file mode 100644 index 0000000..7c198fc --- /dev/null +++ b/docs/functions/parameters.GetParameter.html @@ -0,0 +1,56 @@ +GetParameter | tslogic
+
+ +
+
+
+
+ +

Function GetParameter

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
    +

    Returns number

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/parameters.SetParameter.html b/docs/functions/parameters.SetParameter.html new file mode 100644 index 0000000..5e0c136 --- /dev/null +++ b/docs/functions/parameters.SetParameter.html @@ -0,0 +1,58 @@ +SetParameter | tslogic
+
+ +
+
+
+
+ +

Function SetParameter

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      name: string
    • +
    • +
      value: number
    +

    Returns void

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/parameters.UpdatePluginParameters.html b/docs/functions/parameters.UpdatePluginParameters.html new file mode 100644 index 0000000..c1304ab --- /dev/null +++ b/docs/functions/parameters.UpdatePluginParameters.html @@ -0,0 +1,51 @@ +UpdatePluginParameters | tslogic
+
+ +
+
+
+
+ +

Function UpdatePluginParameters

+
+
    + +
  • +

    Returns void

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/timinginfo.GetTimingInfo.html b/docs/functions/timinginfo.GetTimingInfo.html new file mode 100644 index 0000000..b8a4be9 --- /dev/null +++ b/docs/functions/timinginfo.GetTimingInfo.html @@ -0,0 +1,55 @@ +GetTimingInfo | tslogic
+
+ +
+
+
+
+ +

Function GetTimingInfo

+
+
    + +
  • +

    NB this needs NeedsTimingInfo to be set at the top-level scope to +return a timing info object

    +
    +

    Returns TimingInfo

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/functions/trace.Trace.html b/docs/functions/trace.Trace.html new file mode 100644 index 0000000..3941262 --- /dev/null +++ b/docs/functions/trace.Trace.html @@ -0,0 +1,56 @@ +Trace | tslogic
+
+ +
+
+
+
+ +

Function Trace

+
+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      message: any
    +

    Returns void

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..32796df --- /dev/null +++ b/docs/index.html @@ -0,0 +1,50 @@ +tslogic
+
+ +
+
+
+
+

tslogic

+

tslogic

Type defitions for Logic Pro' Scripter.

+

Events

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/interfaces/timinginfo.TimingInfo.html b/docs/interfaces/timinginfo.TimingInfo.html new file mode 100644 index 0000000..b7a0342 --- /dev/null +++ b/docs/interfaces/timinginfo.TimingInfo.html @@ -0,0 +1,170 @@ +TimingInfo | tslogic
+
+ +
+
+
+
+ +

Interface TimingInfo

+
+

Hierarchy

+
    +
  • TimingInfo
+
+
+
+ +
+
+

Properties

+
+ +
blockEndBeat: number
+

A floating point number indicates the beat position at the end of the +process block.

+
+
+
+ +
blockLength: number
+

A floating point number indicates the length of the process block in +beats.

+
+
+
+ +
blockStartBeat: number
+

A floating point number indicates the beat position at the start of the +process block. An alternative is to use the beatPos property. See Use +the MIDI event beatPos property.

+
+
+
+ +
cycling: boolean
+

Uses Boolean logic where “true” means the host transport is cycling.

+
+
+
+ +
leftCycleBeat: number
+

A floating point number indicates the beat position at the start of the +cycle range.

+
+
+
+ +
meterDenominator: number
+

An integer number indicates the host meter denominator.

+
+
+
+ +
meterNumerator: number
+

An integer number indicates the host meter numerator.

+
+
+
+ +
playing: boolean
+

Uses Boolean logic where “true” means the host transport is running.

+
+
+
+ +
rightCycleBeat: number
+

A floating point number indicates the beat position at the end of the +cycle range.

+
+
+
+ +
tempo: number
+

A floating point number indicates the host tempo.

+
+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/events.html b/docs/modules/events.html new file mode 100644 index 0000000..62763cf --- /dev/null +++ b/docs/modules/events.html @@ -0,0 +1,58 @@ +events | tslogic
+
+ +
+
+ +
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 0000000..98e61ea --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1,43 @@ +index | tslogic
+
+ +
+
+
+
+ +

Module index

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/parameters.html b/docs/modules/parameters.html new file mode 100644 index 0000000..b4c5e3c --- /dev/null +++ b/docs/modules/parameters.html @@ -0,0 +1,62 @@ +parameters | tslogic
+
+ +
+
+
+
+ +

Module parameters

+
+
+

Index

+
+

Type Aliases

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/timinginfo.html b/docs/modules/timinginfo.html new file mode 100644 index 0000000..c9983cf --- /dev/null +++ b/docs/modules/timinginfo.html @@ -0,0 +1,54 @@ +timinginfo | tslogic
+
+ +
+
+
+
+ +

Module timinginfo

+
+
+

Index

+
+

Interfaces

+
+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/modules/trace.html b/docs/modules/trace.html new file mode 100644 index 0000000..bb31b20 --- /dev/null +++ b/docs/modules/trace.html @@ -0,0 +1,50 @@ +trace | tslogic
+
+ +
+
+
+
+ +

Module trace

+
+
+

Index

+
+

Functions

+
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.Lin.html b/docs/types/parameters.Lin.html new file mode 100644 index 0000000..10d286e --- /dev/null +++ b/docs/types/parameters.Lin.html @@ -0,0 +1,52 @@ +Lin | tslogic
+
+ +
+
+
+
+ +

Type alias Lin

+
Lin: Parameter & {
    type: "lin";
}
+
+

Type declaration

+
    +
  • +
    type: "lin"
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.Log.html b/docs/types/parameters.Log.html new file mode 100644 index 0000000..25a6c4e --- /dev/null +++ b/docs/types/parameters.Log.html @@ -0,0 +1,52 @@ +Log | tslogic
+
+ +
+
+
+
+ +

Type alias Log

+
Log: Parameter & {
    type: "log";
}
+
+

Type declaration

+
    +
  • +
    type: "log"
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.Menu.html b/docs/types/parameters.Menu.html new file mode 100644 index 0000000..03b49b5 --- /dev/null +++ b/docs/types/parameters.Menu.html @@ -0,0 +1,52 @@ +Menu | tslogic
+
+ +
+
+
+
+ +

Type alias Menu

+
Menu: Parameter & {
    valueStrings: string[];
}
+
+

Type declaration

+
    +
  • +
    valueStrings: string[]
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.Momentary.html b/docs/types/parameters.Momentary.html new file mode 100644 index 0000000..d77a829 --- /dev/null +++ b/docs/types/parameters.Momentary.html @@ -0,0 +1,52 @@ +Momentary | tslogic
+
+ +
+
+
+
+ +

Type alias Momentary

+
Momentary: Parameter & {
    type: "momentary";
}
+
+

Type declaration

+
    +
  • +
    type: "momentary"
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.Parameter.html b/docs/types/parameters.Parameter.html new file mode 100644 index 0000000..2454dee --- /dev/null +++ b/docs/types/parameters.Parameter.html @@ -0,0 +1,86 @@ +Parameter | tslogic
+
+ +
+
+
+
+ +

Type alias Parameter

+
Parameter: {
    defaultValue?: number;
    maxValue?: number;
    minValue?: number;
    name: string;
    numberOfSteps?: number;
    text?: string;
    unit?: "ms";
}
+
+

Type declaration

+
    +
  • +
    Optional defaultValue?: number
    +

    Type an integer or floating point number to set a default value. If no +value is typed, the default is 0.0.

    +
    +
  • +
  • +
    Optional maxValue?: number
    +

    Type an integer or floating point number to set a maximum value. If no +value is typed, the default is 1.0.

    +
    +
  • +
  • +
    Optional minValue?: number
    +

    Type an integer or floating point number to set a minimum value. If no +value is typed, the default is 0.0.

    +
    +
  • +
  • +
    name: string
  • +
  • +
    Optional numberOfSteps?: number
    +

    Type an integer number to define the number of steps.

    +
    +
  • +
  • +
    Optional text?: string
    +

    Type text to create a divider or header in the plug-in UI.

    +
    +
  • +
  • +
    Optional unit?: "ms"
    +

    Type a string to present a unit description in the plug-in controls. If +no value is typed, the default behavior is to display no unit.

    +
    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.PluginParameter.html b/docs/types/parameters.PluginParameter.html new file mode 100644 index 0000000..53b9995 --- /dev/null +++ b/docs/types/parameters.PluginParameter.html @@ -0,0 +1,47 @@ +PluginParameter | tslogic
+
+ +
+
+
+
+ +

Type alias PluginParameter

+
PluginParameter: Lin | Log | Momentary | Menu
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/types/parameters.PluginParameters.html b/docs/types/parameters.PluginParameters.html new file mode 100644 index 0000000..21bc632 --- /dev/null +++ b/docs/types/parameters.PluginParameters.html @@ -0,0 +1,47 @@ +PluginParameters | tslogic
+
+ +
+
+
+
+ +

Type alias PluginParameters

+
PluginParameters: PluginParameter[]
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index dfa8bdd..9d83c08 100644 --- a/package-lock.json +++ b/package-lock.json @@ -8,21 +8,102 @@ "name": "tslogic", "version": "1.0.0", "license": "ISC", - "bin": { - "tslogic": "cli.sh" - }, "devDependencies": { - "@types/node": "^20.8.7", + "typedoc": "^0.25.2", "typescript": "^5.2.2" } }, - "node_modules/@types/node": { - "version": "20.8.7", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.8.7.tgz", - "integrity": "sha512-21TKHHh3eUHIi2MloeptJWALuCu5H7HQTdTrWIFReA8ad+aggoX+lRes3ex7/FtpC+sVUpFMQ+QTfYr74mruiQ==", + "node_modules/ansi-sequence-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", + "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", + "dev": true + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/jsonc-parser": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz", + "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", + "dev": true + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, + "node_modules/minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/shiki": { + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.5.tgz", + "integrity": "sha512-1gCAYOcmCFONmErGTrS1fjzJLA7MGZmKzrBNX7apqSwhyITJg2O102uFzXUeBxNnEkDA9vHIKLyeKq0V083vIw==", "dev": true, "dependencies": { - "undici-types": "~5.25.1" + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, + "node_modules/typedoc": { + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.2.tgz", + "integrity": "sha512-286F7BeATBiWe/qC4PCOCKlSTwfnsLbC/4cZ68oGBbvAqb9vV33quEOXx7q176OXotD+JdEerdQ1OZGJ818lnA==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.3", + "shiki": "^0.14.1" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 16" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x" } }, "node_modules/typescript": { @@ -38,10 +119,16 @@ "node": ">=14.17" } }, - "node_modules/undici-types": { - "version": "5.25.3", - "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.25.3.tgz", - "integrity": "sha512-Ga1jfYwRn7+cP9v8auvEXN1rX3sWqlayd4HP7OKk4mZWylEmu3KzXDUGrQUN6Ol7qo1gPvB2e5gX6udnyEPgdA==", + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", "dev": true } } diff --git a/package.json b/package.json index ab76a12..b39341d 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "author": "Jeremy Ruppel", "types": "./types/index.d.ts", "scripts": { + "docs": "typedoc types/*.d.ts", "tsc": "tsc --noEmit types/index.d.ts" }, "files": [ @@ -17,6 +18,7 @@ "semi": false }, "devDependencies": { + "typedoc": "^0.25.2", "typescript": "^5.2.2" } } diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..6e6944e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,6 @@ +{ + "compilerOptions": { + "target": "es6", + "skipLibCheck": true + } +}