From 6a5af3793060b290ae1813322e9793200b4e9bfd Mon Sep 17 00:00:00 2001 From: TechQuery Date: Tue, 28 May 2024 19:07:16 +0000 Subject: [PATCH] deploy: d633176aca52269d5c1e6297ba8913c252eefb40 --- .nojekyll | 1 + assets/highlight.css | 120 +++ assets/icons.js | 15 + assets/icons.svg | 1 + assets/main.js | 59 ++ assets/navigation.js | 1 + assets/search.js | 1 + assets/style.css | 1412 +++++++++++++++++++++++++++++ classes/BaseListModel.html | 15 + classes/BaseModel.html | 5 + classes/DownloadTask.html | 23 + classes/Downloader.html | 9 + classes/HTTPDownloadTask.html | 23 + classes/ListModel.html | 37 + functions/Buffer.html | 1 + functions/Stream.html | 1 + functions/destroy.html | 1 + functions/persist.html | 1 + functions/restore.html | 1 + functions/toggle.html | 1 + functions/toggleNotification.html | 1 + hierarchy.html | 1 + index.html | 62 ++ interfaces/PageData.html | 3 + modules.html | 21 + types/DataObject.html | 1 + types/Filter.html | 1 + types/IDType.html | 1 + types/NewData.html | 1 + types/RESTClient.html | 1 + types/Statistic.html | 1 + 31 files changed, 1822 insertions(+) create mode 100644 .nojekyll create mode 100644 assets/highlight.css create mode 100644 assets/icons.js create mode 100644 assets/icons.svg create mode 100644 assets/main.js create mode 100644 assets/navigation.js create mode 100644 assets/search.js create mode 100644 assets/style.css create mode 100644 classes/BaseListModel.html create mode 100644 classes/BaseModel.html create mode 100644 classes/DownloadTask.html create mode 100644 classes/Downloader.html create mode 100644 classes/HTTPDownloadTask.html create mode 100644 classes/ListModel.html create mode 100644 functions/Buffer.html create mode 100644 functions/Stream.html create mode 100644 functions/destroy.html create mode 100644 functions/persist.html create mode 100644 functions/restore.html create mode 100644 functions/toggle.html create mode 100644 functions/toggleNotification.html create mode 100644 hierarchy.html create mode 100644 index.html create mode 100644 interfaces/PageData.html create mode 100644 modules.html create mode 100644 types/DataObject.html create mode 100644 types/Filter.html create mode 100644 types/IDType.html create mode 100644 types/NewData.html create mode 100644 types/RESTClient.html create mode 100644 types/Statistic.html diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 0000000..6c083f8 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,120 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #0451A5; + --dark-hl-1: #9CDCFE; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #001080; + --dark-hl-5: #9CDCFE; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #795E26; + --dark-hl-7: #DCDCAA; + --light-hl-8: #267F99; + --dark-hl-8: #4EC9B0; + --light-hl-9: #000000FF; + --dark-hl-9: #D4D4D4; + --light-hl-10: #800000; + --dark-hl-10: #808080; + --light-hl-11: #800000; + --dark-hl-11: #569CD6; + --light-hl-12: #E50000; + --dark-hl-12: #9CDCFE; + --light-hl-13: #098658; + --dark-hl-13: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +pre, code { background: var(--code-background); } diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 0000000..d6f1388 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 0000000..9262e01 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42QTU/CQBBA/8ueiUgjqBwRjSaKRHozHsbttKyUbrMzBBvjfzdkK/1kl+u8ea/def8RjN8spmIGhM+K+EVHmIqByIHXYipkCkRIwwa+WPP2sLNRWSSmo+Dmd9DoOBpef673WaohCoE23USdnlNBc7qBxlV4DMOl+1/aG66a47JnXXUJCc6BodJVxmhikEjDf9gMBONJ/SDA8Pr5hZKrBBf54RxH0vIvb69H46DWeFAp1w9qfTv1uU/zsMix7dqpz13gvvl2K5djn/12vwrvUoVZ5+UV8TVWDKyIlWwnjsBXmO3iuH67eJdJVjqjoSVNf3LV+LhB2PapljjUCImNLvrcEjnkHA0p4j65RA7ZILE22CeXyCGzTpK017XEqy40q1hJOEinM/WtTvLjDxgFbK0bBQAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 0000000..2c5ad5d --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71d33PbNhL+X+hXxREI8Jffru11mrsm6TS5e/FkMqxE22xkUSPSSdNM/vcbgCC1C+5SIEXfkxxzsbvYb7HAfmLgb8Gx+lIHN7ffgk/lfhvchOssEVG4Cvb5YxHcBK9+ev/1UASr4Om4C26C5uuhqF+2v7x+aB53wSrY7PK6LurgJgi+rzg9P+VN/vaPP4tN4+g6PZik703xRY90lNnfTtL0+z/fvf9xVxZ717PTg1F9sepVNdX9/e4UrLun/aYpq339sn0wriaKZNxr+vixgWEnNV3Zn3tZoHcVHPKjnlLn1LX1bTmD9uOF6H4I/VzAw8cC+aZqyrtyk2tHWM+g0HIBHmi9In7vFXg0gpjX8zs4GagzLvsAeCiOdVk3hPv2yRJQQVVX3T/OgNKJdQ6S3h+LuqmOlEn7xLcgbIu6OVZfCUX2yagiEaa9ph/yunhdbYtdr8sOedk/GdUViVPF21T7ujk+bZrqeEbbFRalQ3pyDRTZOBQKxKH6st9V+bbc35+ziEVnW3w6eNqDghOsrdUJm82uyM9H0gr523Dh/7WsGz4F+qdnNj/o97HIm+JNUTfF1kPnlSPPz+Tk6bwEdO0ySdjU2xdl/aLcPxTHsvXprBtiHSoAHNr2x1zoJKdNGln7I6+L//z+ysfcSfQCe+V+W/z17+Krj0EgO82is+w2T0c94O2+8IoqlJ5od7AAf2yV+aGJ5C+17G3yMltPh23eFJ6hhcIX2LwvfLHsJS+wti12hfcMofBFOXtuc3LtMhvUnGo0adMaILyUF+DA8sPT3V1xJM4r7QPfc8+75ljkj4Sa9sGk/uznctcAl9rerP3luJ7odIT8Lb8vULtY7pvieJdvivpl92z8KAYL68FX2xWQpFO0d4wx1VRNvvuxegJ1jTWGZL3NueF+1+RNWTflxol4/3vvIyt/Xln6rOJ7ThlbHJecWRY4r3hUB51Mr/Q+fc4+FKTzwNPau/LvYSkmjFm52bbu8BJnLPVSs+0Qq4mx5bGWPGP4K2yDR2Jo5WbbsmcpvcLP5icSvWh2XsGEgrOt5bvdq6Z4rM8ZA3Kzbe2r17D9Zyz1UrPt1INay5iCghOsDU6qPskIBS+x5WVnvg3LxPjMCIvOtNc8Hffvq7N1o5OaaUUf6XyWMJAb7C+HY9UUG5/9xbX8pvjia/wkupD9+6LxwfIkNjtv7o5F/eCXN1B0pr37ovnH7twR6KqXmrvidHn1sAPkZloyTMHbu3OGTmJzZ/SQ7+/JXtCdEhCcaYvvrCd31R7591h99rEFBWfa4vvpyb30XC7tPI829VTsxal58GkX2WW5NR9e7cI+YIRj8+PXJtv35tp8ebaLPGA4qfN81IVxH+OJFuCILuKHLuaGyIwHzfxPdkZEm3Z6NIFCOVZNtal2r/PDOX1XWJYuT8C9UQLhfV5/OmvwJDryVSlp0ZcwGFj0+JqNnqLT4Ob1p2GH5FrrpObbedrflfuyfii2dAPoWhzKz7dd/FVsnppyf+9neiD+f02gC+zZb4i9DGLZCRbhEv/l/fvfOiHSqivgz97pD+LMSCq86oX9KtfA7enLkfbDZ1GOGPc5HTGGx79sHLE56OgcIn7cLhow3TZepuWQpqWtlv4crb918+Gfbs/gwSFvHjw9sKJLe3BX/5LvtzvfOADxpT0xbKqnG53s0j6Y0uebk73w4llRHDf+heAkvbQf/a7o6QmUX9qX6mC+G/T05CR9sR+oQtdTKmU9rJILrhTya5eR1TL4+mXJFTPBGTTgcm8Q+1r9693bN95BscIX+zD6IqKPE9ftR//upffGeo3Gj349fJFD10bFCzHTseFLoMi/SUWXcbDV8VweTivIjItWyXP56H2UYtwrny16E45ZjG9aw7Nh638E44DNm4fn8m7i8YzxsNPyXF5O25wZJ62SBX1Em0Odfy5eF+B9nDOb90l82U2qbvKjbyXpZJf14JA/1b4J1cku64H7xvu4DyfpZb2o9j9bvsn3VAkHXH6wJIjTUR5nETbFi0mhGKGZrMk8xuQCtmQyUzKbqTjLUky3Qm6VHmzEdEvktufBOky3xG5hnuzCdIv0gdeHRZhuizm8erEFM1BjDqJ+rMB0ezwD4Nv9T7fJHSb8uvypVYTp6L26+ZmZSTbLvl373Az1NMp05z5WPTpxry7cw5ZXx31xt71Up71Yl710h71cd714Z71gV71kR71MN71sJ71UF71sB71U97x857xk17x4x7xgt7x8p+zZJU/dLEa+gpz19eP8LtynA59qie62fTrtqZa4rtqvo55qbaR79u6ceZsfVu3bc8HNt+Cz/l/41T64CcJreZ0Fq+CuLHZbfSFJVxE31eOjVvPBPvtvodtLLdGKvFwHq9v1SsXX6yj88GF1240wD8wvjJgIVreCEhNILAxWtyElFiIxGaxuJSUmkZgKVreKElNILApWt9EqzK6zKEFiERKLObEYiSXB6jamjCZILOW0pUgs48QyHF4d7YSMr4OD4BQKjITQEU9JjRgLoWOerWRyHSUZFsRoCB11QeaKwIAIHXghVlJcyzTFkhgToWMvQtI6hkXo8AtJSmJkhEZAKFISgyM0CCIiZ4TxCTUKIl6p9XWmJM5sDFAo2LmHzlrROIhkJaPrdRxjSQxRqIEQKWkdYxQajDJSEmMUaiDCNSmJMQo1EKEgJTFGYcJGPsQYhRqIMCR1YoxCDUQoSUmMkdRAhIqSlBgjKdiskxgjGbJZJ52SpoEIyVySGCOpgQhjUifGSBqMEnJGGCNpMCIzRGKMZMJLYoykwYjMJYkxkhoISeaSxBgpDYQkNxKFMVKCXXEKY6RCdsUpjJEy+w65Pyln59FASHKLUhgjxWOkMEYqZuOpMEZKAyHpnQ9jpDQQksw6hTFSBiNyY1MYo8hgRG5GEcYo0kBIcpOJMEZRyGZIhDGKDEYZqRNjFCm22kTOAUEDocidK8IYRRoIReZnhDGKNBCKzKUIYxRpIBSZSxHGKNJAKBL3CGMUayAUiXuMMYo1EIrEPcYYxRoIReIeY4xiDYQicY8xRrE5wpFoxhijOGJ3hNg5x5mDHIlmjDGKE3ZHiDFGccruxTHGKM7YvTjGGCVrdi9OMEaJYPfiBGOUhOxenGCMEsnumwnGKFHsbphgjJKI3Q0TjFFiMCLXUeIctzUQEbmOEoxRYo7c9IwwRknG7ggJxijVQETkiksxRqk5eJMrLsUYpRqIiFxxKcYoleyMUoxRqoGIyLWZYoxS0w2RazPFGKUGIzI/U4xRmrDxTJ2uiF9HKcYo1UDEZM6nGKNMAxELSmeGMco0EHFISmKMMg1ELElJjFGmgYgVKYkxyjQQcURKYowyDUQck5IYo0wDEZPxzDBGmelbybqUYYwyDUSckTqd5jVjT6qZ27+aBpaEs30GZTUWCVnE2mdQVqORkNtC+wzKSrY3Xjut7JrHqn0GZXm02mdQlserfQZlEzav22dQNmUzu30GZTM2t9tnQNawC3R2iwHzINi8ES75YDiGhKxswuUfDM2QkLu0cCkIQzQkES3r4GaoBprYcFkIwzUkZLMhXB7CsA0JzdW4TIThG+gSK1wuQvCblnDYCNHSEXSaOXyEMKwDk2ahyxmFfJo5nIQwzAOTZg4rIQz3wKSZw0sIwz4wS9NhJoThH5il6XATwjAQzNJ02AlhOAi6mAqHnxCGhWCWhcNQiJaiIAuqcDgKYZgIpqI6LIUwXARTUaVL90m+ojpMhTB8BF1RHapCyBHYHLJCyBHYHLpCyBHYHMJCGFqCSXWHshCGmGBS3SEthKEmmFR3aAthyAkm1R3iQhh6gkkdh7oQhqBgKqpyiVrFnq2EQ18IQ1Iw1dchMIShKZjq61AYwhAVdPV1OAxhmAqm+loWw3zr8bk4NsW2vZpLf3/RvaXwLfhovxKJui9hvgVRcPPt+yqI24+0/cjaDyHs51raH6TSP3w/fV+i/6UdyXe7sr0P6WRFJsDMmhmo70zYlXXz2F7hdhotgJMiGxk9HLkGIzmH9cinY4nGpadxoZ1xzFq2VxiehofAYSmZYe01ItUewaGy08iYc9heZATcVWCaFrgwaT+jUS2b7q4E4LwAc7fJkIRjSnbmvhqANphExE7fvkkJZgGSJAxt0O1sUvup92pGH3wVFCgFsxE2w0ObzMoaSWySp0mX7BzU5jabfIdyTAG3YzZO5j9o7+0NgcC9GMx5bd0So0oa814vWMHypCLpwsVGvcXbyboQLJPQBilhvWhVHMxlTAB0kPMqZcZu8yav7B9lAEEAEHEDzX0xrtsg7aUNXpywGuz31KfxIE1FV9a6HNEld1TRAAaQBim35rprOnC5iEAAkvjMUPNSJIhdCCZhV6u0+Z2cc8OdQwLmoE/m9GjwcuZpaAwqZtato5DLg17Fpr0jAcQCLIiUW03dxYwgFYDn0kKoIm54/WBf5wH+g1zK+mRYdxNRXVZwCXpfDOoCmEk8Msytngp4EnGF6L4YrGFQBkJb0BKuDDw0zYFLggggmXIhLFEVi0ECZ13M1n0WdGcHyaVDuXWPJaAgcQXfSH4q0IoWYEl3mCWjCqo7FHsw95gLHnlGkSAEirPYvTsJIgeSJOtKz7r7odt+9RF/TGNt3rEF6xhW1HUffm45aSX74otb0RXIqIiDTo8dDAQ1KeKqiB7YvQcN4gGAT7uzp+LqmJGEo4HhrD+x9keHsAsEt6r0WJwQEUiotENDcMHYF1+25vJlsCxBQnKjqkdzrSdIJpCGEVc6qv6KGwR9DEt45zG7IffvDoIggilnXez683/Yg8JNR2fDoKxL4Jbiwq9HDuIHQiG7/Y3LKa2gHQdNAwgUt6b1yMExFhRi9jSgB7rLT4KFw+Zu+6YrCDsYlHWZuu6i3TUhgq0t9p0/kAmwaxL9BsZVkv7taeAS2FSzLpXW3Q9dgyF4OLq/yQOcgoWJG2av33rU12+BpQhwTDiT9gbNwZ4KYhFzdtv7D51tNQIFKeZip+97HfYzAFAu7fq/+3MaBfJdcEvMDhvMEvgacTu3fs32scCLLJEwVbrkYxeLfZEVjIf9Z3+UZs9f4HJhEC3gvLRpH3EBGG4cISgw0iZ71q0eyUFuLyYDcIOZpOwo+1fXQOTBgh8dtEd/YQwsNZDbrII/azwogWf/db+7cbDZ/1ECjIJVkXUFYt390DWCQnI4GoWDUh+C/UPa/YOtOkbF4PgCWZt1d56U3Eaor0BuKgQHOP9EnOnTFXHDJgQEJuXMtlezuqdwuN/bycdc/MClieAIC9eiLbGyIypITR9WwaE8FLtyXwQ3tx++f/8fiVa5q2RxAAA="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000..778b949 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1412 @@ +: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-keyword: #056bd6; + --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: #a55c0e; + --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-keyword: #3399ff; + --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: #e07d13; + --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-keyword: var(--light-color-ts-keyword); + --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-keyword: var(--dark-color-ts-keyword); + --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-keyword: var(--light-color-ts-keyword); + --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-keyword: var(--dark-color-ts-keyword); + --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:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +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 */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +.tsd-generator { + margin: 0 1em; +} + +.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: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + 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-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.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.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + 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-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-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/BaseListModel.html b/classes/BaseListModel.html new file mode 100644 index 0000000..0994369 --- /dev/null +++ b/classes/BaseListModel.html @@ -0,0 +1,15 @@ +BaseListModel | MobX RESTful

