From d0ac8a2671aa1f5199fed7e2978d0a27dea241d5 Mon Sep 17 00:00:00 2001 From: "Nikola R. Hristov" Date: Fri, 5 Apr 2024 00:08:15 +0300 Subject: [PATCH] Pipe/v0.0.2 --- CHANGELOG.md | 4 + Documentation/.nojekyll | 1 + Documentation/assets/custom.css | 54 + Documentation/assets/highlight.css | 99 ++ Documentation/assets/icons.js | 15 + Documentation/assets/icons.svg | 1 + Documentation/assets/main.js | 59 + Documentation/assets/navigation.js | 1 + Documentation/assets/search.js | 1 + Documentation/assets/style.css | 1415 +++++++++++++++++ Documentation/classes/Pipe.pipe.html | 7 + Documentation/functions/Apply.apply.html | 2 + Documentation/functions/By.by.html | 13 + Documentation/functions/Bytes.bytes.html | 7 + Documentation/functions/In.Apply.html | 2 + Documentation/functions/In.in.html | 6 + Documentation/functions/Merge.merge.html | 2 + Documentation/functions/Not.not.html | 8 + Documentation/functions/Pipe.Merge.html | 2 + Documentation/functions/Pipe.dirname.html | 4 + Documentation/functions/Pipe.pipe-1.html | 3 + Documentation/functions/Pipe.stat.html | 3 + Documentation/hierarchy.html | 1 + Documentation/index.html | 42 + Documentation/interfaces/Apply.Interface.html | 2 + Documentation/interfaces/By.Interface.html | 13 + Documentation/interfaces/Bytes.Interface.html | 7 + Documentation/interfaces/File.Interface.html | 24 + Documentation/interfaces/In.Interface.html | 6 + .../Interface_Action.Interface.html | 22 + .../interfaces/Interface_Cache.Interface.html | 3 + .../interfaces/Interface_Dir.Interface.html | 5 + .../interfaces/Interface_File.Interface.html | 11 + .../interfaces/Interface_Merge.Generic.html | 2 + .../interfaces/Interface_Merge.Type.html | 2 + .../Interface_Option.Interface.html | 19 + .../interfaces/Interface_Plan.Interface.html | 15 + Documentation/interfaces/Not.Interface.html | 8 + Documentation/interfaces/Pipe.Interface.html | 3 + Documentation/modules/Apply.html | 3 + Documentation/modules/By.html | 3 + Documentation/modules/Bytes.html | 4 + Documentation/modules/File.html | 2 + Documentation/modules/In.html | 5 + Documentation/modules/Interface_Action.html | 2 + Documentation/modules/Interface_Cache.html | 2 + Documentation/modules/Interface_Dir.html | 2 + Documentation/modules/Interface_File.html | 2 + Documentation/modules/Interface_Merge.html | 4 + Documentation/modules/Interface_Option.html | 2 + Documentation/modules/Interface_Plan.html | 2 + Documentation/modules/Merge.html | 2 + Documentation/modules/Not.html | 4 + Documentation/modules/Option.html | 2 + Documentation/modules/Pipe.html | 10 + Documentation/modules/Type_Buffer.html | 2 + Documentation/modules/Type_Exclude.html | 2 + Documentation/modules/Type_Logger.html | 2 + Documentation/modules/Type_Path.html | 2 + Documentation/types/Type_Buffer.Type.html | 1 + Documentation/types/Type_Exclude.Type.html | 1 + Documentation/types/Type_Logger.Type.html | 1 + Documentation/types/Type_Path.Type.html | 1 + Documentation/variables/Bytes.Kilobyte.html | 1 + Documentation/variables/In._Path.html | 1 + Documentation/variables/Not.Filters.html | 1 + Documentation/variables/Option.option.html | 2 + Documentation/variables/Pipe.Action.html | 2 + Documentation/variables/Pipe.Cache.html | 1 + Documentation/variables/Pipe.Logger.html | 1 + package.json | 4 +- 71 files changed, 1969 insertions(+), 1 deletion(-) create mode 100644 Documentation/.nojekyll create mode 100644 Documentation/assets/custom.css create mode 100644 Documentation/assets/highlight.css create mode 100644 Documentation/assets/icons.js create mode 100644 Documentation/assets/icons.svg create mode 100644 Documentation/assets/main.js create mode 100644 Documentation/assets/navigation.js create mode 100644 Documentation/assets/search.js create mode 100644 Documentation/assets/style.css create mode 100644 Documentation/classes/Pipe.pipe.html create mode 100644 Documentation/functions/Apply.apply.html create mode 100644 Documentation/functions/By.by.html create mode 100644 Documentation/functions/Bytes.bytes.html create mode 100644 Documentation/functions/In.Apply.html create mode 100644 Documentation/functions/In.in.html create mode 100644 Documentation/functions/Merge.merge.html create mode 100644 Documentation/functions/Not.not.html create mode 100644 Documentation/functions/Pipe.Merge.html create mode 100644 Documentation/functions/Pipe.dirname.html create mode 100644 Documentation/functions/Pipe.pipe-1.html create mode 100644 Documentation/functions/Pipe.stat.html create mode 100644 Documentation/hierarchy.html create mode 100644 Documentation/index.html create mode 100644 Documentation/interfaces/Apply.Interface.html create mode 100644 Documentation/interfaces/By.Interface.html create mode 100644 Documentation/interfaces/Bytes.Interface.html create mode 100644 Documentation/interfaces/File.Interface.html create mode 100644 Documentation/interfaces/In.Interface.html create mode 100644 Documentation/interfaces/Interface_Action.Interface.html create mode 100644 Documentation/interfaces/Interface_Cache.Interface.html create mode 100644 Documentation/interfaces/Interface_Dir.Interface.html create mode 100644 Documentation/interfaces/Interface_File.Interface.html create mode 100644 Documentation/interfaces/Interface_Merge.Generic.html create mode 100644 Documentation/interfaces/Interface_Merge.Type.html create mode 100644 Documentation/interfaces/Interface_Option.Interface.html create mode 100644 Documentation/interfaces/Interface_Plan.Interface.html create mode 100644 Documentation/interfaces/Not.Interface.html create mode 100644 Documentation/interfaces/Pipe.Interface.html create mode 100644 Documentation/modules/Apply.html create mode 100644 Documentation/modules/By.html create mode 100644 Documentation/modules/Bytes.html create mode 100644 Documentation/modules/File.html create mode 100644 Documentation/modules/In.html create mode 100644 Documentation/modules/Interface_Action.html create mode 100644 Documentation/modules/Interface_Cache.html create mode 100644 Documentation/modules/Interface_Dir.html create mode 100644 Documentation/modules/Interface_File.html create mode 100644 Documentation/modules/Interface_Merge.html create mode 100644 Documentation/modules/Interface_Option.html create mode 100644 Documentation/modules/Interface_Plan.html create mode 100644 Documentation/modules/Merge.html create mode 100644 Documentation/modules/Not.html create mode 100644 Documentation/modules/Option.html create mode 100644 Documentation/modules/Pipe.html create mode 100644 Documentation/modules/Type_Buffer.html create mode 100644 Documentation/modules/Type_Exclude.html create mode 100644 Documentation/modules/Type_Logger.html create mode 100644 Documentation/modules/Type_Path.html create mode 100644 Documentation/types/Type_Buffer.Type.html create mode 100644 Documentation/types/Type_Exclude.Type.html create mode 100644 Documentation/types/Type_Logger.Type.html create mode 100644 Documentation/types/Type_Path.Type.html create mode 100644 Documentation/variables/Bytes.Kilobyte.html create mode 100644 Documentation/variables/In._Path.html create mode 100644 Documentation/variables/Not.Filters.html create mode 100644 Documentation/variables/Option.option.html create mode 100644 Documentation/variables/Pipe.Action.html create mode 100644 Documentation/variables/Pipe.Cache.html create mode 100644 Documentation/variables/Pipe.Logger.html diff --git a/CHANGELOG.md b/CHANGELOG.md index 43d7b3de..84fcad91 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.0.2 + +- Cleanup + ## 0.0.1 - Initial version diff --git a/Documentation/.nojekyll b/Documentation/.nojekyll new file mode 100644 index 00000000..e2ac6616 --- /dev/null +++ b/Documentation/.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/Documentation/assets/custom.css b/Documentation/assets/custom.css new file mode 100644 index 00000000..18667225 --- /dev/null +++ b/Documentation/assets/custom.css @@ -0,0 +1,54 @@ +:root { + --dark-color-background: #000; + --dark-color-background-secondary: #000; + --dark-code-background: #040404; + --color-accent: #2463eb; + --light-hl-0: #ffdd00; + --light-hl-1: #ff66ff; + --light-hl-2: #ff4444; + --light-hl-3: #44ffff; + --light-hl-4: #44ff44; + --dark-hl-0: #ffdd00; + --dark-hl-1: #ff66ff; + --dark-hl-2: #ff4444; + --dark-hl-3: #44ffff; + --dark-hl-4: #44ff44; +} + +body #tsd-search .field label { + left: 50%; + margin-left: -20px; + z-index: 1; + text-align: center; +} + +body #tsd-search.has-focus .field label { + display: none; +} + +body #tsd-search .field input { + z-index: 2; +} + +body pre, +body .tsd-page-toolbar, +body .tsd-generator { + border: none; +} + +body .tsd-navigation a, +body .tsd-navigation summary > span, +body .tsd-page-navigation a { + padding: 0.5rem; + border-radius: 8px; +} + +body .tsd-description .tsd-signatures .tsd-signature, +body .tsd-signature, +body .tsd-signatures .tsd-signature, +body .tsd-typography td, +body .tsd-typography th, +body code.tsd-tag { + border-radius: 12px; + border-width: 2px; +} diff --git a/Documentation/assets/highlight.css b/Documentation/assets/highlight.css new file mode 100644 index 00000000..a390d83f --- /dev/null +++ b/Documentation/assets/highlight.css @@ -0,0 +1,99 @@ +:root { + --light-hl-0: #795E26; + --dark-hl-0: #DCDCAA; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #AF00DB; + --dark-hl-4: #C586C0; + --light-hl-5: #008000; + --dark-hl-5: #6A9955; + --light-hl-6: #001080; + --dark-hl-6: #9CDCFE; + --light-hl-7: #000000FF; + --dark-hl-7: #D4D4D4; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #267F99; + --dark-hl-9: #4EC9B0; + --light-hl-10: #000000; + --dark-hl-10: #C8C8C8; + --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); + --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); + --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); + --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); + --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); } +pre, code { background: var(--code-background); } diff --git a/Documentation/assets/icons.js b/Documentation/assets/icons.js new file mode 100644 index 00000000..b79c9e89 --- /dev/null +++ b/Documentation/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/Documentation/assets/icons.svg b/Documentation/assets/icons.svg new file mode 100644 index 00000000..7dead611 --- /dev/null +++ b/Documentation/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/Documentation/assets/main.js b/Documentation/assets/main.js new file mode 100644 index 00000000..1daeb690 --- /dev/null +++ b/Documentation/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.scrollToHash(),this.updateIndexVisibility())}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&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}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&&!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(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let 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 Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var 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/Documentation/assets/navigation.js b/Documentation/assets/navigation.js new file mode 100644 index 00000000..04bbb23e --- /dev/null +++ b/Documentation/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2W32/aMBDH/xc/MzZoyzbeyNpO0dauD3urEHKCAauOEzlmajTxv092EhI7F2M0v/ruPnzvF5fXv0iSd4mWaFUUrEITVGB5QEuU5dsjI+VH/Tw9yIyhCXqjfIuW8wlKD5RtBeFo+XoGxFwSscMp6SC0fWo5Zx+LeLc4Tc4gbCrZHXkqac5bBh4qWtye1j1ABOQRhUgi8swgAeVH1TS5JFySEtIuSRlEvuJ4ZfCDsjypZI/zBwuKk05O62FSbuZGGYx0+pVQhGSYllWPR8rIsBzqNUA1NMZRjL6QmA9lxDyAiJj79WPzokKBZsR8qm2ONqzG9inmU2C9F7e9WMpHAil3dq6fNVSVlSZBRW3iNrVHkBJbSM+ef8PpAZi+DqcdggqsiZ767qlwqbunIqg2xfNUBq9thwq0wBbQU9wTEXunOu3gJe874UTQ9IK4mtf4unb8d1VcSrRmKUd3kr+KS+tVewTtQoP07MMLw06Byh5UngY6xXmMif9wZCag+/OsEdkQZP2FPudy+PvPuQxQFEXxOjuPlEkiSujwKEZjdtwe3k+iq4EK5nYqVv5jM3zF5OYWolPfQHKAdTM355QWwByoVy8JhRGeMlyWbXgxYMzmX0Zu6LCHGuHVRPvWdlXQDOjQGj20DqEVDlxBI/pnvt8TMRpemx3xT2N7pMOBfTS+X7ZUcJyNxzd2B8FsoBWujB9mjuhSYnABdLQyOleguQjQXEXH3Y4AHwAqZFMbvebTPDqyKiwGcGs+ff08uzOX5OE9ZcctsCca1Vj/T08L8RNkT52hB5q5a+U0DD815se7oWX47X6tEk1w6Vif1v8AWmEf3ecPAAA=" \ No newline at end of file diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js new file mode 100644 index 00000000..60bb679e --- /dev/null +++ b/Documentation/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACuU92ZLcOHL/UnrxA5cibkLhlxmv7VDYuzuxvh46FBOlbnaLnuqqijq0khX6d0fiYCFBZJHsbmnl9cuIQwCJRN6ZSFZ/WR12fzmu3tx8Wf3Wb+9Wb3i12q4fu9Wb1Z/2p363XVWr82GzerN63N2dN93xtX9dfzg9blbV6nazPh674+rNavW1ijDEBcgOA/m4PvTr9wmYHQWtWu3Xh257uiByga+VEnrY4tdfT5/33awtXg1zr+0UViQbsobLYb9/WN9+WLRdHVfM2LQOGL7cYf3uAe7vmF6ER0CdoMS/devD7YfnIFMPIJbiNCYUQu2fdpu77vAs1AYQL4zaL+vTMpqFBU+SHrTzv+4eHhYSZVjy/N1/up1tCuLuw5K/jub47QeRWCYKAXeCGH/u1nfPwaUOABYj9O3J5FAb/o8/A0l/SIKC/3XYnZ6HZ4TwI9LQ4Tb8r3wOEf0xSWN0PHbPk8QBxI9IR4/c8P/NcwgZDkp5nHW/eSYlBxA/IiU9cvH/F4YRmJDhnKSfuN097jf98cMzyZkB+hGJmqIY3z7LYqIzU5J63tz3m2cLawLlRyTtgF981T5LZIfTUlnBh/X24ZkkvcD4EQkasIsvnuWT4kkpCe03y3ANC54fpP7jp9vN+W7Z5pc1T9r/kiz/++d99xqlBzHphpFfYeRq3s0ba5jC8AZQsGsKCJ6u590XdEhks4wCoevHXgThAGomygEpEumcxwjrMPgiaEdYM/GOeJGI/3y+v6eo7cdeBO0AaibWAakS0m+3p+5wv77tXv+yWY8rScPwrzB8HXWlx1AHgH18M4I5/O/1g2SIzir8zN301fXqD976snZmDj8bi4lEfikayELPRuKqmV6Kwtvt/W45CmHVy6AAxvG4HIe47GWQ+HN3PG9OT0DjsvBlEPnTdjkOf6KrOzO2v5iaX/r92KDDy5cxKw7STGPiULluDonS+oVUM4rsTzCJAepiozgqwC81i8WNZxvGfPWswuoCPK7WV5ejkYcXCzCZiiSXIzNtp8uYzLTUc9HIar8LEJkoAS9HZY4DLaMy24VeQeViDf64O40MwB93p5fReQA0U80Bj+vW6g/d4WFsXC/UcuOz8f7nbtsd+tvrDPAgw9S5ZsrjSbD99123dxN+OhzWn4//8ee3SzF4VQQxC6kIhyAJCsSvYDMdkdPESBlb4OVLuZr5zmVC6JDhGsscDL+0e3QwFztHhygZou7Pp8WbvorL5mw9Iyw7n56ExbDuZdD46f40ZXZLWMRlL4PEz9397rBcDF4N614IDZzIz0cjrnsyGiVV+30/rilc8Ph9P1FVWK5oAHKxngGWT1ez8ZaztQwtfY6SFXCYrWMUErwc6UU2vpyZXGIcr5vEmdBfvaWjPlK8rxa9J/ebvoHJ1r0lk6KfP8/d1s38jsf8+XM9LJh1yJ8/U4dMQ9iJXf3U73hMiIAnbyqyhTgUxrllP3/rMPc7HtaVJyZvZrOVWZ0CHzet105t7ucuPG7JEeFKwtgV+e6qF3ZGHuhid7SkMW72vq8m2uGy7Wek/7gNbj4iE81vcxDhiTE8dccRX93bl+GmBzWThx6bMp4FJF8Kw/noFXH7ab/fjNFzb18GQw9qJpIem+vanNV8xuocroRfWJ8D1MUKfb1fb9wzMX/zV9OtEjkaMzQbtxstweZ6l9FyVIoNOwsQmtWnsxytvCNjAUZTjRizkJnr0GciMxW10ThNdVtkPYALUJto/fuuZMKdfnQIf4VO1xv8UMvuAsSudup+VxKljbl0UHyFQPP7cRdgdb0N97sSCHXd0oH0FQrlzbb6QqC7/uCeIl73561bHW4Xw/Ciu8UE+vG0PlGgYeypcPdp4pPBhbHfsUWQBSpYnLrDJS68tFpB7hZGl9xdJFhvdyViANxt8Yplxn1I+RZk+u4jweoRgbjg5YE8EqAS3PKifgIbx4cX2G+3NRUkUuX4hEe/Eh+rQK2EaEejoCa49tsyov3Eh2AUlv/Sb3bvPxe/BvCZQZywLDFIMH6PMpgL0h78eyKTmQu7CLh+P8EzlCgk8NaEJHgxWE8LQx7cJ5Smvn1z5oBKz6/YmXk9qhn0qa/4LtMXf7hW3mnqK7Vk1RO/SiP2ncjCr+2bMI387MutJ9s0Zxlx8qMuB5vM8F5GJBLws2TiSZ9kETtd/wArXfTUzuxrGw9d2fRHaWMUnvQ5FYXF9ajtW54ffxollhDgaZ9CUYhMZD/fkgY42bFLaPDEr5goTCaqCd+SCPiLJLWECM/6AonCZ1Yd41sSpPQ10SID8dyvh0hOTRbAvqmc5F8CmUWi8vQvfyiEpspL35IY2Vc8i8znuI6UhJ1/IJIbB4dKk+g4gPG2nIOG1ZcMdBFYxS6xy+1uezwdzren3WEC+is89QrB9lnzbyMvx0iuvoltrlx5T0JPLi8I6Fdumiehp1e9BPhrV7yT8H+ZZvH1e9XSDvSVJrXDtavMZId31arf3nWfVm++rD52hyNElW9WvBY1uOL7vtvcwW+qrEK953b3+Agw3oWx/+xAkGCGn/K6WVU3TSVZ3bB376qbuMC9dy/cLEbMYmgWX1U3rGKmbgSextE0sapueCVYLZVC0wSaJiloEk1Tq+pGVELVTHA0TaFpelXdyNI0jaaZVXWjKt7WxuBpBk1rV9WNLkFr0TS7qm5MxWXNpEbTLKZuQx2VZWwAereVMLWWmHQMc4KRrGCYFxDE3tgiRMwNRrKDYX4woDtriiDdEKtEbRpdMR4fRCXrNhDSw9DkZphdDNjCZHEzzDHWkiAxzxjwhqkScxlmGyfZxjHbODCH6RKWPNMgWoUw3zhwh5kiSMw4TjKOY8Zxx522YraWFh+cY13ijj22YA84Zg8HHvCmkrpmrMUzMXs4MIGziptaY1XhmD0ceMB5ESRmj2gokAKzRwAPuCiBFJg9gpMgMxPnbJwsgsTsEZIEidkjgAdcFUFi9ghgAtcluyMwf4QhTXEYqYVWFTeVrK2QFW8rVouWV9yC7iqbgCJNohtxK5VuK9FUopbCVoLFB17xumltJUQlaqZMBTvVKhzSQ7ekbLohB15aBjB4baXyMIRsK6HiG12xWkteCVPx2sAQrDKp4ZEgGcKWiOyGxsZLNpWsmUgoIUFmJKu4qo20GAYMOTyMZpUEYAyIywMpJGDfAJMBey50JQF7wVLwIGlSVwLWYqa5oeGYgEJtDffgedMCeFa3rfXgm1ZVMpICqFHrxiT7gJxKWxBMN8Ic7TT3MsG0qWBurSrlCKLbSkVaKe7fJLBBtJUokghLvVSkLLshUzW1kQ6LprYC2M5qzSxwuwHTCIf2U6StmrpVlXIvLKuUDFOUgje8UrDGKlspA9KqRKXasMZWYOvaSjcVq7muNAv/8vCvCP/C/o2xFahN3YhK6zBgwr+OXEpX2voXxkNMjgw6alhRBrH6SkMTB5tX2VKKHkZ4bRtbOfFTppLhX0dVozTou38j4LxS2crAGtmwyjihkqwyspK1MirZ1VLRlByUtmEeuNNHAG6lAy5rIwQA57XUANtPMSqXU9VQzsiNOOuiNThfb7Iqo4M1M8GsJbAYaWaGodoyrz+a8cqA2nBA0MLhma3axj8kQDkVBcaRugU1t96QgHyKukFoCcq2uhEBW4JwChYejAPRcqCbqKXkVctGaIGigSkf6bfKAmxaBVUIGZraWha8A/ARZN20ziSwWjYGVI3VjW69fsBQy8NQKxxNVdV6o6SrVoEOt6pqQXekFlVr4hvYQlctwFU8lQLQDFuMNNwQeNjaMFBxVhspAAS4BV7ZQJnK8hGJQIlsMTBQWL8UaJEt+nuF4xdlKX8fR1gtDfOqp1vj3RaDUM9ZDtN668RA6IB02gT6gDG2zuo0vLI6Ppj40MYHG1axpgmvGGhheOL+KcmcnBq1FeeDnxtyJxxIaUZKihsC5HjwGNxwf6IGvByc2rYaFIvVXBpvm23LwTazurHac06AlXbCoAUYZV4reN94GUo8jHaBdFPkiMaxmhY01jhW06AY4KMLM6XXBF5za/wJFUSpwmt3AgNUBtR9xH+tyiDA4vE01NIu/G6KKYobA5YLrT0Mo1jlJjs7wCBkARuRgHM5VGMKFtQNFaAFGJVblUFzeRYEG2Nol0CQAyatT/sq1thK1TK1eNrFe6yozxqH+aYh2WeweBpGss8NjbhWMQbGQYqEf4ZT/HMjI7YVYQjSzRgscUbSh8NW2ihSS92QcuY2KJ8AX9+GSMUpH1fKh4cMvKIKhtybbS68FjIZQqRWG6+FhleMOacNRoWJ4UkOTwFUgiiZ25usFOPkkuliNcZEb9yYIJlQBXCmUrkjNXXLONiTxgUnEoYaCAddFGhEiP40D9EfOF4dbY5xtjdEf0aAm2d1y1vwSE1tmxYcETg9UQGC/hXYaFaDMDN2GXVRnpUV4w28k6Zizsb7d3x4Ev4pOT5ZsDDYoxhLOXJjByq1A5Ws5yoznqmi0eHgEBG7ILVh3jsriBuUi+6098W6kd73OvfBXZICA1wNT9o/XdBrySpJi9WzZWRS4IZcTM5CqN82IcQ3WkMWw2oOjHMOkXF/RMFCaN8q5c+oZYjtBTyE8NMdCDyMF9aGOf4BqVrHtTDI3ToDvPLJJnDSxifRDE9seOL+KTkiWd5psU9qXVwnK9HUDZd4JrYQrXM8ohiktNhEtHQg1+IKQqupomqLdbQ1VFm1zQqmTppFeSqW59bSaIa0oamVspDZs1oLLweQvvigobE+VuAQFTmWMttWzGWGCnTPrTNGVcznyqJiPmJ1r9rhycYn2QxPbHjiw5MYnuTwNGzhDI9JsyLb0HbNYpWwdEBlh3wEtvXpL7feBCpv3hsIkb15dy5buGjLmfem1qr1RlHyYAuDsijVevo1UgaDoJU3hbDGmUJY40xhiMkhwbYuymjqVnhN8tO9eYRpYB7j6LBCwjtrdOWUzYWwzFlo9041/ikhiFMgqCyM654Wq5Clwzo3NKeUY51yqWK10WLlsrRyWaxcVpPVYKuDnTMhAITSDXe+RwfWiiDdopEVA2vp7DVTcniCwEMkDtfSNXJrwn7gH5j3dmFnLkKyD+RxZhWqK96vRVlqNRR5wD/IEBhA2cNPdXUOeGDOKIPOeaMMDy45AVOqzPDUDk/WPyUnaMmSvBtyQgpYu1IfJANJSgpyGI7CdZqSequhvB+AN97Yg854nP2TjE+u9AOJKtPM1RZ1xaD+FZ6Ef0qwtmSJ3g52zFjtcYObdWeiWpBuF6Rp5fMhLYUv1DEd0iDvkJow22PrnyIEwJbXAsydli6aFRfMWHPlwim7cWoYfZ3TDDYIzMolY4XzCK68OxbG46y4jBS2A4XtQGFrAs4uC3XVMwlzIPGoWQvnMMO7dniy/ilFmL76arK7r0aQ12nNUONUXF0KU15ylYC4iNfKsqCDECx7HXRPpsmrVKyh78+a7AKtUeSdXKOKaA313AG/MlpsjBZ909ZkV22NsyNQmhtfAzfh3tQFTd4ZaRkcs5RejJmNpgsCaaeP8J6xaChchOWeXNEUrApsF59ENBCuGOif1PA0mBQzmBTT5oaENc6SmGKB3w+6eBf2ckbQhqKk5tyXG8B2GR/3xuiidXEEiGHFWmC8k+CWDU/cP6VoWDLU9WN/g2Vt5u6yW1G+vc7vuRmV0/ihH6LmyNxdurWlsjrL79n9RTsxV/yYlT/mL/3L4VYYnBFFMX/v3xZzFD+YTtZkIcOPfccqIvP9BW2xjMjyDgN2Jcfxg//XUxfmmyPKuUsY/P+WkjDfBkIoCZ97a8xcJ0jxio7xvLnnSndPZnZcM0gxk2dZnwhz7SBl4c06RZjrByleSLGsVYRxTd1+saxZhLmWEOJYmaq5ppBy5Jb1izDXFUJAzdqwXF8I0QyVOSjXGFKGmvWMMMHpCNqPzemIcm0jxIYZI13jCNEUlTWVMNc6QoDNOOl6R4jGqKyvhAmalSJjpWsPKafDfiydS/NSZLz07RrF7MuPpXNpZsqMmfKKy5f8B3XjrmGDCDdl3ubnL7KKfUYsa85gkr508GM/zK0Dc60TlOfyg3/T1wnMdYSUQ2p5uU35690TMNeJQklp+7dxAcBc40u5sO/H3r1zHd4fu8Opu3vrO71vblar6svq19D4bYbO8i9fLx3eb76sZOtfSev/VcL/C5ntmy9fv36F7XgKqmUEKL/Ur4gfelyWXVateNgy7hT+Da9ZfK/DvwFDHubxMI+HeSbMM2FeG+a1EV4TN2iGN8PWcY8IFKKG8BAIAr45PETSCBUf4mQRJ0s3GdElEGTvPk1P6NGKC0UgoymvW6drLj8vlHMxYKTCeXTA2YT3JiBqAp5tGG/D/9vw/zast2G+DTS18XxNJEYzyEkkRhOJ0cTJAwcjCyHcD3SKq2ScI+NymQjeGn2jlhBPJbSzGFcILHJahsEI1H8EnGjHBVpUg0EeCsAGaodJOlLdYOpS1LxQSI7QOqJj6oZgOMGYAOnuDoNpBAEmyklgVVjuf8M2XZ+QWxcIEglgGeJzALfZbR9ScNpOSHGgT1iOOKXaibUm5wGjaH+RRV3ixhYJnDJTmmeXad5Aqgs+AvECYTiYxplq439TIdWXxPzaCG2wtN60lqzPfn/Y7Q/9+oRtuaR8QDucJkXngFdrajXSUvjVcuR3KOOnCFJfpJGNCIrJF3ZESkOqXllKj5+3t+iQnJLyKAGYY6cT/DACVltFqe2TzbTf7P36iM2pJqODKN34zANNAzzEXkMdXKEl/heqUyOTWGFvSTMjY9LlPbYpihIpKVJShdX97hHvTa1m4dwyhBB20FGsOuB1eLJB+OHr9HRtcrq2cLo2Xd5vTng1GXONrIdM8cBGgF00aFAWG/HPdANvM8wmNClud8okWFwEa9UOQUDh+EW7cet/vuUCj1+ghePGCCyGsVD3GgHHkyLszeb9+vY3rHCUHjxT4eJm2MBMuRRkYABEJvOQNSwwMbfYkzJyfxRL3MaPv5OViaJykRFCUq7EA8rCG5Le6ck/dBmbtJqF+e7xMfPiUDKgVpp05fa+fzgf1nmcSNr0XAwlCiMHqJePstM8II1lpaTIt3P5XaZeFCHK6rQ7HLrjfre9ywRJkkFViv6hP3WHHuUjhnTJTbLwfIBPknFAokjvmiSRd+vTGptBiv6p9bzr3p8fHrIjCmo/ETiWJq93Xbd3P2/mYpDj+dCnoGxi09TYlAUQ/cF9NZ0ZYEphTYwahww1Ecfhl/hSQU5MYZxMC/Td+ZDbDkWRMnWUXY0XSSogKcpbt73dneGnBvPcjRI3tPXhgPVET0X+FuefAUz8E1XJ/jYxX8GuK8pqhfVY7ThltsxgBU2OQkZ/0hClmtN96m7Pp5xznFO7D6mAHsHAdkxQfIzaEOsZKUfuw0/npPKQCKHJuCAoSwZwzoc81KUsCcLA/c2I1HQmnFQYcxU1Sox1I8aEcU6MbnUI6vREQjHO5+mqyMzcA46GKCIoARkO2GDkUUR+H3+sMkmfULlpLO8EoPCTbomzSOJYv6AdSmZjlqOY6x5rtKAEOUrhyJvGKPw5VSqMz+MaB9qS8hNFC3d/2D0iGlP+eEhRbY7YIB9IGo7uR1CxirQUufCZLr9dlEZMiaJkxSkmKB8WQLl3SFepU1o9wiM7Apln4SNsRxU6MjLPM9SnVj7zzPZFypfDzwrhKIaSsevJ3MN7LKmUxSxK6kP8M3ZJHJMYBDWOIMK6/mOH0wYxuW/TFhD4sN7e5QkMGcdfdekfzo9ZJiOo0KBIiv4eqwZ1nsSKJKrZP2zzwgWpl08rHvTYVad1gwbL9kVC5fj64OIoiMrkyJstL0RGhOFvFCcoJwEWmQ72/s9ZJX4lEcfoiE0hmZcB7YiKzJy3mThmqQCMDjP82YYk70vsp9B436j4uQHSgYomMi3g16qyAYrSYamboAGz1+MLjOTvpH9ZWSryukAYVVZYEhKu2mkAdz1OYlmTcM9OLh9Fck0aVvDJ9eGnqRNjluyvxgWsfP1uP7oCSgrkhQpYDmC/wTaIJ0m8uMLBHSY6FeSVDVeWhZCLsd3KfFKPnTmnbHAxl/kt80GUVy7i/9vwu9dpSJDmEIxyQ5vuY7dBNoaKJEr5/Kbfnl67i8TuU3/6/Pp87I49XCve993dZvfQ33af9ofueMy1ikqTomVHdtvtcjwf9/1tvzsfX2933af9pr/tT+stKgOQMeaUowj7hN9HTvxoorp+AaYCAKBk8nG9xywlk/PS3d7jer/Pi0mUO8SGO64/3WZXuy0ZHbFs3aikQV6WFlHPRHlRKW1sf2wqxsMFWxbHLYj23A5I4S2ZXEwAOq3HhTSKSROwzptTv8em25I1wKugxhUtypag8Mv9pYREWBK3p2IAMArkZaE+Ns7IDLHM73t+fI+Vjqy9xrirKDi79//d3aIjkIU4mQUUl7g6a7BIIWOJIYtMV1mzQwEyGe/Hc1IBWdwkv5Gnek5KDSQCkbAciZZu77Edl2lAeqUelOeSZlTnGYtWyoF9d1ifsDVTpDUU+cI8T9SU9yneD40jmiQiimkG4QP82vUG+z6yElK6XMruNBglefMuEnc4NWgp01AsWe3CH6lN+J+2r0TeFixylGQ8Z5xKlDOH/fqwfuyy1pmWvAzPOrby+kRuhjJ679eHU7/e/P1wVeH+M9QbzgccLFrS3usU5jG7nqNiAXTPtg+/K5+6l8QZDsI6tNFR4X3eIZdwLV6vjTOLUVqbmJHBaOgiu04f/g6d15DlCIuXoVUyTRxm5KtUgeoiXOOsG1ebBkRO3QFpfEvxa2TQpjpj0BaYSOQejNqjCLo7QPUVGzyyh6Nk8PyvbCfSkiSwMubao+KeHBxeoQkh7+u7LB/DSXUxywVR08OwX0F089uWoexlS+fdrLf1SPoYmaMM+oCEHoAcuuN5kxWXOeXli2ng/rC77UZaT/bIWbz0sT9m3TeUkSzeaEFHWnc4ZTer5JVckQyH3cf+Lss7yGApi2cSpSlFTwf3h1YSuGliEPk6pGVU7R2gwC/jY5dMtpSVQk0AkadIhnLqAaW4ErLhbptfPVqyC0kXFiMBI4sVwqRLj7vNx/yylbwzLwmHl21kn8k2m0zLbUm3C7qSFN5XpbxungE8dKcztt7wtfqMDMgvzIwAZZSpbtiJ5tdj+ANSiU1L8qwAcmidL0XUCNihxzzVZFBcMvTHLruiI81MKc0/9o/9Zo2jU9LRI0If+//JapSUjcT932H1vrt19SUszKS1Lgmz/yOJKeJplaGhbMfxNOr2IL02OvFp/RtmFHnTl+emT+h2nopyqMj3tD48YIkwpDih++Ow/ENGU06ZxJHukLfMRR06Za2LFAdi69goGMiS0tFlONF4njcx5B8n6AAnbzn6hp+KjALywl3r+M7pSso/U1I+9Mc6D84Y2XVQzGtPHw678wP+cIf8fgGlRbjUT1bK8/QghtE6D6cHso7ynEt6k9gO7LNI10J9/nW9QpR/28XTj7uiHIeigwgHEzKFXIof5uz6etxanXRjrcTYFyVrC81giUFeCao+4haPy+5JI9aKU3debm2e2SY2Z8WpOw9Yebw99PvMXpGX3SX5PW/7LNIn6/PFIPK87T9hT0Jflyee5Ly/yythTJIdhyW/7SFkYQ7Z+VYK8s/HPHwlU9erYveRNXVTN/jWio6jE+LBn7fanXHoM/UFHwp9/rLOCjLkByFtugilRmTIX97xQ3+bWTuK6GjPPvu4kZHXijF8JPtwcPdIOUJItz70oxZJQ/cZqXTlDl9GptHVqHFMFDsZ3lWuELHpt93qzc27r1//F5XMFjWirgAA"; \ No newline at end of file diff --git a/Documentation/assets/style.css b/Documentation/assets/style.css new file mode 100644 index 00000000..072daed8 --- /dev/null +++ b/Documentation/assets/style.css @@ -0,0 +1,1415 @@ +: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 */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -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/Documentation/classes/Pipe.pipe.html b/Documentation/classes/Pipe.pipe.html new file mode 100644 index 00000000..43b8cb54 --- /dev/null +++ b/Documentation/classes/Pipe.pipe.html @@ -0,0 +1,7 @@ +pipe | @playform/pipe - v0.0.2

