From f4b33b29e620e1df7dca19bf8497c6ed722cce23 Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Tue, 19 Nov 2024 17:41:42 +0200 Subject: [PATCH] Document/0.1.3 --- .github/workflows/NPM.yml | 4 +- .github/workflows/Node.yml | 4 +- CHANGELOG.md | 12 +++ Target/Class/Document.js | 2 +- docs/assets/icons.js | 2 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 87 ++++++++++++++----- docs/functions/Function_Document.Exec.html | 4 +- .../functions/Function_Document.document.html | 4 +- docs/functions/Function_Document.resolve.html | 6 +- docs/functions/Function_Exec.exec.html | 4 +- docs/functions/Function_JSON.JSON.html | 4 +- docs/index.html | 4 +- docs/interfaces/Exec.Interface.html | 4 +- .../Interface_Document.Interface.html | 4 +- docs/interfaces/JSON.Interface.html | 4 +- docs/modules.html | 8 ++ docs/modules/Document.html | 4 +- docs/modules/Exec.html | 4 +- docs/modules/Function_Document.html | 4 +- docs/modules/Function_Exec.html | 4 +- docs/modules/Function_JSON.html | 4 +- docs/modules/Interface_Document.html | 4 +- docs/modules/JSON.html | 4 +- docs/variables/Document.document.html | 2 +- docs/variables/Function_Document.Current.html | 2 +- docs/variables/Function_Document.Pipe.html | 2 +- 29 files changed, 131 insertions(+), 66 deletions(-) create mode 100644 docs/modules.html diff --git a/.github/workflows/NPM.yml b/.github/workflows/NPM.yml index 490dcaa..76ab61a 100644 --- a/.github/workflows/NPM.yml +++ b/.github/workflows/NPM.yml @@ -57,9 +57,9 @@ jobs: id-token: write steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v4.2.1 - - uses: actions/setup-node@v4.1.0 + - uses: actions/setup-node@v4.0.4 with: node-version: "18" registry-url: "https://registry.npmjs.org" diff --git a/.github/workflows/Node.yml b/.github/workflows/Node.yml index 055fa35..83274f8 100644 --- a/.github/workflows/Node.yml +++ b/.github/workflows/Node.yml @@ -59,7 +59,7 @@ jobs: node-version: [18, 19, 20] steps: - - uses: actions/checkout@v4.2.2 + - uses: actions/checkout@v4.2.1 - uses: pnpm/action-setup@v4.0.0 with: @@ -76,7 +76,7 @@ jobs: --unsafe-perm=true ] - - uses: actions/setup-node@v4.1.0 + - uses: actions/setup-node@v4.0.4 with: node-version: ${{ matrix.node-version }} cache: "pnpm" diff --git a/CHANGELOG.md b/CHANGELOG.md index 39cce7b..f0c687e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ ## 0.1.3 +### Changed + +- Updated version in `package.json` to 0.1.3. +- Updated contact email in `package.json` from `Source/Open@PlayForm.Cloud` to + `Source/Open@PlayForm.LTD`. +- Updated URL in `package.json` from `HTTPS://PlayForm.Cloud` to + `HTTPS://PlayForm.LTD`. +- Updated `typedoc` to version 0.26.11. +- Updated `typedoc-plugin-mdn-links` to version 3.3.8. +- Updated `typedoc-plugin-merge-modules` to version 6.0.3. +- Updated `@playform/build` to version 0.1.9. + ## 0.1.2 ### Changed diff --git a/Target/Class/Document.js b/Target/Class/Document.js index 85fe4f7..0e52625 100644 --- a/Target/Class/Document.js +++ b/Target/Class/Document.js @@ -1,2 +1,2 @@ #!/usr/bin/env node -var e=new(await import("commander")).Command().name("Document").version("0.1.2").description("\u{1F4C3}\u2001Document\u2001\u2014").argument("","\u{1F4DD}\u2001File\u2001\u2014").option("-F, --Folder ","\u{1F4DC}\u2001Folder\u2001\u2014").action((await import("../Function/Document.js")).default).parse();export{e as default}; +var e=new(await import("commander")).Command().name("Document").version("0.1.3").description("\u{1F4C3}\u2001Document\u2001\u2014").argument("","\u{1F4DD}\u2001File\u2001\u2014").option("-F, --Folder ","\u{1F4DC}\u2001Folder\u2001\u2014").action((await import("../Function/Document.js")).default).parse();export{e as default}; diff --git a/docs/assets/icons.js b/docs/assets/icons.js index e88e8ca..3dfbd32 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ function addIcons() { if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); - svg.innerHTML = `""`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index e371b8b..a19417d 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 21a5d74..99097a0 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -3,7 +3,7 @@ window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This me "use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/search.js b/docs/assets/search.js index 2c5a4d1..ccd7a1f 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtVZTY/bNhD9L7z0QmjFD5GSr2kKpIe2QIFeFotAsem1GlkyKGmTdLH/vaBEyRqZXIvOFkhPoinyzZvh43AoPyNdf2nQ5v4ZfS6qHdpQjKr8qNAG/frn778hjDpdog061ruuVM2d6YwO7bFEGG3LvGlUgzYIveBpfiImhA9Vq/Q+36oJphh7LNI0woGJ0SnXqmpHKjMbk4X3X9X2gqPpfBuOPdJKjj0VF8dp/t3P9bY7mtFLxtOQj+OQt+HvwF3pjYO0y7dfumrbFnV15xTL+PbjVdUI7pbd3iIssTyAMwcgs1e5O0U02buqphl3NUdycO+xlBvQxd2rqWmEV1KTzVWKmvnw/ooPE54nMC4/HBqaWdSqqcsntcqoHXu7XXYO4h/F6Wz0KddF/skdOTPwTSy+67SeL9ZrRu3YN4nwbqmS10K88wtmpeWzw155rlLlLHIXHpxDF0j8zPcBo6Laqa9o84yelG6KukIbRCMWZQijfaHKnTkZBwoYbeujZTCRebDD/lLbttZm8DD6Lkb4PsaERzzmDw/4fpzcv+g7RoxzTz+RIHxPMBFRRiSYSAbESLIMUxxHacYwwyQilGFufyc4jjJJsMAkEmmKJY4jKTlO7e/MjM8yTGI7gRD7htCxwcYGHxqQLAFkqSGbYBJHkgrAll64ScFM5nPTvDBcOJW9ezEb3JOZ7N1LssEtkRHjhvGHYpLYEcR4HkuCicQkokmKSTo2Mtug8dggY4OODWanUz72JEMD+sKAL9xQFpgmEcuAL/wiCBxMTHxBMC/6tY35sKZJgqX9bdwwDCWmEY9TTNOxkQ0NaDEBFoUBjh1UxQVVASZKn57lDyFLCcimxkvi8DK98DIFEzOvnrP/gywzmElMYmHUEQZymYTIIgsRbyT6Vz98KAhMVMRkH8ZcsaDWnZgRzO3TkKUxGwRJe9JxlKbCmI8jkRDMzFDCU8zMWMExE2OHHBv9xuQEs2wYwmP7NF4lgmJObQfDNCIZx5zbDgvKhX0azCxOME/HkZnFSCxoQuyTWvMJsx0WM7GYicVMpH2m4wRLU1hEYRGFZSksoLCAol9sQrCwiGL0XKS2wyJKiygtorSI0iJKiygtRWkBpaUoLZ60eKnFSy1eOuAtFAAPHGJydupUALvcDTDBE5O2RYJpHNGUwMmXOZ7AJE9MBk6580h/wzxPYKInwm/1MtcTmOyJ9E+Wl5OHrr6YelK6VbsPQ1F1f49yhJ/RR1tkJWMx9/xyLqY2z4gMPWx4JMNDDo9seBA7hlD77Ee9zCox89PQyj81ddm1am6YS59l6oXZt0oD8lk4RlnOEQS5AUGrfPcN8LgBpZoDEOEBYK9E3A27A7jxquV9bV3dVoD7qdeKH0FDMdwQQP3YdzRgIegNODoH3vAbMAAJcYMqm2/V9qDrqu4AFPFtEpcuXMDbQ1ECRVD+vYj18bhUmc/h9ZhVU+yUVgCWhWeIbV21/W1wRs7nMJlp34k1fhaYrew5WyLC7cRVxHaF7m+jQGki3MHzjXu2/fiMlc3URNinvGDpgh0+kc2CNnOUuhfxhmU2VrpWQYWn36mdfVGCVOLdfK6TzH9k7esOijzxEfUv1l7XR5BZWDiE/aAD9sUbHNl+v8cvSC6lnT/9PCMSr1LWhLeUGDunfJSGQf3dLAJyPn+QWAX1qOC5IcN3YrEHSxue8wvgQ+JNU68ATH8yzPbTbIUu9XA1MBOmc/3puUxBl+nPiQfCfCUV31iNFE31E6CZhNcjBdQD8dYAVw6NpTRnyozh1ADQUu2hf96i3eufgTjWDYDhN8DUjyBO1Bfptdl7yYmFc6pqcKaG76Oq1se8LP6B1YcMLwOrGp7L4UVtDZIK9WX60FtBrXeLi5PvvvEKRnuAGCw85Z1ynR/V4hLHwrlMODC7hG/7U64buOzkyunq3aSnvD0ANuH1goGAN4lwDZ7ytlW6grvUt1JjseitBk79n3EzSbPZ8cJWnQAnrU6q2sEoJ+GV0EnXW9VAv3zJYm32sZiwIqW+hbsaLfNdAEB5JXBFS1od66dFOgpPjFqdtGqWV2TqK3VWuGf/EZ7t3bke6Co9WBToXPhesTAwAYRnEq2armyL6hHQCU/cWrXdYtcRL8q11S8eD/BQDD/TdA3PIhmerJsybw4wwDKcSNPmehlffgvMTmlwbFBfbly7+Zt2V3ewvPWt2HrIYvF5MTzPNa1ehCsNPwXaQw6X/7+8MrYHkBOulM43FvktqPJYeMJodV6Uy40evjztt5Nqtro4wQ9DN271rioXZ5oMz2Fd1RZAdUn4bbZblEEiPMBds4iuCK/Hvii4f+QNELX+vCQSGNMH3Bc+ZVEptLl/eHn5F0ZxdQiQKQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtVaS4+rNhT+L950Y3HxG7LtQ2oXbaVK3USjips4E1oCkSHT3o7mv1eGQ8gheAZP75XaFY7x+fydp4+ZeSau+bMlm+0z+aOs92TDKamLkyUb8t2l3nVlU3/44ZeffiSUXFxFNuTU7C+VbT+Mb3/zb5Njd6oIJbuqaFvbkg0hL3RE1PIKiZAOgDDHCgBSci6crbs7ZtNOC9y//cvuwtz927Xc7S3SAvceyy4DLnHvmb3K/Ztmdzl5qSD/ccVaHb59Q4crXsAwS3pcWS7u6GzbVE921aaw9v37ismIP5fnadOnwpXFx2XL+YWfZcevL87dOuu1TWHtZ7Hwfh4lr5l4Hw6YlTvz5WQeQ/PNasCVviJ8X3fWHYrd5KlynAGk64rXCQfrwGL6v5n1qzn2SCs5BvP9Kh9O+OuSdRm/mv8C7kptFkgv6RbUaJUeN9l1F+VTekUG98T3gZKy3tu/yOaZPFnXlk1NNoQnIskJJYfSVnt/Mg4UKNk1J2BwJfMAy361u65xfvGw+kNK6DalXCUif3ig21G2n+8nRohpppdjhG4ZZTKRqUSC8CIxIqecpkmWCyooSxgXVMJvRdMkN4xqyhKdZdTQNDFG0gx+5359nlOWggBj8IbxcSDGgRwGmCxDZLnnpBa05HdaciQovKCmLE0M10jSv/FcJDe9eqkY1DO56dVT+aCWzplXw+vDKdOwghkvYhhlXmWuMspyGPB0HLBxwMeBGAcSxLkaZ/QwwMoIpIz0lM2CFeSdFSQSVEErqP+DFRRSRnvK2YIVNOiSCkYlPL0OPBVDIPKecZpkmfZ7p4lWjPI+VmVGhV+iJRVsnODjQFCeSMmokLBEwdPTVZpTYWAiozxhuaQiHyYkgEoGT4+Zp4pKASulBAwJoFLD08D2MoMJwFSAqQBTcXgKEFBAUwGiAkQFLBUAKgDUHlAxRjUg6lFzLWACEDUgakDUgKgBUQOiAYoGAA1QNIBnAM8AngE8M+Bh92vkfkPo1iy539wlgUGCGaFbnVKeJjxjSDK7k8yQZO63zCnTSc4MkvRvequncqiJSlEDv31cGUaz1AdPmtGMjQM+DPCWOa7OabA83xd2NqvsvnZmYokv+48Ud1zdGQ/WJ3Zf4Bmu8EyEtf1f1HiGizzzpTuTCwHO7ss8w3WeqbAt1OcLVYYLMtPB/GD6njJOZ2bCwvcZDVN9O/VkXWf33w9t1XZLCkKfyW/QZqmxnXt+mdqpzTNhw4wYHmp46OGRDw8GaxgsYv2ql5tezP/0tIqPbVNdOnu7seSBnXUQ5dBZh7jLaIiqQgA6HsDZYv8JKRIPUt/KMxOQX7T9YOxl1D2CTd/hWezS5V2Q8iYUP2HlHQoDEW8999hPtMgJISO+AuMKpIqIh0AUdHw0tp/q3dE1dXNBSCxbFRFhJ+2OZYWCgYfctBqxOZ1mAcZDAbYes27LvXUWwYrourBr6q6/BN5YMOSLMb5ZEGz8ZHTj2ElRkoHcGl770vV3UBRlOlq96Zp9k3b5RGmsxmMKmzuKS6jDp9Mbi015OHcgv9d5rYv9LpfO4ujO/2XcHMoKlZAQHls+rYKn1KG54AhXItZXB9ecUDCHMjmMAN/5EEpMJY8+nMcdPywFGp+KIpGrAusKdxdhUw0i9yH1KtTvLTbITUKmq5AeLT4uTHQWlgd03ETX+hIpIEMx+4r89ZvhBJNNkRF2+OuWueIuuj+TNxus83+Jz+Uv0oSUbf0V4imj25ASBwQLBcSbB8Y8NtmNxUD2Pkbfhq3sAWmoQqdtUEOPcGpabKd4lOYRGYqzf1m955RENKW6QYaJTqW6caeiKv/GfYeObv/qBp/J0Z1sg2oKD+VK5D2gcfvZNSnksjCx7oghRHS9OxeuONnZhU1EM7nCoCAU0el+LlyL/c3eOFXDqXkuuiNKqug2wSMghVR08J2LrrOuRihZqIiNPUGwBzj3f5q9ieWpbyHr+smzs2db77GNZXT7c3bNzra44oTyam3FAUzchWahUHzTVv4DAIZ6byA5e2qesMVMdDV09uxsO78PZyGcFerBfwfceOAmGvSqaAAQrFp0mgAKbiiiS4iz7aXqyvoRVfvoYu1sd5nlGwtxedvz5eMR99nRp5hrZsdPdIluq6I9YuvqaBptV7i5ccU7UPbWoaOCh6Jlbda33b65YBuHyuN6yHL2/TC6vrWdmxnLRJf+7lhgz3/R62F3xLXgizT0HWrpRHSl6FxRVvMUj3ZO9+ls250rz/jzz3uT/FJXs6PMRBevS92VOOSib66XWeOjo617aWemVdH9158WZ46OR2jcH3MPx5nzgfZ9TlXWlmy2Dy8v/wAVdIUaaSkAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 9d619a6..178bfb0 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -4,11 +4,17 @@ --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-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + --light-color-link: #1f70c2; --light-color-focus-outline: #3584e4; @@ -22,16 +28,17 @@ --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-constructor: #4d7fff; + --light-color-ts-property: #ff984d; + --light-color-ts-method: #ff4db8; + --light-color-ts-reference: #ff4d82; --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-accessor: #ff4d4d; --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; @@ -46,11 +53,17 @@ --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-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + --dark-color-link: #00aff4; --dark-color-focus-outline: #4c97f2; @@ -64,16 +77,17 @@ --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-constructor: #4d7fff; + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; --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-accessor: #ff4d4d; --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; @@ -90,15 +104,22 @@ --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-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -110,6 +131,7 @@ --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-reference: var(--light-color-ts-reference); --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( @@ -134,15 +156,22 @@ --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-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -154,6 +183,7 @@ --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-reference: var(--dark-color-ts-reference); --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( @@ -190,10 +220,16 @@ body { --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-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -205,6 +241,7 @@ body { --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-reference: var(--light-color-ts-reference); --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( @@ -232,10 +269,16 @@ body { --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-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -247,6 +290,7 @@ body { --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-reference: var(--dark-color-ts-reference); --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( @@ -439,7 +483,6 @@ pre { pre { position: relative; - white-space: pre; white-space: pre-wrap; word-wrap: break-word; padding: 10px; @@ -860,6 +903,12 @@ a.tsd-index-link { margin-bottom: 0.75rem; } +.tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} .tsd-kind-icon { margin-right: 0.5rem; width: 1.25rem; @@ -867,10 +916,6 @@ a.tsd-index-link { 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; } @@ -1242,6 +1287,9 @@ img { .tsd-kind-method { color: var(--color-ts-method); } +.tsd-kind-reference { + color: var(--color-ts-reference); +} .tsd-kind-call-signature { color: var(--color-ts-call-signature); } @@ -1254,9 +1302,6 @@ img { .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); } @@ -1435,7 +1480,7 @@ img { } .site-menu { - margin-top: 1rem 0; + margin-top: 1rem; } .page-menu, diff --git a/docs/functions/Function_Document.Exec.html b/docs/functions/Function_Document.Exec.html index a5fab2f..c89c472 100644 --- a/docs/functions/Function_Document.Exec.html +++ b/docs/functions/Function_Document.Exec.html @@ -1,4 +1,4 @@ -Exec | @playform/document - v0.1.2