Class BaseListModel<D>Abstract

This basic class is a middle class, which isn't for direct using

+

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Properties

baseURI +client +indexKey +

Accessors

currentOne +downloading +uploading +

Methods

clear +clearCurrent +deleteOne +getOne +updateOne +createNested +

Constructors

constructor

Properties

Abstract baseURI

baseURI: string

Abstract client

client: RESTClient

indexKey

indexKey: keyof D = 'id'

Accessors

currentOne

currentOne

downloading

downloading

uploading

uploading

Methods

clear

clearCurrent

deleteOne

getOne

updateOne

Static createNested

Settings

Member Visibility

Theme

On This Page

constructorbaseURIclientindexKeycurrentOnedownloadinguploadingclearclearCurrentdeleteOnegetOneupdateOnecreateNested
\ No newline at end of file diff --git a/classes/BaseModel.html b/classes/BaseModel.html new file mode 100644 index 0000000..58b3a08 --- /dev/null +++ b/classes/BaseModel.html @@ -0,0 +1,5 @@ +BaseModel | MobX RESTful

Class BaseModelAbstract

Hierarchy (view full)

Constructors

constructor +

Accessors

downloading +uploading +

Methods

clear +

Constructors

constructor

Accessors

downloading

downloading

uploading

uploading

Methods