Class pipe

Implements

Constructors

constructor +

Properties

Plan +

Methods

By +In +Not +Pipe +

Constructors

constructor

Properties

Plan

Plan: Interface = ...

Methods

By

In

Not

Pipe

Settings

Member Visibility

Theme

On This Page

constructorPlanByInNotPipe

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Apply.apply.html b/Documentation/functions/Apply.apply.html new file mode 100644 index 00000000..97a6492d --- /dev/null +++ b/Documentation/functions/Apply.apply.html @@ -0,0 +1,2 @@ +apply | @playform/pipe - v0.0.2

Function apply

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/By.by.html b/Documentation/functions/By.by.html new file mode 100644 index 00000000..fbc6f324 --- /dev/null +++ b/Documentation/functions/By.by.html @@ -0,0 +1,13 @@ +by | @playform/pipe - v0.0.2

Function by

  • by(File, Paths, Results): Promise<Map<string, string>>

  • The function By takes in a file pattern or an array of file patterns, a set +of input and output paths, and a map of results, and returns the updated map +of results after matching the file patterns with the input paths.

    +

    Parameters

    • File: string | string[]

      File is either a single file pattern or an array of file +patterns. These patterns are used to match files in the input directory +(Input) that will be processed.

      +
    • Paths: Map<string, string>

      Paths is an array of tuples that represent the input and +output paths. +Each tuple contains two elements: the input path and the output path.

      +
    • Results: Map<string, string>

      Map object that stores the mapping between the output file +paths and their corresponding input file paths. It is used to keep track of +the files that have been processed and their respective destinations.

      +

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Bytes.bytes.html b/Documentation/functions/Bytes.bytes.html new file mode 100644 index 00000000..7599ca83 --- /dev/null +++ b/Documentation/functions/Bytes.bytes.html @@ -0,0 +1,7 @@ +bytes | @playform/pipe - v0.0.2