Function Exec

  • Exec(Command, Echo?): Promise<void>

  • The 'Exec' function is an asynchronous function that executes a command and logs the +Exec | @playform/document - v0.1.3

    Function Exec

    • Exec(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    Settings

    Member Visibility
    +

Returns Promise<void>

Settings

Member Visibility
diff --git a/docs/functions/Function_Document.document.html b/docs/functions/Function_Document.document.html index 1f02ca6..0277bd4 100644 --- a/docs/functions/Function_Document.document.html +++ b/docs/functions/Function_Document.document.html @@ -1,4 +1,4 @@ -document | @playform/document - v0.1.2

Function document

  • document(File, Option?): Promise<void>

  • Represents a function that processes file patterns.

    +document | @playform/document - v0.1.3

    Function document

    • document(File, Option?): Promise<void>

    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • OptionalOption: {
            Folder?: string;
        }
        • OptionalFolder?: string

          A string representing the Folder option.

          -

      Returns Promise<void>

    Settings

    Member Visibility
    +

Returns Promise<void>

Settings

Member Visibility
diff --git a/docs/functions/Function_Document.resolve.html b/docs/functions/Function_Document.resolve.html index cbfa17b..bfb5b2b 100644 --- a/docs/functions/Function_Document.resolve.html +++ b/docs/functions/Function_Document.resolve.html @@ -1,9 +1,9 @@ -resolve | @playform/document - v0.1.2

Function resolve

  • resolve(...paths): string

  • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

    +resolve | @playform/document - v0.1.3

    Function resolve

    • resolve(...paths): string

    • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

      Starting from leftmost {from} parameter, resolves {to} to an absolute path.

      If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

      Parameters

      • Rest...paths: string[]

        A sequence of paths or path segments.

        -

      Returns string

      Throws

      if any of the arguments is not a string.

      -

    Settings

    Member Visibility
    +

Returns string

Throws

if any of the arguments is not a string.

+

Settings

Member Visibility
diff --git a/docs/functions/Function_Exec.exec.html b/docs/functions/Function_Exec.exec.html index 8d078b2..01a0e90 100644 --- a/docs/functions/Function_Exec.exec.html +++ b/docs/functions/Function_Exec.exec.html @@ -1,4 +1,4 @@ -exec | @playform/document - v0.1.2

Function exec

  • exec(Command, Echo?): Promise<void>

  • The 'Exec' function is an asynchronous function that executes a command and logs the +exec | @playform/document - v0.1.3

    Function exec

    • exec(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    Settings

    Member Visibility
    +

Returns Promise<void>

Settings

Member Visibility
diff --git a/docs/functions/Function_JSON.JSON.html b/docs/functions/Function_JSON.JSON.html index c05fb8f..8659209 100644 --- a/docs/functions/Function_JSON.JSON.html +++ b/docs/functions/Function_JSON.JSON.html @@ -1,4 +1,4 @@ -JSON | @playform/document - v0.1.2

Function JSON

  • JSON(File, From?): Promise<any>

  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +JSON | @playform/document - v0.1.3

    Function JSON

    • JSON(File, From?): Promise<any>

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If From is provided, it will be used as the base directory path. If From is not provided, the current directory will be used as the base directory path.

        -

      Returns Promise<any>

    Settings

    Member Visibility
    +

Returns Promise<any>

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 4a983d8..edb80b9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@playform/document - v0.1.2

@playform/document - v0.1.2

📃 Document —

Document all your TypeScript files using TypeDoc.

+@playform/document - v0.1.3

@playform/document - v0.1.3

📃 Document —

Document all your TypeScript files using TypeDoc.

🚀 Installation

Add configuration and setup scripts:

npm install -D -E @playform/document
@@ -10,4 +10,4 @@

CLI Usage

Document 'Source/**/*.ts'
-

Settings

Member Visibility

On This Page

📃 Document —
+

Settings

Member Visibility

On This Page

📃 Document —
diff --git a/docs/interfaces/Exec.Interface.html b/docs/interfaces/Exec.Interface.html index c29f4e6..8f9ebd5 100644 --- a/docs/interfaces/Exec.Interface.html +++ b/docs/interfaces/Exec.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.2

Interface Interface

  • Interface(Command, Echo?): Promise<void>

  • The 'Exec' function is an asynchronous function that executes a command and logs the +Interface | @playform/document - v0.1.3

    Interface Interface

    • Interface(Command, Echo?): Promise<void>

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr of the child process.

      Parameters

      • Command: string

        The 'Command' parameter is a string that represents the command you want to execute. It can be any valid command that can be executed in a @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    Settings

    Member Visibility
    +

Returns Promise<void>

Settings

Member Visibility
diff --git a/docs/interfaces/Interface_Document.Interface.html b/docs/interfaces/Interface_Document.Interface.html index 865ab1f..71160ac 100644 --- a/docs/interfaces/Interface_Document.Interface.html +++ b/docs/interfaces/Interface_Document.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.2

Interface Interface

  • Interface(File, Option?): Promise<void>

  • Represents a function that processes file patterns.

    +Interface | @playform/document - v0.1.3

    Interface Interface

    • Interface(File, Option?): Promise<void>

    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • OptionalOption: {
            Folder?: string;
        }
        • OptionalFolder?: string

          A string representing the Folder option.

          -

      Returns Promise<void>

    Settings

    Member Visibility
    +

Returns Promise<void>

Settings

Member Visibility
diff --git a/docs/interfaces/JSON.Interface.html b/docs/interfaces/JSON.Interface.html index ce001fe..39f4511 100644 --- a/docs/interfaces/JSON.Interface.html +++ b/docs/interfaces/JSON.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.2

Interface Interface

  • Interface(File, From?): Promise<any>

  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +Interface | @playform/document - v0.1.3

    Interface Interface

    • Interface(File, From?): Promise<any>

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If From is provided, it will be used as the base directory path. If From is not provided, the current directory will be used as the base directory path.

        -

      Returns Promise<any>

    Settings

    Member Visibility
    +

Returns Promise<any>

Settings

Member Visibility
diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..59cf6f0 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,8 @@ +@playform/document - v0.1.3

@playform/document - v0.1.3

Index

Modules

Document +Exec +Function/Document +Function/Exec +Function/JSON +Interface/Document +JSON +

Settings

Member Visibility
diff --git a/docs/modules/Document.html b/docs/modules/Document.html index 68f1f69..e69e876 100644 --- a/docs/modules/Document.html +++ b/docs/modules/Document.html @@ -1,2 +1,2 @@ -Document | @playform/document - v0.1.2

Module Document

Index

Variables

document -

Settings

Member Visibility
+Document | @playform/document - v0.1.3

Module Document

Index

Variables

document +

Settings

Member Visibility
diff --git a/docs/modules/Exec.html b/docs/modules/Exec.html index 8f46a86..951f0b9 100644 --- a/docs/modules/Exec.html +++ b/docs/modules/Exec.html @@ -1,2 +1,2 @@ -Exec | @playform/document - v0.1.2

Module Exec

Index

Interfaces

Interface -

Settings

Member Visibility
+Exec | @playform/document - v0.1.3

Module Exec

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/Function_Document.html b/docs/modules/Function_Document.html index 63e0e3f..e120701 100644 --- a/docs/modules/Function_Document.html +++ b/docs/modules/Function_Document.html @@ -1,6 +1,6 @@ -Function/Document | @playform/document - v0.1.2

Module Function/Document

Index

Variables

Current +Function/Document | @playform/document - v0.1.3

Module Function/Document

Index

Variables

Current Pipe

Functions

document Exec resolve -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/modules/Function_Exec.html b/docs/modules/Function_Exec.html index d9f9a8f..c10a964 100644 --- a/docs/modules/Function_Exec.html +++ b/docs/modules/Function_Exec.html @@ -1,2 +1,2 @@ -Function/Exec | @playform/document - v0.1.2

Module Function/Exec

Index

Functions

exec -

Settings

Member Visibility
+Function/Exec | @playform/document - v0.1.3

Module Function/Exec

Index

Functions

exec +

Settings

Member Visibility
diff --git a/docs/modules/Function_JSON.html b/docs/modules/Function_JSON.html index 976d26d..13adbc6 100644 --- a/docs/modules/Function_JSON.html +++ b/docs/modules/Function_JSON.html @@ -1,2 +1,2 @@ -Function/JSON | @playform/document - v0.1.2

Module Function/JSON

Index

Functions

JSON -

Settings

Member Visibility
+Function/JSON | @playform/document - v0.1.3

Module Function/JSON

Index

Functions

JSON +

Settings

Member Visibility
diff --git a/docs/modules/Interface_Document.html b/docs/modules/Interface_Document.html index ed7f37d..3847d25 100644 --- a/docs/modules/Interface_Document.html +++ b/docs/modules/Interface_Document.html @@ -1,2 +1,2 @@ -Interface/Document | @playform/document - v0.1.2

Module Interface/Document

Index

Interfaces

Interface -

Settings

Member Visibility
+Interface/Document | @playform/document - v0.1.3

Module Interface/Document

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/modules/JSON.html b/docs/modules/JSON.html index 6cbe7e8..08bd1ca 100644 --- a/docs/modules/JSON.html +++ b/docs/modules/JSON.html @@ -1,2 +1,2 @@ -JSON | @playform/document - v0.1.2

Module JSON

Index

Interfaces

Interface -

Settings

Member Visibility
+JSON | @playform/document - v0.1.3

Module JSON

Index

Interfaces

Interface +

Settings

Member Visibility
diff --git a/docs/variables/Document.document.html b/docs/variables/Document.document.html index 4b3f627..5410f83 100644 --- a/docs/variables/Document.document.html +++ b/docs/variables/Document.document.html @@ -1 +1 @@ -document | @playform/document - v0.1.2

Variable document

document: Command

Settings

Member Visibility
+document | @playform/document - v0.1.3

Variable document

document: Command

Settings

Member Visibility
diff --git a/docs/variables/Function_Document.Current.html b/docs/variables/Function_Document.Current.html index 83b8e79..8959b16 100644 --- a/docs/variables/Function_Document.Current.html +++ b/docs/variables/Function_Document.Current.html @@ -1 +1 @@ -Current | @playform/document - v0.1.2

Variable CurrentConst

Current: string = ...

Settings

Member Visibility
+Current | @playform/document - v0.1.3

Variable CurrentConst

Current: string = ...

Settings

Member Visibility
diff --git a/docs/variables/Function_Document.Pipe.html b/docs/variables/Function_Document.Pipe.html index 8779291..45b6b32 100644 --- a/docs/variables/Function_Document.Pipe.html +++ b/docs/variables/Function_Document.Pipe.html @@ -1 +1 @@ -Pipe | @playform/document - v0.1.2

Variable PipeConst

Pipe: string[] = []

Settings

Member Visibility
+Pipe | @playform/document - v0.1.3

Variable PipeConst

Pipe: string[] = []

Settings

Member Visibility