clear

Settings

Member Visibility

Theme

On This Page

constructordownloadinguploadingclear
\ No newline at end of file diff --git a/classes/DownloadTask.html b/classes/DownloadTask.html new file mode 100644 index 0000000..caadfcb --- /dev/null +++ b/classes/DownloadTask.html @@ -0,0 +1,23 @@ +DownloadTask | MobX RESTful

Class DownloadTaskAbstract

Hierarchy (view full)

Implements

Constructors

constructor +

Properties

client +stream? +

Accessors

executing +fsHandle +id +loaded +loadedSize +name +options +path +percent +total +totalSize +

Methods

destroy +loadStream +onFinished +pause +saveMeta +start +toJSON +nameOf +

Constructors

constructor

Properties

Abstract client

client: Pick<HTTPClient<Context>, "download">

Optional stream

stream?: ReadableStream<Partial<TransferProgress>>

Accessors

executing

executing

fsHandle

fsHandle

id

id

loaded

loaded

loadedSize

name

name

options

options

path

path

percent

percent

total

total

totalSize

Methods

destroy

Abstract loadStream

onFinished

pause

saveMeta

start

toJSON

  • toJSON(): {
        fsHandle: FileSystemHandle;
        id: string;
        loaded: number;
        name: string;
        options: DownloadOptions;
        path: string;
        percent: number;
        total: number;
    }

  • Returns {
        fsHandle: FileSystemHandle;
        id: string;
        loaded: number;
        name: string;
        options: DownloadOptions;
        path: string;
        percent: number;
        total: number;
    }

    • fsHandle: FileSystemHandle
    • id: string
    • loaded: number
    • name: string
    • options: DownloadOptions
    • path: string
    • percent: number
    • total: number