Function bytes

  • bytes(Bytes, Decimals?): string

  • The function converts a given number of bytes into a human-readable format with appropriate units +(e.g., KB, MB, GB).

    +

    Parameters

    • Bytes: number

      The Bytes parameter is the number of bytes that you want to convert to a +human-readable format.

      +
    • Optional Decimals: number

      The Decimals parameter is an optional parameter that specifies the number +of decimal places to round the result to. If not provided, it defaults to 2.

      +

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/In.Apply.html b/Documentation/functions/In.Apply.html new file mode 100644 index 00000000..31d744da --- /dev/null +++ b/Documentation/functions/In.Apply.html @@ -0,0 +1,2 @@ +Apply | @playform/pipe - v0.0.2

Function Apply

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/In.in.html b/Documentation/functions/In.in.html new file mode 100644 index 00000000..476fe6ec --- /dev/null +++ b/Documentation/functions/In.in.html @@ -0,0 +1,6 @@ +in | @playform/pipe - v0.0.2

Function in

  • in(Path, Paths): Promise<Map<string, string>>

  • The function In takes a Path and a Paths object, and adds the Path to the Paths object.

    +

    Parameters

    • Path: Type

      The Path parameter is a string or URL that represents the path to a file or +directory.

      +
    • Paths: Map<string, string>

      Paths is a variable of type Plan["Paths"]. It is likely an object or a map that +stores key-value pairs.

      +

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Merge.merge.html b/Documentation/functions/Merge.merge.html new file mode 100644 index 00000000..1bc98803 --- /dev/null +++ b/Documentation/functions/Merge.merge.html @@ -0,0 +1,2 @@ +merge | @playform/pipe - v0.0.2

