diff --git a/docs/assets/main.js b/docs/assets/main.js index 4c8fa61..3cee05e 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,6 +1,6 @@ "use strict"; "use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);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()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); /*! Bundled license information: diff --git a/docs/assets/style.css b/docs/assets/style.css index 18b4f8f..258146f 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -32,7 +32,6 @@ --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -72,7 +71,6 @@ --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -468,13 +466,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -485,6 +482,19 @@ blockquote { .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; @@ -909,8 +919,8 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#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 { @@ -1070,7 +1080,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } diff --git a/docs/classes/AbstractService.html b/docs/classes/AbstractService.html index adc3956..7f06b3f 100644 --- a/docs/classes/AbstractService.html +++ b/docs/classes/AbstractService.html @@ -30,7 +30,7 @@

Hierarchy

  • SetStateService
  • UsrcfgCgiService
    • +
  • Defined in abstract-service.ts:59
    • @@ -69,34 +69,32 @@

    Parameters

  • config: IServiceConfig

    Service config.

    -
    -
    • +
  • logger: ILogger

    Service logger.

    -
    -
    • +

    Returns AbstractService

    +
  • Defined in abstract-service.ts:112

    • Properties

    Protected _config

    _config: IServiceConfig
    +
  • Defined in abstract-service.ts:60

    • Abstract _endpoint

    _endpoint: string

    Specific webservice endpoint.

    An absolute URL, which means a path with leading slash ('/') relative to -the controllerUrl (ProCon.IP base address).

    +the IServiceConfig.controllerUrl (ProCon.IP base address).

    +
  • Defined in abstract-service.ts:68

    • Abstract _method

    _method: Method
    @@ -108,7 +106,7 @@

    Abstract

    +
  • Defined in abstract-service.ts:89

    • Protected _requestHeaders

    _requestHeaders: {
        [key: string]: string;
    }
    @@ -124,7 +122,7 @@

    Type declaration

    [key: string]: string
    +
  • Defined in abstract-service.ts:99

    • Protected log

    log: ILogger
    @@ -132,7 +130,7 @@

    Protected

    +
  • Defined in abstract-service.ts:104

    • Accessors

    @@ -145,7 +143,7 @@

    ProtectedReturns AxiosRequestConfig<any>

    +
  • Defined in abstract-service.ts:164

    • baseUrl

    +
  • Defined in abstract-service.ts:123

    • url

      @@ -171,7 +169,7 @@

      Returns stringThrows

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141
    • @@ -225,5 +223,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/CommandService.html b/docs/classes/CommandService.html index f48bb6a..034d6f0 100644 --- a/docs/classes/CommandService.html +++ b/docs/classes/CommandService.html @@ -27,7 +27,7 @@

    Hierarchy

    • CommandService
    +
  • Defined in command.service.ts:25
    • @@ -75,18 +75,16 @@

    Parameters

  • config: IServiceConfig

    Service config.

    -
    -
    • +
  • logger: ILogger

    Service logger.

    -
    -
    • +

    Returns CommandService

    +
  • Defined in abstract-service.ts:112

    • Properties

    @@ -94,17 +92,17 @@

    Protected_config: IServiceConfig

    +
  • Defined in abstract-service.ts:60

    • _endpoint

    _endpoint: string = '/Command.htm'

    Specific service endpoint.

    -

    A path relative to the controllerUrl.

    +

    A path relative to the IServiceConfig.controllerUrl.

    +
  • Defined in command.service.ts:31

    • _method

    _method: Method = 'get'
    @@ -114,7 +112,7 @@

    _method

    +
  • Defined in command.service.ts:37

    • Protected _requestHeaders

    _requestHeaders: {
        [key: string]: string;
    }
    @@ -131,7 +129,7 @@
    [
    +
  • Defined in abstract-service.ts:99

    • Protected log

    log: ILogger
    @@ -140,7 +138,7 @@

    Protected

    +
  • Defined in abstract-service.ts:104

    • Accessors

    @@ -154,7 +152,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164

    • baseUrl

    +
  • Defined in abstract-service.ts:123

    • url

      @@ -182,7 +180,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141

    • Methods

    @@ -199,7 +197,7 @@
    dosageTarget: dosageDuration: number

    Returns Promise<number>

    +
  • Defined in command.service.ts:84

    • Private sendManualDosage

    Returns AxiosPromise

    +
  • Defined in command.service.ts:106

    • setChlorineDosage

      @@ -228,12 +226,11 @@

      Parameters

    • dosageTime: number

      Dosage duration in seconds.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in command.service.ts:44

    • setDosage

      @@ -247,17 +244,15 @@

      Parameters

    • dosageTarget: DosageTarget

      Dosage target (0 = chlorine, 1 = pH minus, 2 = pH plus).

      -
      -
      • +
    • dosageDuration: number

      Desired duration in seconds.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in command.service.ts:72

    • setPhMinusDosage

      @@ -271,12 +266,11 @@

      Parameters

    • dosageTime: number

      Dosage duration in seconds.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in command.service.ts:53

    • setPhPlusDosage

      @@ -290,12 +284,11 @@

      Parameters

    • dosageTime: number

      Dosage duration in seconds.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in command.service.ts:62
    • @@ -355,5 +348,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/GetStateData.html b/docs/classes/GetStateData.html index fe7c450..0eea0ab 100644 --- a/docs/classes/GetStateData.html +++ b/docs/classes/GetStateData.html @@ -29,7 +29,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in get-state-data.ts:86
    • @@ -80,12 +80,11 @@

    Parameters

    Optional rawData: string

    Plain response string of the GetStateService or the /GetState.csv API endpoint.

    -
    -
    +Optional

    Returns GetStateData

    +
  • Defined in get-state-data.ts:220

    • Properties

    @@ -96,12 +95,12 @@

    active

    +
  • Defined in get-state-data.ts:135

    • Readonly categories

    categories: IGetStateCategories = GetStateData.categories
    +
  • Defined in get-state-data.ts:137

    • objects

    objects: GetStateDataObject[]
    @@ -110,7 +109,7 @@

    objects

    +
  • Defined in get-state-data.ts:129

    • parsed

    parsed: string[][]
    @@ -121,7 +120,7 @@

    parsed

    +
  • Defined in get-state-data.ts:114

    • raw

    raw: string
    @@ -129,7 +128,7 @@

    raw

    +
  • Defined in get-state-data.ts:95

    • sysInfo

    sysInfo: GetStateDataSysInfo
    @@ -139,7 +138,7 @@

    sysInfo

    +
  • Defined in get-state-data.ts:122

    • Static Readonly categories

    categories: IGetStateCategories = ...
    @@ -153,7 +152,7 @@

    Static

    +
  • Defined in get-state-data.ts:149

    • Methods

    @@ -169,13 +168,12 @@

    Parameters

  • index: number

    Column index

    -
    -
    • +

    Returns string

    Category name or string none if no category could be identified.

    +
  • Defined in get-state-data.ts:247

    • getChlorineDosageControl

    +
  • Defined in get-state-data.ts:312

    • getChlorineDosageControlId

    +
  • Defined in get-state-data.ts:291

    • getDataObject

      @@ -211,12 +209,11 @@

      Parameters

    • id: number

      Object column index.

      -
      -
    +

    Returns GetStateDataObject

    +
  • Defined in get-state-data.ts:274

    • getDataObjects

      @@ -230,17 +227,15 @@

      Parameters

    • indices: number[]

      An array of object indices specifying the return objects.

      -
      -
      • +
    • activeOnly: boolean = false

      Optionally filter for active objects only.

      -
      -
    +

    Returns GetStateDataObject[]

    +
  • Defined in get-state-data.ts:263

    • getDataObjectsByCategory

      @@ -254,17 +249,15 @@

      Parameters

    • category: string

      A valid category string (see GetStateCategory)

      -
      -
      • +
    • activeOnly: boolean = false

      Optionally filter for active objects only.

      -
      -
    +

    Returns GetStateDataObject[]

    +
  • Defined in get-state-data.ts:284

    • getPhMinusDosageControl

    +
  • Defined in get-state-data.ts:319

    • getPhMinusDosageControlId

    +
  • Defined in get-state-data.ts:298

    • getPhPlusDosageControl

    +
  • Defined in get-state-data.ts:326

    • getPhPlusDosageControlId

    +
  • Defined in get-state-data.ts:305

    • isDosageControl

    +
  • Defined in get-state-data.ts:333

    • parseCsv

      @@ -339,12 +332,11 @@

      Parameters

    • csv: string

      Raw CSV input string (response of the /GetState.csv endpoint)

      -
      -
    +

    Returns void

    +
  • Defined in get-state-data.ts:347
    • @@ -409,5 +401,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/GetStateDataObject.html b/docs/classes/GetStateDataObject.html index fbfa16d..d93a15b 100644 --- a/docs/classes/GetStateDataObject.html +++ b/docs/classes/GetStateDataObject.html @@ -30,7 +30,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in get-state-data-object.ts:12
    • @@ -66,7 +66,7 @@

    constructor
  • -

    Passthru all parameters to set.

    +

    Passthru all parameters to GetStateDataObject.set.

    Parameters

    @@ -74,37 +74,31 @@

    Parameters

  • index: number

    Column id/index

    -
    -
    • +
  • name: string

    Column or data portion name

    -
    -
    • +
  • unit: string

    Column or data portion unit (if applicable in any way)

    -
    -
    • +
  • offset: string

    Column value offset

    -
    -
    • +
  • gain: string

    Column value gain

    -
    -
    • +
  • measure: string

    Column value raw measurement

    -
    -
    • +

    Returns GetStateDataObject

    +
  • Defined in get-state-data-object.ts:89

    • Properties

    @@ -115,7 +109,7 @@

    active

    +
  • Defined in get-state-data-object.ts:77

    • category

    category: string
    @@ -123,7 +117,7 @@

    category

    +
  • Defined in get-state-data-object.ts:62

    • categoryId

    categoryId: number
    @@ -133,7 +127,7 @@

    categoryId

    +
  • Defined in get-state-data-object.ts:70

    • displayValue

    displayValue: string
    @@ -141,7 +135,7 @@

    displayValue

    +
  • Defined in get-state-data-object.ts:52

    • gain

    gain: number
    @@ -149,7 +143,7 @@

    gain

    +
  • Defined in get-state-data-object.ts:42

    • id

    id: number
    @@ -157,7 +151,7 @@

    id

    +
  • Defined in get-state-data-object.ts:22

    • label

    label: string
    @@ -165,7 +159,7 @@

    label

    +
  • Defined in get-state-data-object.ts:27

    • offset

    offset: number
    @@ -173,7 +167,7 @@

    offset

    +
  • Defined in get-state-data-object.ts:37

    • raw

    raw: number
    @@ -181,7 +175,7 @@

    raw

    +
  • Defined in get-state-data-object.ts:32

    • unit

    unit: string
    @@ -189,7 +183,7 @@

    unit

    +
  • Defined in get-state-data-object.ts:57

    • value

    value: string | number
    @@ -197,7 +191,7 @@

    value

    +
  • Defined in get-state-data-object.ts:47

    • Methods

    @@ -214,7 +208,6 @@

    Parameters

    callback: ((field) => any)

    A user-defined callback.

    -
    +
  • Defined in get-state-data-object.ts:154

    • set

      @@ -245,37 +238,31 @@

      Parameters

    • index: number

      Column id/index

      -
      -
      • +
    • name: string

      Column or data portion name

      -
      -
      • +
    • unit: string

      Column or data portion unit (if applicable in any way)

      -
      -
      • +
    • offset: string

      Column value offset

      -
      -
      • +
    • gain: string

      Column value gain

      -
      -
      • +
    • measure: string

      Column value raw measurement

      -
      -
    +

    Returns void

    +
  • Defined in get-state-data-object.ts:106
    • @@ -334,5 +321,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/GetStateDataSysInfo.html b/docs/classes/GetStateDataSysInfo.html index e720f4c..4f9c9dd 100644 --- a/docs/classes/GetStateDataSysInfo.html +++ b/docs/classes/GetStateDataSysInfo.html @@ -29,7 +29,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in get-state-data-sys-info.ts:15
    • @@ -82,13 +82,12 @@

    Parameters

  • Optional data: string[][]

    Parsed response CSV of the /GetState.csv endpoint as - 2-dimensional array (see: parsed)

    -
    -
    • + 2-dimensional array (see: GetStateData.parsed)

    +Optional

    Returns GetStateDataSysInfo

    +
  • Defined in get-state-data-sys-info.ts:120

    • Properties

    @@ -98,7 +97,7 @@

    chlorineDosageRelay

    +
  • Defined in get-state-data-sys-info.ts:112

    • configOtherEnable

    configOtherEnable: number
    @@ -119,7 +118,7 @@

    configOtherEnable

    +
  • Defined in get-state-data-sys-info.ts:81

    • dosageControl

    dosageControl: number
    @@ -138,7 +137,7 @@

    dosageControl

    +
  • Defined in get-state-data-sys-info.ts:97

    • ntpFaultState

    ntpFaultState: number
    @@ -155,7 +154,7 @@

    ntpFaultState

    +
  • Defined in get-state-data-sys-info.ts:63

    • phMinusDosageRelay

    phMinusDosageRelay: number
    @@ -163,7 +162,7 @@

    phMinusDosageRelay

    +
  • Defined in get-state-data-sys-info.ts:107

    • phPlusDosageRelay

    phPlusDosageRelay: number
    @@ -171,7 +170,7 @@

    phPlusDosageRelay

    +
  • Defined in get-state-data-sys-info.ts:102

    • resetRootCause

    resetRootCause: number
    @@ -188,13 +187,13 @@

    resetRootCause

    +
  • Defined in get-state-data-sys-info.ts:49

    • time

    time: string
    +
  • Defined in get-state-data-sys-info.ts:25

    • uptime

    uptime: number
    @@ -202,7 +201,7 @@

    uptime

    +
  • Defined in get-state-data-sys-info.ts:30

    • version

    version: string
    @@ -210,7 +209,7 @@

    version

    +
  • Defined in get-state-data-sys-info.ts:35

    • Methods

    @@ -229,12 +228,11 @@
    object:

    The GetStateDataObject to check, should be a GetStateData.categories.canister or a GetStateData.categories.canisterConsumptions object.

    - -
    +

    Returns number

    +
  • Defined in get-state-data-sys-info.ts:215

    • isAvatarEnabled

    +
  • Defined in get-state-data-sys-info.ts:234

    • isChlorineDosageEnabled

    +
  • Defined in get-state-data-sys-info.ts:160

    • isDmxEnabled

    +
  • Defined in get-state-data-sys-info.ts:256

    • isDosageEnabled

    +

    Returns boolean

    +
  • Defined in get-state-data-sys-info.ts:191

    • isElectrolysis

    +
  • Defined in get-state-data-sys-info.ts:167

    • isExtRelaysEnabled

    +
  • Defined in get-state-data-sys-info.ts:241

    • isFlowSensorEnabled

    +
  • Defined in get-state-data-sys-info.ts:249

    • isPhMinusDosageEnabled

    +
  • Defined in get-state-data-sys-info.ts:174

    • isPhPlusDosageEnabled

    +
  • Defined in get-state-data-sys-info.ts:181

    • setValuesFromArray

      @@ -357,13 +354,12 @@

      Parameters

    • data: string[][]

      Parsed response CSV of the /GetState.csv endpoint as - 2-dimensional array (see: parsed)

      -
      -
    + 2-dimensional array (see: GetStateData.parsed)

    +

    Returns void

    +
  • Defined in get-state-data-sys-info.ts:132

    • toArrayOfObjects

    +
  • Defined in get-state-data-sys-info.ts:148
    • @@ -443,5 +439,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/GetStateService.html b/docs/classes/GetStateService.html index 37c03c0..a46a81f 100644 --- a/docs/classes/GetStateService.html +++ b/docs/classes/GetStateService.html @@ -27,7 +27,7 @@

    Hierarchy

    • GetStateService
    +
  • Defined in get-state.service.ts:32
    • @@ -81,18 +81,16 @@

    Parameters

  • config: IGetStateServiceConfig

    Service configuration.

    -
    -
    • +
  • logger: ILogger

    Service logger.

    -
    -
    • +

    Returns GetStateService

    +
  • Defined in get-state.service.ts:105

    • Properties

    @@ -100,17 +98,17 @@

    Protected_config: IServiceConfig

    +
  • Defined in abstract-service.ts:60

    • _endpoint

    _endpoint: string = '/GetState.csv'

    Specific service endpoint.

    -

    A path relative to the controllerUrl.

    +

    A path relative to the IServiceConfig.controllerUrl.

    +
  • Defined in get-state.service.ts:38

    • _method

    _method: Method = 'get'
    @@ -120,7 +118,7 @@

    _method

    +
  • Defined in get-state.service.ts:44

    • Protected _requestHeaders

    _requestHeaders: {
        [key: string]: string;
    }
    @@ -137,7 +135,7 @@
    [
    +
  • Defined in abstract-service.ts:99

    • Private Optional _updateCallback

    _updateCallback?: ((data) => any)
    @@ -159,7 +157,7 @@
    data: Returns any
    +
  • Defined in get-state.service.ts:72

    • Private _updateInterval

    _updateInterval: number
    @@ -168,7 +166,7 @@

    Private

    +
  • Defined in get-state.service.ts:66

    • data

    data: GetStateData
    @@ -176,7 +174,7 @@

    data

    +
  • Defined in get-state.service.ts:49

    • Protected log

    log: ILogger
    @@ -185,7 +183,7 @@

    Protected

    +
  • Defined in abstract-service.ts:104

    • Accessors

    @@ -199,7 +197,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164

    • baseUrl

    +
  • Defined in abstract-service.ts:123

    • url

      @@ -227,7 +225,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141

    • Methods

    @@ -237,13 +235,13 @@

    autoUpdate

    Recursive wrapper for the polling mechanism. The next request/interval starts after the preceding one has ended. That means a big timeout -(timeout) could cause an actual higher update -interval (updateInterval).

    +(IGetStateServiceConfig.timeout) could cause an actual higher update +interval (IGetStateServiceConfig.updateInterval).

    Returns void

    +
  • Defined in get-state.service.ts:186

    • getData

    +
  • Defined in get-state.service.ts:255

    • getUpdateInterval

    +
  • Defined in get-state.service.ts:119

    • hasData

    +
  • Defined in get-state.service.ts:267

    • isRunning

    +
  • Defined in get-state.service.ts:135

    • setUpdateInterval

      @@ -305,12 +303,11 @@

      Parameters

    • milliseconds: number

      Update interval in milliseconds [ms].

      -
      -
    +

    Returns void

    +
  • Defined in get-state.service.ts:128

    • start

      @@ -328,8 +325,7 @@
      Optional

      Will be triggered everytime the service receives new data. The current GetStateData object is passed as parameter to the callback.

      - -
      +Optional
        • @@ -345,8 +341,7 @@

          Returns voidOptional errorCallback: ((e) => void)

          Error callback receives the most recent error as parameter, in case the consecutive error tolerance is hit.

          -
          -
          +Optional
            • @@ -363,12 +358,11 @@
              Optional

              Whether to stop in case the consecutive error tolerance is hit. Default behavior (for backward compatibility) is to keep running in any case.

              - -
            +Optional

          Returns void

    +
  • Defined in get-state.service.ts:154

    • stop

    +
  • Defined in get-state.service.ts:174

    • update

    +
  • Defined in get-state.service.ts:209
    • @@ -460,5 +454,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Logger.html b/docs/classes/Logger.html index 5e05d15..8bdfde4 100644 --- a/docs/classes/Logger.html +++ b/docs/classes/Logger.html @@ -32,7 +32,7 @@

    Implements

    +
  • Defined in logger.ts:61
    • @@ -69,12 +69,11 @@

    Parameters

  • Optional logLevel: LogLevel

    Optionally define a custom log level. Default is LogLevel.INFO.

    -
    -
    • +Optional

    Returns Logger

    +
  • Defined in logger.ts:72

    • Accessors

    @@ -88,7 +87,7 @@

    Returns string

    +
  • Defined in logger.ts:137

    • Methods

    @@ -104,13 +103,12 @@

    Parameters

  • message: string

    The debug message.

    -
    -
    • +

    Returns void

    +
  • Defined in logger.ts:93

    • error

      @@ -124,13 +122,12 @@

      Parameters

    • message: string

      The error message.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:126

    • info

      @@ -144,13 +141,12 @@

      Parameters

    • message: string

      The information.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:104

    • setLogLevel

    Returns void

    +
  • Defined in logger.ts:84

    • warn

      @@ -183,13 +178,12 @@

      Parameters

    • message: string

      The warning.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:115
    • @@ -241,5 +235,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/RelayDataInterpreter.html b/docs/classes/RelayDataInterpreter.html index e4136cb..23fc258 100644 --- a/docs/classes/RelayDataInterpreter.html +++ b/docs/classes/RelayDataInterpreter.html @@ -25,7 +25,7 @@

    Hierarchy

    • RelayDataInterpreter
    +
  • Defined in relay-data-interpreter.ts:32
    • @@ -64,12 +64,11 @@

    constructorParameters

    +
    logger: ILogger

    Returns RelayDataInterpreter

    +
  • Defined in relay-data-interpreter.ts:46

    • Properties

    @@ -80,12 +79,12 @@

    bitStates

    +
  • Defined in relay-data-interpreter.ts:37

    • Private log

    log: ILogger
    +
  • Defined in relay-data-interpreter.ts:39

    • Methods

    @@ -107,12 +106,11 @@

    Parameters

  • stateData: GetStateData

    The most recent GetStateData instance.

    -
    -
    • +

    Returns RelayDataInterpreter

    +
  • Defined in relay-data-interpreter.ts:63

    • isAuto

    Returns boolean

    +
  • Defined in relay-data-interpreter.ts:126

    • isManual

    Returns boolean

    +
  • Defined in relay-data-interpreter.ts:114

    • isOff

    Returns boolean

    +
  • Defined in relay-data-interpreter.ts:104

    • isOn

    Returns boolean

    +
  • Defined in relay-data-interpreter.ts:92

    • setAuto

    Returns [number, number]

    +
  • Defined in relay-data-interpreter.ts:170

    • setOff

    Returns [number, number]

    +
  • Defined in relay-data-interpreter.ts:153

    • setOn

    Returns [number, number]

    +
  • Defined in relay-data-interpreter.ts:136
    • @@ -294,5 +285,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/RelayDataObject.html b/docs/classes/RelayDataObject.html index dd042a4..69c5993 100644 --- a/docs/classes/RelayDataObject.html +++ b/docs/classes/RelayDataObject.html @@ -28,7 +28,7 @@

    Hierarchy

    • RelayDataObject
    +
  • Defined in relay-data-object.ts:14
    • @@ -76,13 +76,12 @@

    Parameters

  • data: GetStateDataObject

    Just

    -
    -
    • +

    Returns RelayDataObject

    +
  • Defined in relay-data-object.ts:20

    • Properties

    @@ -94,7 +93,7 @@

    active

    +
  • Defined in get-state-data-object.ts:77

    • category

    category: string
    @@ -103,7 +102,7 @@

    category

    +
  • Defined in get-state-data-object.ts:62

    • categoryId

    categoryId: number
    @@ -114,7 +113,7 @@

    categoryId

    +
  • Defined in get-state-data-object.ts:70

    • displayValue

    displayValue: string
    @@ -123,7 +122,7 @@

    displayValue

    +
  • Defined in get-state-data-object.ts:52

    • gain

    gain: number
    @@ -132,7 +131,7 @@

    gain

    +
  • Defined in get-state-data-object.ts:42

    • id

    id: number
    @@ -141,7 +140,7 @@

    id

    +
  • Defined in get-state-data-object.ts:22

    • label

    label: string
    @@ -150,7 +149,7 @@

    label

    +
  • Defined in get-state-data-object.ts:27

    • offset

    offset: number
    @@ -159,7 +158,7 @@

    offset

    +
  • Defined in get-state-data-object.ts:37

    • raw

    raw: number
    @@ -168,7 +167,7 @@

    raw

    +
  • Defined in get-state-data-object.ts:32

    • unit

    unit: string
    @@ -177,7 +176,7 @@

    unit

    +
  • Defined in get-state-data-object.ts:57

    • value

    value: string | number
    @@ -186,7 +185,7 @@

    value

    +
  • Defined in get-state-data-object.ts:47

    • Accessors

    @@ -208,7 +207,7 @@

    bitMaskReturns number

    +
  • Defined in relay-data-object.ts:41

    • Methods

    @@ -225,7 +224,6 @@

    Parameters

    callback: ((field) => any)

    A user-defined callback.

    -
    +
  • Defined in get-state-data-object.ts:154

    • set

      @@ -257,38 +255,32 @@

      Parameters

    • index: number

      Column id/index

      -
      -
      • +
    • name: string

      Column or data portion name

      -
      -
      • +
    • unit: string

      Column or data portion unit (if applicable in any way)

      -
      -
      • +
    • offset: string

      Column value offset

      -
      -
      • +
    • gain: string

      Column value gain

      -
      -
      • +
    • measure: string

      Column value raw measurement

      -
      -
    +

    Returns void

    +
  • Defined in get-state-data-object.ts:106
    • @@ -348,5 +340,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/SetStateService.html b/docs/classes/SetStateService.html index cf04be5..623318b 100644 --- a/docs/classes/SetStateService.html +++ b/docs/classes/SetStateService.html @@ -27,7 +27,7 @@

    Hierarchy

    • SetStateService
    +
  • Defined in set-state.service.ts:14
    • @@ -71,18 +71,16 @@

    Parameters

  • config: IServiceConfig

    Service config.

    -
    -
    • +
  • logger: ILogger

    Service logger.

    -
    -
    • +

    Returns SetStateService

    +
  • Defined in abstract-service.ts:112

    • Properties

    @@ -90,17 +88,17 @@

    Protected_config: IServiceConfig

    +
  • Defined in abstract-service.ts:60

    • _endpoint

    _endpoint: string = '/SetState.pl'

    Specific service endpoint.

    -

    A path relative to the controllerUrl.

    +

    A path relative to the IServiceConfig.controllerUrl.

    +
  • Defined in set-state.service.ts:20

    • _method

    _method: Method = 'get'
    @@ -110,7 +108,7 @@

    _method

    +
  • Defined in set-state.service.ts:26

    • Protected _requestHeaders

    _requestHeaders: {
        [key: string]: string;
    }
    @@ -127,7 +125,7 @@
    [
    +
  • Defined in abstract-service.ts:99

    • Protected log

    log: ILogger
    @@ -136,7 +134,7 @@

    Protected

    +
  • Defined in abstract-service.ts:104

    • Accessors

    @@ -150,7 +148,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164

    • baseUrl

    +
  • Defined in abstract-service.ts:123

    • url

      @@ -178,7 +176,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141

    • Methods

    @@ -195,7 +193,7 @@
    relayNo: duration: number

    Returns Promise<number>

    +
  • Defined in set-state.service.ts:46

    • setTimer

      @@ -209,17 +207,15 @@

      Parameters

    • relayNo: number

      Target relay number (count starting from 1).

      -
      -
      • +
    • duration: number

      Desired timer duration in seconds.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in set-state.service.ts:34
    • @@ -275,5 +271,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/UsrcfgCgiService.html b/docs/classes/UsrcfgCgiService.html index af0fe7d..d782d43 100644 --- a/docs/classes/UsrcfgCgiService.html +++ b/docs/classes/UsrcfgCgiService.html @@ -31,7 +31,7 @@

    Hierarchy

    • UsrcfgCgiService
    +
  • Defined in usrcfg-cgi.service.ts:36
    • @@ -82,29 +82,25 @@

    Parameters

  • config: IServiceConfig

    The service config.

    -
    -
    • +
  • logger: ILogger

    The service logger.

    -
    -
    • +
  • getStateService: GetStateService

    A corresponding GetStateService (must address the same pool controller)

    -
    -
    • +
  • relayDataInterpreter: RelayDataInterpreter

    An instance of RelayDataInterpreter.

    -
    -
    • +

    Returns UsrcfgCgiService

    +
  • Defined in usrcfg-cgi.service.ts:65

    • Properties

    @@ -112,17 +108,17 @@

    Protected_config: IServiceConfig

    +
  • Defined in abstract-service.ts:60

    • _endpoint

    _endpoint: string = '/usrcfg.cgi'

    Specific service endpoint.

    -

    A path relative to the controllerUrl.

    +

    A path relative to the IServiceConfig.controllerUrl.

    +
  • Defined in usrcfg-cgi.service.ts:42

    • _method

    _method: Method = 'post'
    @@ -132,7 +128,7 @@

    _method

    +
  • Defined in usrcfg-cgi.service.ts:48

    • Protected _requestHeaders

    _requestHeaders: {
        [key: string]: string;
    }
    @@ -149,12 +145,12 @@
    [
    +
  • Defined in abstract-service.ts:99

    • Private getStateService

    getStateService: GetStateService
    +
  • Defined in usrcfg-cgi.service.ts:52

    • Protected log

    log: ILogger
    @@ -163,17 +159,17 @@

    Protected

    +
  • Defined in abstract-service.ts:104

    • Private relayDataInterpreter

    relayDataInterpreter: RelayDataInterpreter
    +
  • Defined in usrcfg-cgi.service.ts:54

    • Private stateData

    stateData: GetStateData
    +
  • Defined in usrcfg-cgi.service.ts:50

    • Accessors

    @@ -187,7 +183,7 @@

    Returns AxiosReq

    +
  • Defined in abstract-service.ts:164

    • baseUrl

    +
  • Defined in abstract-service.ts:123

    • url

      @@ -215,7 +211,7 @@

      Throws

      TypeError [ERR_INVALID_URL]: Invalid URL

    +
  • Defined in abstract-service.ts:141

    • Methods

    @@ -232,7 +228,7 @@
    relay: state: number

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:126

    • Private send

      @@ -245,7 +241,7 @@

      Parameters

      bitTupel: [number, number]

    Returns AxiosPromise

    +
  • Defined in usrcfg-cgi.service.ts:175

    • setAuto

    +

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:101

    • setOff

    +

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:92

    • setOn

    +

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:83

    • Private setState

      @@ -316,17 +309,15 @@

      Parameters

    • relay: GetStateDataObject

      Relay data object.

      -
      -
      • +
    • state: number

      The desired state.

      -
      -
    +

    Returns Promise<number>

    +
  • Defined in usrcfg-cgi.service.ts:111
    • @@ -389,5 +380,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/DosageTarget.html b/docs/enums/DosageTarget.html index ef7f012..3bdc2a7 100644 --- a/docs/enums/DosageTarget.html +++ b/docs/enums/DosageTarget.html @@ -16,13 +16,13 @@
  • DosageTarget

    • Enumeration DosageTarget

    -

    This enum can be used with the setDosage method. But -there are also shorthand wrappers for all states (setChlorineDosage, -setPhPlusDosage, setPhMinusDosage) that can be used.

    +

    This enum can be used with the CommandService.setDosage method. But +there are also shorthand wrappers for all states (CommandService.setChlorineDosage, +CommandService.setPhPlusDosage, CommandService.setPhMinusDosage) that can be used.

    +
  • Defined in command.service.ts:15
    • @@ -40,17 +40,17 @@

    Enumeration Members

    CHLORINE

    CHLORINE: 0
    +
  • Defined in command.service.ts:16

    • PH_MINUS

    PH_MINUS: 1
    +
  • Defined in command.service.ts:17

    • PH_PLUS

    PH_PLUS: 2
    +
  • Defined in command.service.ts:18
    • @@ -98,5 +98,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/GetStateCategory.html b/docs/enums/GetStateCategory.html index 67da68f..a4571af 100644 --- a/docs/enums/GetStateCategory.html +++ b/docs/enums/GetStateCategory.html @@ -17,13 +17,13 @@

    Enumeration GetStateCategory

    Enum of valid categories that can be used with -getDataObjectsByCategory.

    +GetStateData.getDataObjectsByCategory.

    Categories are based on the official API documentation.

    See manual (search for GetState.csv): http://www.pooldigital.de/trm/TRM_ProConIP.pdf

    +
  • Defined in get-state-data.ts:21
    • @@ -50,7 +50,7 @@

    ANALOG

    +
  • Defined in get-state-data.ts:31

    • CANISTER

    CANISTER: "canister"
    @@ -58,7 +58,7 @@

    CANISTER

    +
  • Defined in get-state-data.ts:61

    • CANISTER_CONSUMPTION

    CANISTER_CONSUMPTION: "canisterConsumptions"
    @@ -66,7 +66,7 @@

    CANISTER_CONSUMPTION

    +
  • Defined in get-state-data.ts:66

    • DIGITAL_INPUT

    DIGITAL_INPUT: "digitalInput"
    @@ -74,7 +74,7 @@

    DIGITAL_INPUT

    +
  • Defined in get-state-data.ts:51

    • ELECTRODES

    ELECTRODES: "electrodes"
    @@ -82,7 +82,7 @@

    ELECTRODES

    +
  • Defined in get-state-data.ts:36

    • EXTERNAL_RELAYS

    EXTERNAL_RELAYS: "externalRelays"
    @@ -90,7 +90,7 @@

    EXTERNAL_RELAYS

    +
  • Defined in get-state-data.ts:56

    • RELAYS

    RELAYS: "relays"
    @@ -98,7 +98,7 @@

    RELAYS

    +
  • Defined in get-state-data.ts:46

    • TEMPERATURES

    TEMPERATURES: "temperatures"
    @@ -106,7 +106,7 @@

    TEMPERATURES

    +
  • Defined in get-state-data.ts:41

    • TIME

    TIME: "time"
    @@ -115,7 +115,7 @@

    TIME

    +
  • Defined in get-state-data.ts:26
    • @@ -169,5 +169,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/LogLevel.html b/docs/enums/LogLevel.html index 8a2b0f0..3ad881b 100644 --- a/docs/enums/LogLevel.html +++ b/docs/enums/LogLevel.html @@ -16,7 +16,7 @@
  • LogLevel

    • Enumeration LogLevel

    +
  • Defined in logger.ts:11
    • @@ -35,22 +35,22 @@

    Enumeration Members

    DEBUG

    DEBUG: 1
    +
  • Defined in logger.ts:12

    • ERROR

    ERROR: 4
    +
  • Defined in logger.ts:15

    • INFO

    INFO: 2
    +
  • Defined in logger.ts:13

    • WARN

    WARN: 3
    +
  • Defined in logger.ts:14
    • @@ -99,5 +99,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/RelayStateBitMask.html b/docs/enums/RelayStateBitMask.html index 16f6bf7..1995a1f 100644 --- a/docs/enums/RelayStateBitMask.html +++ b/docs/enums/RelayStateBitMask.html @@ -25,7 +25,7 @@

    Enumeration RelayStateBitMask

    +
  • Defined in relay-data-interpreter.ts:19
    • @@ -42,12 +42,12 @@

    Enumeration Members

    manual

    manual: 2
    +
  • Defined in relay-data-interpreter.ts:21

    • on

    on: 1
    +
  • Defined in relay-data-interpreter.ts:20
    • @@ -94,5 +94,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/enums/SetStateValue.html b/docs/enums/SetStateValue.html index e3dce0d..52cb8bf 100644 --- a/docs/enums/SetStateValue.html +++ b/docs/enums/SetStateValue.html @@ -16,13 +16,13 @@
  • SetStateValue

    • Enumeration SetStateValue

    -

    This enum can be used with the setState method. But -there are also shorthand wrappers for all states (setOn, -setOff, setAuto) that can be used.

    +

    This enum can be used with the UsrcfgCgiService.setState method. But +there are also shorthand wrappers for all states (UsrcfgCgiService.setOn, +UsrcfgCgiService.setOff, UsrcfgCgiService.setAuto) that can be used.

    +
  • Defined in usrcfg-cgi.service.ts:21
    • @@ -40,17 +40,17 @@

    Enumeration Members

    AUTO

    AUTO: 2
    +
  • Defined in usrcfg-cgi.service.ts:24

    • OFF

    OFF: 0
    +
  • Defined in usrcfg-cgi.service.ts:22

    • ON

    ON: 1
    +
  • Defined in usrcfg-cgi.service.ts:23
    • @@ -98,5 +98,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 0e9785e..b39d031 100644 --- a/docs/index.html +++ b/docs/index.html @@ -205,5 +205,5 @@

    IServiceConfig
  • GETSTATE
    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IGetStateCategories.html b/docs/interfaces/IGetStateCategories.html index b6549df..ce06415 100644 --- a/docs/interfaces/IGetStateCategories.html +++ b/docs/interfaces/IGetStateCategories.html @@ -20,7 +20,7 @@

    Hierarchy

    • IGetStateCategories
    +
  • Defined in get-state-data.ts:69
    • @@ -44,47 +44,47 @@

    Properties

    analog

    analog: number[]
    +
  • Defined in get-state-data.ts:71

    • canister

    canister: number[]
    +
  • Defined in get-state-data.ts:77

    • canisterConsumptions

    canisterConsumptions: number[]
    +
  • Defined in get-state-data.ts:78

    • digitalInput

    digitalInput: number[]
    +
  • Defined in get-state-data.ts:75

    • electrodes

    electrodes: number[]
    +
  • Defined in get-state-data.ts:72

    • externalRelays

    externalRelays: number[]
    +
  • Defined in get-state-data.ts:76

    • relays

    relays: number[]
    +
  • Defined in get-state-data.ts:74

    • temperatures

    temperatures: number[]
    +
  • Defined in get-state-data.ts:73

    • time

    time: number[]
    +
  • Defined in get-state-data.ts:70
    • @@ -138,5 +138,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IGetStateServiceConfig.html b/docs/interfaces/IGetStateServiceConfig.html index 6c0206a..0a0a1a5 100644 --- a/docs/interfaces/IGetStateServiceConfig.html +++ b/docs/interfaces/IGetStateServiceConfig.html @@ -27,7 +27,7 @@

    Hierarchy

    • IGetStateServiceConfig
    +
  • Defined in get-state.service.ts:16
    • @@ -54,7 +54,7 @@

    basicAuth

    +
  • Defined in abstract-service.ts:39

    • controllerUrl

    controllerUrl: string
    @@ -66,7 +66,7 @@

    controllerUrl

    +
  • Defined in abstract-service.ts:24

    • errorTolerance

    errorTolerance: number
    @@ -74,7 +74,7 @@

    errorTolerance

    +
  • Defined in get-state.service.ts:25

    • Optional password

    password?: string
    @@ -83,7 +83,7 @@

    Optional

    +
  • Defined in abstract-service.ts:34

    • Optional requestHeaders

    requestHeaders?: {
        [key: string]: string;
    }
    @@ -94,7 +94,7 @@

    Type declaration

    [key: string]: string
    +
  • Defined in abstract-service.ts:17

    • timeout

    timeout: number
    @@ -103,7 +103,7 @@

    timeout

    +
  • Defined in abstract-service.ts:44

    • updateInterval

    updateInterval: number
    @@ -111,7 +111,7 @@

    updateInterval

    +
  • Defined in get-state.service.ts:20

    • Optional username

    username?: string
    @@ -120,7 +120,7 @@

    Optional

    +
  • Defined in abstract-service.ts:29
    • @@ -173,5 +173,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ILogger.html b/docs/interfaces/ILogger.html index ac26d42..3132a0e 100644 --- a/docs/interfaces/ILogger.html +++ b/docs/interfaces/ILogger.html @@ -29,7 +29,7 @@

    Implemented by

    +
  • Defined in logger.ts:23
    • @@ -57,12 +57,11 @@

    Parameters

  • message: string

    The debug message.

    -
    -
    • +

    Returns void

    +
  • Defined in logger.ts:29

    • error

      @@ -76,12 +75,11 @@

      Parameters

    • message: string

      The error message.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:50

    • info

      @@ -95,12 +93,11 @@

      Parameters

    • message: string

      The information.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:36

    • warn

      @@ -114,12 +111,11 @@

      Parameters

    • message: string

      The warning.

      -
      -
    +

    Returns void

    +
  • Defined in logger.ts:43
    • @@ -168,5 +164,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IServiceConfig.html b/docs/interfaces/IServiceConfig.html index 3144bfb..8301ab8 100644 --- a/docs/interfaces/IServiceConfig.html +++ b/docs/interfaces/IServiceConfig.html @@ -25,7 +25,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in abstract-service.ts:16
    • @@ -49,7 +49,7 @@

    basicAuth

    +
  • Defined in abstract-service.ts:39

    • controllerUrl

    controllerUrl: string
    @@ -60,7 +60,7 @@

    controllerUrl

    +
  • Defined in abstract-service.ts:24

    • Optional password

    password?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in abstract-service.ts:34

    • Optional requestHeaders

    requestHeaders?: {
        [key: string]: string;
    }
    @@ -78,7 +78,7 @@

    Type declaration

  • [key: string]: string
    • +
  • Defined in abstract-service.ts:17

    • timeout

    timeout: number
    @@ -86,7 +86,7 @@

    timeout

    +
  • Defined in abstract-service.ts:44

    • Optional username

    username?: string
    @@ -94,7 +94,7 @@

    Optional

    +
  • Defined in abstract-service.ts:29
    • @@ -145,5 +145,5 @@

    IServiceConfig
  • GETSTATE

    • -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index d67a5d4..8e564dd 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -88,5 +88,5 @@

    Theme