Static nameOf

Settings

Member Visibility

Theme

On This Page

constructorclientstreamexecutingfsHandleidloadedloadedSizenameoptionspathpercenttotaltotalSizedestroyloadStreamonFinishedpausesaveMetastarttoJSONnameOf
\ No newline at end of file diff --git a/classes/Downloader.html b/classes/Downloader.html new file mode 100644 index 0000000..219e5d8 --- /dev/null +++ b/classes/Downloader.html @@ -0,0 +1,9 @@ +Downloader | MobX RESTful

Class Downloader

Constructors

constructor +

Properties

protocolMap +

Accessors

executingCount +tasks +unfinishedCount +

Methods

createTask +destroyTask +createTask +

Constructors

constructor

Properties

Static protocolMap

protocolMap: Record<string, Constructor<DownloadTask>> = ...

Accessors

executingCount

tasks

tasks

unfinishedCount

Methods

createTask

destroyTask

Static createTask

Settings

Member Visibility

Theme

On This Page

constructorprotocolMapexecutingCounttasksunfinishedCountcreateTaskdestroyTaskcreateTask
\ No newline at end of file diff --git a/classes/HTTPDownloadTask.html b/classes/HTTPDownloadTask.html new file mode 100644 index 0000000..3c652f9 --- /dev/null +++ b/classes/HTTPDownloadTask.html @@ -0,0 +1,23 @@ +HTTPDownloadTask | MobX RESTful