Function merge

  • merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    +

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Not.not.html b/Documentation/functions/Not.not.html new file mode 100644 index 00000000..bf66a36a --- /dev/null +++ b/Documentation/functions/Not.not.html @@ -0,0 +1,8 @@ +not | @playform/pipe - v0.0.2

Function not

  • not(Pattern, Results): Map<string, string>

  • The function Not filters out files from the File array based on the provided Pattern +parameter.

    +

    Parameters

    • Pattern: undefined | boolean | Type | Set<Type> | Type[]

      The Pattern parameter is of type Option["Exclude"]. It represents the patterns +or filters that will be used to exclude certain files from the Results array.

      +
    • Results: Map<string, string>

      The Results parameter is expected to be an array of results from a plan. Each element +in the array should be an array itself, with two elements. The first element represents the file +name, and the second element represents the file content.

      +

    Returns Map<string, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Pipe.Merge.html b/Documentation/functions/Pipe.Merge.html new file mode 100644 index 00000000..dd16090a --- /dev/null +++ b/Documentation/functions/Pipe.Merge.html @@ -0,0 +1,2 @@ +Merge | @playform/pipe - v0.0.2

Function Merge

  • Merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    +

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Pipe.dirname.html b/Documentation/functions/Pipe.dirname.html new file mode 100644 index 00000000..1b4877a9 --- /dev/null +++ b/Documentation/functions/Pipe.dirname.html @@ -0,0 +1,4 @@ +dirname | @playform/pipe - v0.0.2