Class HTTPDownloadTask

Hierarchy (view full)

Constructors

constructor +

Properties

client +stream? +

Accessors

executing +fsHandle +id +loaded +loadedSize +name +options +path +percent +total +totalSize +

Methods

destroy +loadStream +onFinished +pause +saveMeta +start +toJSON +nameOf +

Constructors

constructor

Properties

client

client: Pick<HTTPClient<Context>, "download"> = ...

Optional stream

stream?: ReadableStream<Partial<TransferProgress>>

Accessors

executing

executing

fsHandle

fsHandle

id

id

loaded

loaded

loadedSize

name

name

options

options

path

path

percent

percent

total

total

totalSize

Methods

destroy

loadStream

onFinished

pause

saveMeta

start

toJSON

  • toJSON(): {
        fsHandle: FileSystemHandle;
        id: string;
        loaded: number;
        name: string;
        options: DownloadOptions;
        path: string;
        percent: number;
        total: number;
    }

  • Returns {
        fsHandle: FileSystemHandle;
        id: string;
        loaded: number;
        name: string;
        options: DownloadOptions;
        path: string;
        percent: number;
        total: number;
    }

    • fsHandle: FileSystemHandle
    • id: string
    • loaded: number
    • name: string
    • options: DownloadOptions
    • path: string
    • percent: number
    • total: number

Static nameOf

Settings

Member Visibility

Theme

On This Page

constructorclientstreamexecutingfsHandleidloadedloadedSizenameoptionspathpercenttotaltotalSizedestroyloadStreamonFinishedpausesaveMetastarttoJSONnameOf
\ No newline at end of file diff --git a/classes/ListModel.html b/classes/ListModel.html new file mode 100644 index 0000000..5ca5ae0 --- /dev/null +++ b/classes/ListModel.html @@ -0,0 +1,37 @@ +ListModel | MobX RESTful

Class ListModel<D, F>Abstract

This basic class is a middle class, which isn't for direct using

+

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Properties

baseURI +client +indexKey +

Accessors

allItems +currentOne +currentPage +downloading +filter +noMore +pageCount +pageIndex +pageList +pageSize +statistic +totalCount +uploading +

Methods

changeOne +clear +clearCurrent +clearList +countAll +deleteOne +getAll +getList +getOne +indexOf +loadNewPage +loadPage +refreshList +removeOne +restoreList +turnTo +updateOne +createNested +

Constructors

constructor

Properties

Abstract baseURI

baseURI: string

Abstract client

client: RESTClient

indexKey

indexKey: keyof D = 'id'

Accessors

allItems

currentOne

currentOne

currentPage

downloading

downloading

filter

filter

noMore

pageCount

pageIndex

pageIndex

pageList

pageList

pageSize

pageSize

statistic

statistic

totalCount

totalCount

uploading

uploading

Methods

changeOne

clear

clearCurrent

clearList

countAll

deleteOne

getAll

getList

getOne

indexOf

Protected loadNewPage

  • loadNewPage(pageIndex, pageSize, filter): Promise<{
        pageData: D[];
        totalCount: number;
    }>
  • Protected

    Parameters

    • pageIndex: number
    • pageSize: number
    • filter: F

    Returns Promise<{
        pageData: D[];
        totalCount: number;
    }>

Abstract Protected loadPage

refreshList

removeOne

restoreList

turnTo

updateOne

Static createNested

Settings

Member Visibility

Theme

On This Page

constructorbaseURIclientindexKeyallItemscurrentOnecurrentPagedownloadingfilternoMorepageCountpageIndexpageListpageSizestatistictotalCountuploadingchangeOneclearclearCurrentclearListcountAlldeleteOnegetAllgetListgetOneindexOfloadNewPageloadPagerefreshListremoveOnerestoreListturnToupdateOnecreateNested
\ No newline at end of file diff --git a/functions/Buffer.html b/functions/Buffer.html new file mode 100644 index 0000000..92b702c --- /dev/null +++ b/functions/Buffer.html @@ -0,0 +1 @@ +Buffer | MobX RESTful

Function Buffer

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Stream.html b/functions/Stream.html new file mode 100644 index 0000000..05ec8ce --- /dev/null +++ b/functions/Stream.html @@ -0,0 +1 @@ +Stream | MobX RESTful

Function Stream

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/destroy.html b/functions/destroy.html new file mode 100644 index 0000000..93fe65e --- /dev/null +++ b/functions/destroy.html @@ -0,0 +1 @@ +destroy | MobX RESTful

Function destroy

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/persist.html b/functions/persist.html new file mode 100644 index 0000000..4d3ebb9 --- /dev/null +++ b/functions/persist.html @@ -0,0 +1 @@ +persist | MobX RESTful

Function persist

  • persist<T, V, S>(patcher?): ((__namedParameters, __namedParameters) => void)

  • Type Parameters

    • T
    • V
    • S

    Parameters

    • patcher: Omit<PersistMeta<V, S>, "key"> = {}

    Returns ((__namedParameters, __namedParameters) => void)

      • (__namedParameters, __namedParameters): void

      • Parameters

        • __namedParameters: ClassAccessorDecoratorTarget<T, V>
        • __namedParameters: ClassAccessorDecoratorContext<T, V>

        Returns void

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/restore.html b/functions/restore.html new file mode 100644 index 0000000..69ccbf2 --- /dev/null +++ b/functions/restore.html @@ -0,0 +1 @@ +restore | MobX RESTful

Function restore

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/toggle.html b/functions/toggle.html new file mode 100644 index 0000000..48ab1a9 --- /dev/null +++ b/functions/toggle.html @@ -0,0 +1 @@ +toggle | MobX RESTful

Function toggle

  • toggle<T>(property): ((origin, __namedParameters) => ((this, ...data) => Promise<any>))

  • Type Parameters

    Parameters

    • property: TypeKeys<T, number | boolean>

    Returns ((origin, __namedParameters) => ((this, ...data) => Promise<any>))

      • (origin, __namedParameters): ((this, ...data) => Promise<any>)

      • Parameters

        • origin: ((...data) => Promise<any>)
            • (...data): Promise<any>

            • Parameters

              • Rest ...data: any[]

              Returns Promise<any>

        • __namedParameters: ClassMethodDecoratorContext<unknown, ((this, ...args) => any)>

        Returns ((this, ...data) => Promise<any>)

          • (this, ...data): Promise<any>

          • Parameters

            • this: T
            • Rest ...data: any[]

            Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/toggleNotification.html b/functions/toggleNotification.html new file mode 100644 index 0000000..24dc186 --- /dev/null +++ b/functions/toggleNotification.html @@ -0,0 +1 @@ +toggleNotification | MobX RESTful