Function dirname

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Pipe.pipe-1.html b/Documentation/functions/Pipe.pipe-1.html new file mode 100644 index 00000000..11c2786e --- /dev/null +++ b/Documentation/functions/Pipe.pipe-1.html @@ -0,0 +1,3 @@ +pipe | @playform/pipe - v0.0.2

Function pipe

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/functions/Pipe.stat.html b/Documentation/functions/Pipe.stat.html new file mode 100644 index 00000000..9eccdc82 --- /dev/null +++ b/Documentation/functions/Pipe.stat.html @@ -0,0 +1,3 @@ +stat | @playform/pipe - v0.0.2

Function stat

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/hierarchy.html b/Documentation/hierarchy.html new file mode 100644 index 00000000..1a755d95 --- /dev/null +++ b/Documentation/hierarchy.html @@ -0,0 +1 @@ +@playform/pipe - v0.0.2

@playform/pipe - v0.0.2

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/index.html b/Documentation/index.html new file mode 100644 index 00000000..3def25d3 --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,42 @@ +@playform/pipe - v0.0.2

@playform/pipe - v0.0.2

🧪 Pipe

Pipe allows you to process files in a pipeline, making it easy to perform +various operations on them.

+

Installation

To get started with Pipe, follow these steps:

+

Install the Pipe package using npm:

+
npm install -D -E @playform/pipe
+
+

Create a new pipe instance using the following code in your Index.ts file:

+

Index.ts

+
await new (await import("@playform/pipe")).default().In("./Input");
+
+

Getting started

With Pipe, you can use the Pipe method to perform operations on files within +the pipe. Here's an example of how to use it in your Index.ts:

+

Index.ts

+
await(
    await(
        await new (await import("@playform/pipe")).default().In("./Input")
    ).By("**/*.md")
).Pipe({
    // Append some content to all of the text files
    Wrote: (On) => (On.Buffer += "LICENSE [MIT]"),
});
+
+

Default Callbacks

Pipe provides default callbacks for file processing. These callbacks can be +customized to suit your specific needs. Here are the default callbacks:

+
await new (await import("@playform/pipe")).default().Pipe({
    // Read the file into a buffer
    Read: async ({ Input }) => await fs.promises.readFile(Input, "utf-8"),

    // Wrote the buffer into a file
    Wrote: async ({ Buffer }) => Buffer,

    // Passed the file through a check
    Passed: async (On) => On && true,

    // Failed processing the file
    Failed: async ({ Input }) => `Error: Cannot process file ${Input}!`,

    // Accomplished processing the file
    Accomplished: async ({ Input, Output }) =>
        `Processed ${Input} in ${Output}.`,

    // Fulfilled the whole plan
    Fulfilled: async ({ File }) =>
        `Successfully processed a total of ${File} ${
            File === 1 ? "file" : "files"
        }.`,

    // Changed the plan
    Changed: async (Plan) => Plan,
});
+
+

Add Multiple Paths

You can add multiple paths to your pipe by specifying an array as the Path +variable:

+

Index.ts

+
await new (await import("@playform/pipe")).default().In([
    "./Input",
    "./Input2",
]);
+
+

Input-Output Mapping

Pipe will allow you to provide a map of paths for different input and output +directories, making it easy to control where files are read from and written to:

+

Index.ts

+
await new (await import("@playform/pipe")).default().In(
    new Map([["./Input", "./Output"]])
);
+
+

File Filtering

You can filter files to exclude specific ones from your Pipe. Filters can be +an array of regular expressions or a single match. You can also use functions to +match on file names:

+

Index.ts

+
await new (await import("@playform/pipe")).default().Not([
    "File.txt",
    (File: string) => File === "./Input/File.txt",
]);
+
+

Controlling Logging

You can control the logging level by setting the Logger parameter. The default +value is 2, but you can set it to 0 if you don't want to see debug messages:

+

Index.ts

+
new (await import("@playform/pipe")).default(0);
+
+

Changelog

See CHANGELOG.md for a history of changes to this component.

+

Settings

Member Visibility

Theme

On This Page

🧪 Pipe

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Apply.Interface.html b/Documentation/interfaces/Apply.Interface.html new file mode 100644 index 00000000..efdd02b6 --- /dev/null +++ b/Documentation/interfaces/Apply.Interface.html @@ -0,0 +1,2 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((_Function, Test) => Promise<any>)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/By.Interface.html b/Documentation/interfaces/By.Interface.html new file mode 100644 index 00000000..53216f7b --- /dev/null +++ b/Documentation/interfaces/By.Interface.html @@ -0,0 +1,13 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((File, Paths, Results) => Promise<Map<string, string>>)
  • Interface(File, Paths, Results): Promise<Map<string, string>>

  • The function By takes in a file pattern or an array of file patterns, a set +of input and output paths, and a map of results, and returns the updated map +of results after matching the file patterns with the input paths.

    +

    Parameters

    • File: string | string[]

      File is either a single file pattern or an array of file +patterns. These patterns are used to match files in the input directory +(Input) that will be processed.

      +
    • Paths: Map<string, string>

      Paths is an array of tuples that represent the input and +output paths. +Each tuple contains two elements: the input path and the output path.

      +
    • Results: Map<string, string>

      Map object that stores the mapping between the output file +paths and their corresponding input file paths. It is used to keep track of +the files that have been processed and their respective destinations.

      +

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Bytes.Interface.html b/Documentation/interfaces/Bytes.Interface.html new file mode 100644 index 00000000..f1c2f723 --- /dev/null +++ b/Documentation/interfaces/Bytes.Interface.html @@ -0,0 +1,7 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((Bytes, Decimals?) => string)
  • Interface(Bytes, Decimals?): string

  • The function converts a given number of bytes into a human-readable format with appropriate units +(e.g., KB, MB, GB).

    +

    Parameters

    • Bytes: number

      The Bytes parameter is the number of bytes that you want to convert to a +human-readable format.

      +
    • Optional Decimals: number

      The Decimals parameter is an optional parameter that specifies the number +of decimal places to round the result to. If not provided, it defaults to 2.

      +

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/File.Interface.html b/Documentation/interfaces/File.Interface.html new file mode 100644 index 00000000..b40eab71 --- /dev/null +++ b/Documentation/interfaces/File.Interface.html @@ -0,0 +1,24 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    By: ((File) => Promise<ThisType<Interface>>);
    In: ((Path) => Promise<ThisType<Interface>>);
    Not: ((File) => Promise<ThisType<Interface>>);
    Pipe: ((Action?) => Promise<ThisType<Interface>>);
    Plan: Interface;
}

Implemented by

Properties

By +In +Not +Pipe +Plan +

Properties

By

By: ((File) => Promise<ThisType<Interface>>)

The function By takes a file pattern or an array of file patterns and returns a promise that +resolves to the results of executing the patterns on the specified paths.

+

Type declaration

    • (File): Promise<ThisType<Interface>>

    • Parameters

      • File: string | string[]

        parameter is of type Pattern or +Pattern[]. It represents the file or files that you want to search for. The Pattern type is a +string pattern that can include wildcards to match multiple files.

        +

      Returns Promise<ThisType<Interface>>

In

In: ((Path) => Promise<ThisType<Interface>>)

The function In takes a path and updates the Plan.Paths property with the input and output +paths.

+

Type declaration

    • (Path): Promise<ThisType<Interface>>

    • Parameters

      • Path: Type

        parameter is a string that represents the path to a file or +directory. It has a default value of "./", which means it will use the current directory if no path +is provided.

        +

      Returns Promise<ThisType<Interface>>

Not

Not: ((File) => Promise<ThisType<Interface>>)

The function Not takes a File parameter and excludes it from the Plan.Results array.

+

Type declaration

Pipe

Pipe: ((Action?) => Promise<ThisType<Interface>>)

The function Pipe is a TypeScript async function that takes an optional Action +parameter and returns the result of calling Pipe with this.Plan and Action.

+

Type declaration

    • (Action?): Promise<ThisType<Interface>>

    • Parameters

      • Optional Action: Interface

        The Action parameter is an optional parameter that +specifies the execution strategy to be used in the Pipe function. It has a default value of +Default.Pipe, which means that if no Action parameter is provided when calling the Pipe +function, it will use the default execution strategy.

        +

      Returns Promise<ThisType<Interface>>

Plan

Plan: Interface

Settings

Member Visibility

Theme

On This Page

ByInNotPipePlan

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/In.Interface.html b/Documentation/interfaces/In.Interface.html new file mode 100644 index 00000000..bff8d6e7 --- /dev/null +++ b/Documentation/interfaces/In.Interface.html @@ -0,0 +1,6 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((Path, Paths) => Promise<Map<string, string>>)
  • Interface(Path, Paths): Promise<Map<string, string>>

  • The function In takes a Path and a Paths object, and adds the Path to the Paths object.

    +

    Parameters

    • Path: Type

      The Path parameter is a string or URL that represents the path to a file or +directory.

      +
    • Paths: Map<string, string>

      Paths is a variable of type Plan["Paths"]. It is likely an object or a map that +stores key-value pairs.

      +

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Action.Interface.html b/Documentation/interfaces/Interface_Action.Interface.html new file mode 100644 index 00000000..f7c199f4 --- /dev/null +++ b/Documentation/interfaces/Interface_Action.Interface.html @@ -0,0 +1,22 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    Accomplished?: boolean | ((On) => Promise<string | false>);
    Changed?: ((Plan) => Promise<Interface>);
    Failed?: boolean | ((Input, _Error) => Promise<string | false>);
    Fulfilled?: boolean | ((Plan) => Promise<string | false>);
    Passed?: ((On) => Promise<boolean>);
    Read?: ((On) => Promise<Type>);
    Wrote?: ((On) => Promise<Type>);
}

Properties

Accomplished? +Changed? +Failed? +Fulfilled? +Passed? +Read? +Wrote? +

Properties

Optional Accomplished

Accomplished?: boolean | ((On) => Promise<string | false>)

Attaches a callback for actions that are accomplished.

+

Type declaration

Param: On

The file on which an action was accomplished.

+

Optional Changed

Changed?: ((Plan) => Promise<Interface>)

Attaches a callback for actions that result in changes to the plan.

+

Type declaration

Optional Failed

Failed?: boolean | ((Input, _Error) => Promise<string | false>)

Attaches a callback for handling failures in the Action.

+

Type declaration

Param: Input

The input file being processed.

+

Param: _Error

The error encountered during execution.

+

Optional Fulfilled

Fulfilled?: boolean | ((Plan) => Promise<string | false>)

Attaches a callback for the fulfillment of the Action.

+

Type declaration

Param: Plan

Optional Passed

Passed?: ((On) => Promise<boolean>)

Attaches a callback for actions that check if a file can pass through the pipe.

+

Type declaration

    • (On): Promise<boolean>

    • Parameters

      • On: Interface

        The file on which the action is being checked.

        +

      Returns Promise<boolean>

Optional Read

Read?: ((On) => Promise<Type>)

Attaches a callback for reading from a file.

+

Type declaration

Optional Wrote

Wrote?: ((On) => Promise<Type>)

Attaches a callback for writing to a file.

+

Type declaration

Settings

Member Visibility

Theme

On This Page

AccomplishedChangedFailedFulfilledPassedReadWrote

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Cache.Interface.html b/Documentation/interfaces/Interface_Cache.Interface.html new file mode 100644 index 00000000..14008f17 --- /dev/null +++ b/Documentation/interfaces/Interface_Cache.Interface.html @@ -0,0 +1,3 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    Folder: string | URL;
    Search: string | URL;
}

Properties

Folder +Search +

Properties

Folder

Folder: string | URL

Search

Search: string | URL

Settings

Member Visibility

Theme

On This Page

FolderSearch

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Dir.Interface.html b/Documentation/interfaces/Interface_Dir.Interface.html new file mode 100644 index 00000000..78df4f08 --- /dev/null +++ b/Documentation/interfaces/Interface_Dir.Interface.html @@ -0,0 +1,5 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    Input: string;
    Output: string;
}

Properties

Input +Output +

Properties

Input

Input: string

The input directory.

+

Output

Output: string

The output directory.

+

Settings

Member Visibility

Theme

On This Page

InputOutput

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_File.Interface.html b/Documentation/interfaces/Interface_File.Interface.html new file mode 100644 index 00000000..3d811896 --- /dev/null +++ b/Documentation/interfaces/Interface_File.Interface.html @@ -0,0 +1,11 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    After: number;
    Before: number;
    Buffer: Type;
    Input: string;
    Output: string;
}