Function toggleNotification

  • toggleNotification<T>(message): ((origin, __namedParameters) => ((this, ...data) => Promise<any>))

  • Type Parameters

    Parameters

    • message: string | ((instance) => string)

    Returns ((origin, __namedParameters) => ((this, ...data) => Promise<any>))

      • (origin, __namedParameters): ((this, ...data) => Promise<any>)

      • Parameters

        • origin: ((...data) => Promise<any>)
            • (...data): Promise<any>

            • Parameters

              • Rest ...data: any[]

              Returns Promise<any>

        • __namedParameters: ClassMemberDecoratorContext

        Returns ((this, ...data) => Promise<any>)

          • (this, ...data): Promise<any>

          • Parameters

            • this: T
            • Rest ...data: any[]

            Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 0000000..fdf3002 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1 @@ +MobX RESTful

MobX RESTful

Class Hierarchy

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..ab93112 --- /dev/null +++ b/index.html @@ -0,0 +1,62 @@ +MobX RESTful

MobX RESTful

MobX RESTful

Common MobX abstract base Class & Decorator utilities for RESTful API.

+

Just define your Data models & Client HTTP methods, then leave rest of things to MobX!

+

MobX compatibility +NPM Dependency +CI & CD

+

NPM

+

Versions

+ + + + + + + + + + + + + + + + + + + + +
SemVerstatusES decoratorMobX
>=0.7.0✅developingstage-3>=6.11
<0.7.0❌deprecatedstage-2>=4 <6.11
+

Usage

tsconfig.json

{
    "compilerOptions": {
        "target": "ES6",
        "moduleResolution": "Node",
        "useDefineForClassFields": true,
        "experimentalDecorators": false,
        "jsx": "react-jsx"
    }
}
+
+

Simple List

model/client.ts

import { HTTPClient } from 'koajax';

export const client = new HTTPClient({
    baseURI: 'https://api.github.com/',
    responseType: 'json'
});
+
+

model/Repository.ts

import { buildURLData } from 'web-utility';
import { Filter, ListModel } from 'mobx-restful';
import { components } from '@octokit/openapi-types';

import { client } from './client';

export type Organization = components['schemas']['organization-full'];
export type Repository = components['schemas']['minimal-repository'];

export class RepositoryModel<
    D extends Repository = Repository,
    F extends Filter<D> = Filter<D>
> extends ListModel<D, F> {
    client = client;
    baseURI = 'orgs/idea2app/repos';

    async loadPage(page: number, per_page: number) {
        const { body } = await this.client.get<D[]>(
            `${this.baseURI}?${buildURLData({ page, per_page })}`
        );
        const [_, organization] = this.baseURI.split('/');
        const {
            body: { public_repos }
        } = await this.client.get<Organization>(`orgs/${organization}`);

        return { pageData: body, totalCount: public_repos };
    }
}

export default new RepositoryModel();
+
+

page/Repository.tsx

Use WebCell as an Example

+
import { component, observer } from 'web-cell';

import repositoryStore from '../model/Repository';

@component({ tagName: 'repository-page' })
@observer
export class RepositoryPage extends HTMLElement {
    connectedCallback() {
        repositoryStore.getList();
    }

    disconnectedCallback() {
        repositoryStore.clear();
    }

    render() {
        const { currentPage } = repositoryStore;

        return (
            <ul>
                {currentPage.map(({ full_name, html_url }) => (
                    <li key={full_name}>
                        <a target="_blank" href={html_url}>
                            {full_name}
                        </a>
                    </li>
                ))}
            </ul>
        );
    }
}
+
+

Preload List

model/PreloadRepository.ts

import { buildURLData } from 'web-utility';
import { Buffer } from 'mobx-restful';

import { client } from './client';
import { Repository, RepositoryModel } from './Repository';

export class PreloadRepositoryModel extends Buffer<Repository>(
    RepositoryModel
) {
    client = client;
    baseURI = 'orgs/idea2app/repos';

    loadPage = RepositoryModel.prototype.loadPage;
}

export default new PreloadRepositoryModel();
+
+

Multiple Source List

model/MultipleRepository.ts

import { buildURLData, mergeStream } from 'web-utility';
import { Stream } from 'mobx-restful';
import { components } from '@octokit/openapi-types';

import { client } from './client';
import { Repository, RepositoryModel } from './Repository';

export type User = components['schemas']['public-user'];

export class MultipleRepository extends Stream<Repository>(RepositoryModel) {
    client = client;