Properties

After +Before +Buffer +Input +Output +

Properties

After

After: number

The size after the action.

+

Before

Before: number

The size before the action.

+

Buffer

Buffer: Type

The buffer data.

+

Input

Input: string

The input file.

+

Output

Output: string

The output file.

+

Settings

Member Visibility

Theme

On This Page

AfterBeforeBufferInputOutput

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Merge.Generic.html b/Documentation/interfaces/Interface_Merge.Generic.html new file mode 100644 index 00000000..41eac8e8 --- /dev/null +++ b/Documentation/interfaces/Interface_Merge.Generic.html @@ -0,0 +1,2 @@ +Generic | @playform/pipe - v0.0.2

Interface Generic

interface Generic {
    DeepMergeArraysURI: "DeepMergeLeafURI";
}

Properties

DeepMergeArraysURI +

Properties

DeepMergeArraysURI

DeepMergeArraysURI: "DeepMergeLeafURI"

Settings

Member Visibility

Theme

On This Page

DeepMergeArraysURI

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Merge.Type.html b/Documentation/interfaces/Interface_Merge.Type.html new file mode 100644 index 00000000..e1b7a7f6 --- /dev/null +++ b/Documentation/interfaces/Interface_Merge.Type.html @@ -0,0 +1,2 @@ +Type | @playform/pipe - v0.0.2

Interface Type<PMF>

interface Type<PMF> (<Ts>(...Objects) => DeepMergeHKT<Ts, Readonly<{
    DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeArraysDefaultURI";
    DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeMapsDefaultURI";
    DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeLeafURI";
    DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeRecordsDefaultURI";
    DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeSetsDefaultURI";
}>, Readonly<{
    key: PropertyKey;
    parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>)

Type Parameters

  • PMF extends Partial<DeepMergeMergeFunctionsURIs>
  • Type<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    +

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Option.Interface.html b/Documentation/interfaces/Interface_Option.Interface.html new file mode 100644 index 00000000..7dfba4e3 --- /dev/null +++ b/Documentation/interfaces/Interface_Option.Interface.html @@ -0,0 +1,19 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    Action?: boolean | Interface;
    Cache?: boolean | Interface;
    Exclude?: boolean | Type | Set<Type> | Type[];
    File?: string | boolean | string[];
    Logger?: boolean | Type;
    Path?: boolean | Type | Set<Type> | Type[];
}

Properties

Action? +Cache? +Exclude? +File? +Logger? +Path? +

Properties

Optional Action

Action?: boolean | Interface

Action pipe configuration.

+

Optional Cache

Cache?: boolean | Interface

Configuration for the target cache.

+

Default

{ Search: "./", Folder: "./Cache" }
+
+

Optional Exclude

Exclude?: boolean | Type | Set<Type> | Type[]

Criteria for excluding files.

+

Optional File

File?: string | boolean | string[]

File patterns to be matched.

+

Optional Logger

Logger?: boolean | Type

Debugging level.

+

Default

2
+
+

Optional Path

Path?: boolean | Type | Set<Type> | Type[]

Configuration for the target path(s).

+

Default

"./Target"
+
+

Settings

Member Visibility

Theme

On This Page

ActionCacheExcludeFileLoggerPath

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Interface_Plan.Interface.html b/Documentation/interfaces/Interface_Plan.Interface.html new file mode 100644 index 00000000..9069d39d --- /dev/null +++ b/Documentation/interfaces/Interface_Plan.Interface.html @@ -0,0 +1,15 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface {
    Cache: Interface;
    File: number;
    Info: any;
    Logger: Type;
    On: Interface;
    Paths: Map<string, string>;
    Results: Map<string, string>;
}

Properties

Cache +File +Info +Logger +On +Paths +Results +

Properties

Cache

Cache: Interface

Represents the cache configuration.

+

File

File: number

The number of files in the execution plan.

+

Info

Info: any

biome-ignore lint/suspicious/noExplicitAny:

+

Logger

Logger: Type

The debugging level for the execution plan.

+

On

On: Interface

The file currently being operated on.

+

Paths

Paths: Map<string, string>

Mapping of input paths to output paths.

+

Results

Results: Map<string, string>

Mapping of result paths to corresponding input paths.

+

Settings

Member Visibility

Theme

On This Page

CacheFileInfoLoggerOnPathsResults

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Not.Interface.html b/Documentation/interfaces/Not.Interface.html new file mode 100644 index 00000000..cd58912a --- /dev/null +++ b/Documentation/interfaces/Not.Interface.html @@ -0,0 +1,8 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((Pattern, Results) => Map<string, string>)
  • Interface(Pattern, Results): Map<string, string>

  • The function Not filters out files from the File array based on the provided Pattern +parameter.

    +

    Parameters

    • Pattern: undefined | boolean | Type | Set<Type> | Type[]

      The Pattern parameter is of type Option["Exclude"]. It represents the patterns +or filters that will be used to exclude certain files from the Results array.

      +
    • Results: Map<string, string>

      The Results parameter is expected to be an array of results from a plan. Each element +in the array should be an array itself, with two elements. The first element represents the file +name, and the second element represents the file content.

      +

    Returns Map<string, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/interfaces/Pipe.Interface.html b/Documentation/interfaces/Pipe.Interface.html new file mode 100644 index 00000000..6a867696 --- /dev/null +++ b/Documentation/interfaces/Pipe.Interface.html @@ -0,0 +1,3 @@ +Interface | @playform/pipe - v0.0.2

Interface Interface

interface Interface ((Plan, Action) => Promise<Interface>)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Apply.html b/Documentation/modules/Apply.html new file mode 100644 index 00000000..ecf1b39b --- /dev/null +++ b/Documentation/modules/Apply.html @@ -0,0 +1,3 @@ +Apply | @playform/pipe - v0.0.2

Module Apply

Index

Interfaces

Interface +

Functions

apply +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/By.html b/Documentation/modules/By.html new file mode 100644 index 00000000..65475982 --- /dev/null +++ b/Documentation/modules/By.html @@ -0,0 +1,3 @@ +By | @playform/pipe - v0.0.2

Module By

Index

Interfaces

Interface +

Functions

by +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Bytes.html b/Documentation/modules/Bytes.html new file mode 100644 index 00000000..f00438a5 --- /dev/null +++ b/Documentation/modules/Bytes.html @@ -0,0 +1,4 @@ +Bytes | @playform/pipe - v0.0.2

Module Bytes

Index

Interfaces

Interface +

Variables

Kilobyte +

Functions

bytes +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/File.html b/Documentation/modules/File.html new file mode 100644 index 00000000..8aa3dd55 --- /dev/null +++ b/Documentation/modules/File.html @@ -0,0 +1,2 @@ +File | @playform/pipe - v0.0.2

Module File

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/In.html b/Documentation/modules/In.html new file mode 100644 index 00000000..890854ab --- /dev/null +++ b/Documentation/modules/In.html @@ -0,0 +1,5 @@ +In | @playform/pipe - v0.0.2

Module In

Index

Interfaces

Interface +

Variables

_Path +

Functions

Apply +in +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Action.html b/Documentation/modules/Interface_Action.html new file mode 100644 index 00000000..b4ff9ef5 --- /dev/null +++ b/Documentation/modules/Interface_Action.html @@ -0,0 +1,2 @@ +Interface/Action | @playform/pipe - v0.0.2

Module Interface/Action

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Cache.html b/Documentation/modules/Interface_Cache.html new file mode 100644 index 00000000..51cd68a5 --- /dev/null +++ b/Documentation/modules/Interface_Cache.html @@ -0,0 +1,2 @@ +Interface/Cache | @playform/pipe - v0.0.2

Module Interface/Cache

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Dir.html b/Documentation/modules/Interface_Dir.html new file mode 100644 index 00000000..03787b73 --- /dev/null +++ b/Documentation/modules/Interface_Dir.html @@ -0,0 +1,2 @@ +Interface/Dir | @playform/pipe - v0.0.2

Module Interface/Dir

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_File.html b/Documentation/modules/Interface_File.html new file mode 100644 index 00000000..fcf24e36 --- /dev/null +++ b/Documentation/modules/Interface_File.html @@ -0,0 +1,2 @@ +Interface/File | @playform/pipe - v0.0.2

Module Interface/File

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Merge.html b/Documentation/modules/Interface_Merge.html new file mode 100644 index 00000000..12cb5428 --- /dev/null +++ b/Documentation/modules/Interface_Merge.html @@ -0,0 +1,4 @@ +Interface/Merge | @playform/pipe - v0.0.2

Module Interface/Merge

Template: PMF

A type parameter representing Partial.

+

Index

Interfaces

Generic +Type +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Option.html b/Documentation/modules/Interface_Option.html new file mode 100644 index 00000000..1fe019fb --- /dev/null +++ b/Documentation/modules/Interface_Option.html @@ -0,0 +1,2 @@ +Interface/Option | @playform/pipe - v0.0.2