    async *getOrgRepos() {
        const {
            body: { public_repos }
        } = await this.client.get<Organization>('orgs/idea2app');

        this.totalCount = public_repos;

        for (let i = 1; ; i++) {
            const { body } = await this.client.get<Repository[]>(
                'orgs/idea2app/repos?page=' + i
            );
            if (!body[0]) break;

            yield* body;
        }
    }

    async *getUserRepos() {
        const {
            body: { public_repos }
        } = await this.client.get<User>('users/TechQuery');

        this.totalCount = public_repos;

        for (let i = 1; ; i++) {
            const { body } = await this.client.get<Repository[]>(
                'users/TechQuery/repos?page=' + i
            );
            if (!body[0]) break;

            yield* body;
        }
    }

    openStream() {
        return mergeStream(
            this.getOrgRepos.bind(this),
            this.getUserRepos.bind(this)
        );
    }
}

export default new MultipleRepository();
+
+

File Downloader

Here is an example:

+ +

Wrapper

    +
  1. Strapi v4
    2. +
  2. Lark/FeiShu
    3. +
+

Component

    +
  1. Table, List & Form suite
    2. +
+

Scaffold

    +
  1. Client-side Rendering (React): https://github.com/idea2app/Next-Bootstrap-ts
    2. +
  2. Server-side Rendering (React): https://github.com/idea2app/React-MobX-Bootstrap-ts
    3. +
  3. Cross-end App (React): https://github.com/idea2app/Taro-Vant-MobX-ts
    4. +
+

Limitation

+

Settings

Member Visibility

Theme

On This Page

MobX RESTful
\ No newline at end of file diff --git a/interfaces/PageData.html b/interfaces/PageData.html new file mode 100644 index 0000000..74aef75 --- /dev/null +++ b/interfaces/PageData.html @@ -0,0 +1,3 @@ +PageData | MobX RESTful

Interface PageData<D>

interface PageData<D> {
    pageData: D[];
    totalCount?: number;
}

Type Parameters

Properties

pageData +totalCount? +

Properties

pageData

pageData: D[]

Optional totalCount

totalCount?: number

Settings

Member Visibility

Theme

On This Page

pageDatatotalCount
\ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..9da85ed --- /dev/null +++ b/modules.html @@ -0,0 +1,21 @@ +MobX RESTful

MobX RESTful

Index

Classes

BaseListModel +BaseModel +DownloadTask +Downloader +HTTPDownloadTask +ListModel +

Interfaces

PageData +

Type Aliases

DataObject +Filter +IDType +NewData +RESTClient +Statistic +

Functions

Buffer +Stream +destroy +persist +restore +toggle +toggleNotification +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/DataObject.html b/types/DataObject.html new file mode 100644 index 0000000..9c3fe56 --- /dev/null +++ b/types/DataObject.html @@ -0,0 +1 @@ +DataObject | MobX RESTful

Type alias DataObject

DataObject: Record<string, any>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Filter.html b/types/Filter.html new file mode 100644 index 0000000..f5ba85e --- /dev/null +++ b/types/Filter.html @@ -0,0 +1 @@ +Filter | MobX RESTful

Type alias Filter<T>

Filter<T>: Partial<NewData<T>>

Type Parameters

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/IDType.html b/types/IDType.html new file mode 100644 index 0000000..977f3c8 --- /dev/null +++ b/types/IDType.html @@ -0,0 +1 @@ +IDType | MobX RESTful

Type alias IDType

IDType: number | string

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/NewData.html b/types/NewData.html new file mode 100644 index 0000000..7b8a018 --- /dev/null +++ b/types/NewData.html @@ -0,0 +1 @@ +NewData | MobX RESTful

Type alias NewData<D, N>

NewData<D, N>: Omit<D, TypeKeys<D, N> | TypeKeys<D, N[]>> & {
    [K in TypeKeys<D, N>]: IDType
} & {
    [K in TypeKeys<D, N[]>]: IDType[]
}

Type Parameters

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/RESTClient.html b/types/RESTClient.html new file mode 100644 index 0000000..6a34d95 --- /dev/null +++ b/types/RESTClient.html @@ -0,0 +1 @@ +RESTClient | MobX RESTful

Type alias RESTClient

RESTClient: Pick<HTTPClient<Context>, "baseURI" | "options" | "request" | "get" | "post" | "put" | "patch" | "delete">

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/types/Statistic.html b/types/Statistic.html new file mode 100644 index 0000000..a707569 --- /dev/null +++ b/types/Statistic.html @@ -0,0 +1 @@ +Statistic | MobX RESTful

Type alias Statistic<D>

Statistic<D>: Partial<Record<TypeKeys<D, IndexKey>, Record<string, number>>>

Type Parameters

Settings

Member Visibility

Theme

\ No newline at end of file