Module Interface/Option

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Interface_Plan.html b/Documentation/modules/Interface_Plan.html new file mode 100644 index 00000000..e32543be --- /dev/null +++ b/Documentation/modules/Interface_Plan.html @@ -0,0 +1,2 @@ +Interface/Plan | @playform/pipe - v0.0.2

Module Interface/Plan

Index

Interfaces

Interface +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Merge.html b/Documentation/modules/Merge.html new file mode 100644 index 00000000..9b15e2a2 --- /dev/null +++ b/Documentation/modules/Merge.html @@ -0,0 +1,2 @@ +Merge | @playform/pipe - v0.0.2

Module Merge

Index

Functions

merge +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Not.html b/Documentation/modules/Not.html new file mode 100644 index 00000000..6bfd16d6 --- /dev/null +++ b/Documentation/modules/Not.html @@ -0,0 +1,4 @@ +Not | @playform/pipe - v0.0.2

Module Not

Index

Interfaces

Interface +

Variables

Filters +

Functions

not +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Option.html b/Documentation/modules/Option.html new file mode 100644 index 00000000..10bcc620 --- /dev/null +++ b/Documentation/modules/Option.html @@ -0,0 +1,2 @@ +Option | @playform/pipe - v0.0.2

Module Option

Index

Variables

option +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Pipe.html b/Documentation/modules/Pipe.html new file mode 100644 index 00000000..76eb296a --- /dev/null +++ b/Documentation/modules/Pipe.html @@ -0,0 +1,10 @@ +Pipe | @playform/pipe - v0.0.2

Module Pipe

Index

Classes

pipe +

Interfaces

Interface +

Variables

Action +Cache +Logger +

Functions

Merge +dirname +pipe +stat +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Type_Buffer.html b/Documentation/modules/Type_Buffer.html new file mode 100644 index 00000000..a2ae872d --- /dev/null +++ b/Documentation/modules/Type_Buffer.html @@ -0,0 +1,2 @@ +Type/Buffer | @playform/pipe - v0.0.2

Module Type/Buffer

Index

Type Aliases

Type +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Type_Exclude.html b/Documentation/modules/Type_Exclude.html new file mode 100644 index 00000000..14edd35f --- /dev/null +++ b/Documentation/modules/Type_Exclude.html @@ -0,0 +1,2 @@ +Type/Exclude | @playform/pipe - v0.0.2

Module Type/Exclude

Index

Type Aliases

Type +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Type_Logger.html b/Documentation/modules/Type_Logger.html new file mode 100644 index 00000000..81dabd5c --- /dev/null +++ b/Documentation/modules/Type_Logger.html @@ -0,0 +1,2 @@ +Type/Logger | @playform/pipe - v0.0.2

Module Type/Logger

Index

Type Aliases

Type +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/modules/Type_Path.html b/Documentation/modules/Type_Path.html new file mode 100644 index 00000000..9b3af010 --- /dev/null +++ b/Documentation/modules/Type_Path.html @@ -0,0 +1,2 @@ +Type/Path | @playform/pipe - v0.0.2

Module Type/Path

Index

Type Aliases

Type +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/types/Type_Buffer.Type.html b/Documentation/types/Type_Buffer.Type.html new file mode 100644 index 00000000..d6e4545c --- /dev/null +++ b/Documentation/types/Type_Buffer.Type.html @@ -0,0 +1 @@ +Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | NodeJS.ArrayBufferView | Iterable<string | NodeJS.ArrayBufferView> | AsyncIterable<string | NodeJS.ArrayBufferView> | Stream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/types/Type_Exclude.Type.html b/Documentation/types/Type_Exclude.Type.html new file mode 100644 index 00000000..dcf2d4cf --- /dev/null +++ b/Documentation/types/Type_Exclude.Type.html @@ -0,0 +1 @@ +Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | RegExp | ((File) => boolean)

Type declaration

    • (File): boolean

    • Parameters

      • File: string

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/types/Type_Logger.Type.html b/Documentation/types/Type_Logger.Type.html new file mode 100644 index 00000000..d3093028 --- /dev/null +++ b/Documentation/types/Type_Logger.Type.html @@ -0,0 +1 @@ +Type | @playform/pipe - v0.0.2

Type alias Type

Type: 0 | 1 | 2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/types/Type_Path.Type.html b/Documentation/types/Type_Path.Type.html new file mode 100644 index 00000000..e30ee399 --- /dev/null +++ b/Documentation/types/Type_Path.Type.html @@ -0,0 +1 @@ +Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | URL | Map<string | URL, string | URL>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Bytes.Kilobyte.html b/Documentation/variables/Bytes.Kilobyte.html new file mode 100644 index 00000000..8e8c3d0f --- /dev/null +++ b/Documentation/variables/Bytes.Kilobyte.html @@ -0,0 +1 @@ +Kilobyte | @playform/pipe - v0.0.2

Variable KilobyteConst

Kilobyte: 1024 = 1024

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/In._Path.html b/Documentation/variables/In._Path.html new file mode 100644 index 00000000..c25d486a --- /dev/null +++ b/Documentation/variables/In._Path.html @@ -0,0 +1 @@ +_Path | @playform/pipe - v0.0.2

Variable _Path

_Path: Type

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Not.Filters.html b/Documentation/variables/Not.Filters.html new file mode 100644 index 00000000..fe88a7a0 --- /dev/null +++ b/Documentation/variables/Not.Filters.html @@ -0,0 +1 @@ +Filters | @playform/pipe - v0.0.2

Variable FiltersConst

Filters: Set<unknown> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Option.option.html b/Documentation/variables/Option.option.html new file mode 100644 index 00000000..ecbfeded --- /dev/null +++ b/Documentation/variables/Option.option.html @@ -0,0 +1,2 @@ +option | @playform/pipe - v0.0.2

Variable option

option: {
    Action: {
        Accomplished: ((__namedParameters) => Promise<string>);
        Changed: ((Plan) => Promise<Interface>);
        Failed: ((__namedParameters) => Promise<string>);
        Fulfilled: ((__namedParameters) => Promise<string | false>);
        Passed: ((On) => Promise<true>);
        Read: ((__namedParameters) => Promise<string>);
        Wrote: ((__namedParameters) => Promise<Type>);
    };
    Cache: {
        Folder: string;
        Search: string;
    };
    Exclude: false;
    File: string;
    Logger: 2;
    Path: string;
}

Type declaration

  • Action: {
        Accomplished: ((__namedParameters) => Promise<string>);
        Changed: ((Plan) => Promise<Interface>);
        Failed: ((__namedParameters) => Promise<string>);
        Fulfilled: ((__namedParameters) => Promise<string | false>);
        Passed: ((On) => Promise<true>);
        Read: ((__namedParameters) => Promise<string>);
        Wrote: ((__namedParameters) => Promise<Type>);
    }
  • Cache: {
        Folder: string;
        Search: string;
    }
    • Folder: string
    • Search: string
  • Exclude: false
  • File: string
  • Logger: 2
  • Path: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Pipe.Action.html b/Documentation/variables/Pipe.Action.html new file mode 100644 index 00000000..e82ad2ff --- /dev/null +++ b/Documentation/variables/Pipe.Action.html @@ -0,0 +1,2 @@ +Action | @playform/pipe - v0.0.2

Variable Action

Action: {
    Accomplished: ((__namedParameters) => Promise<string>);
    Changed: ((Plan) => Promise<Interface>);
    Failed: ((__namedParameters) => Promise<string>);
    Fulfilled: ((__namedParameters) => Promise<string | false>);
    Passed: ((On) => Promise<true>);
    Read: ((__namedParameters) => Promise<string>);
    Wrote: ((__namedParameters) => Promise<Type>);
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Pipe.Cache.html b/Documentation/variables/Pipe.Cache.html new file mode 100644 index 00000000..000b47c7 --- /dev/null +++ b/Documentation/variables/Pipe.Cache.html @@ -0,0 +1 @@ +Cache | @playform/pipe - v0.0.2

Variable Cache

Cache: {
    Folder: string;
    Search: string;
}

Type declaration

  • Folder: string
  • Search: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/Documentation/variables/Pipe.Logger.html b/Documentation/variables/Pipe.Logger.html new file mode 100644 index 00000000..4a467e5e --- /dev/null +++ b/Documentation/variables/Pipe.Logger.html @@ -0,0 +1 @@ +Logger | @playform/pipe - v0.0.2

Variable Logger

Logger: 2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/package.json b/package.json index 09c38c0e..59704578 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@playform/pipe", - "version": "0.0.1", + "version": "0.0.2", "private": false, "description": "🧪 Pipe.", "keywords": [ @@ -27,6 +27,7 @@ "main": "./Target/Class/Pipe.js", "types": "./Target/Class/Pipe.d.ts", "scripts": { + "Document": "Document 'Source/**/*.ts'", "prepublishOnly": "Build 'Source/**/*.ts'" }, "dependencies": { @@ -35,6 +36,7 @@ "fast-glob": "3.3.2" }, "devDependencies": { + "@playform/document": "0.0.5", "@playform/build": "0.0.4" }, "publishConfig": {