diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000000..e2ac6616ad --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 0000000000..3483a40c66 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,120 @@ +: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: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #0070C1; + --dark-hl-6: #4FC1FF; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #008000; + --dark-hl-8: #6A9955; + --light-hl-9: #267F99; + --dark-hl-9: #4EC9B0; + --light-hl-10: #800000; + --dark-hl-10: #808080; + --light-hl-11: #800000; + --dark-hl-11: #569CD6; + --light-hl-12: #E50000; + --dark-hl-12: #9CDCFE; + --light-hl-13: #000000FF; + --dark-hl-13: #D4D4D4; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 0000000000..3092fea0ed --- /dev/null +++ b/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ie=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?Ie(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!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",pe="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(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{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 ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.updateIndexHeadingVisibility()}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.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){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)}};var Z=class extends C{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,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/my-theme.css b/assets/my-theme.css new file mode 100644 index 0000000000..25e6682c92 --- /dev/null +++ b/assets/my-theme.css @@ -0,0 +1,159 @@ +@media (prefers-color-scheme: light) { + :root { + --menu-item-active-bg: #dfe0e2; + } +} +@media (prefers-color-scheme: dark) { + :root { + --menu-item-active-bg: #1e2024; + } +} +:root[data-theme='light'] { + --menu-item-active-bg: #dfe0e2; +} +:root[data-theme='dark'] { + --menu-item-active-bg: #1e2024; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background-color: var(--menu-item-active-bg); +} +.container { + padding: 0; +} +.tsd-page-toolbar, +.tsd-generator { + border: 0; +} +.tsd-generator { + padding: 0; + line-height: 40px; + height: 40px; + background: var(--color-background-secondary); +} +.tsd-generator > p { + max-width: 1700px; + margin: auto; +} +.container-main { + margin: 0 auto; + min-height: calc(100vh - 80px); +} +.menu-sticky-wrap { +} +.tsd-navigation.settings .tsd-accordion-details { + padding: 1rem; + background: var(--color-background-secondary); +} +.tsd-navigation.settings { + display: inline-block; + vertical-align: top; + margin: 0; +} +.tsd-navigation.settings h3{ + display: flex; + align-items: center; + font-size: 14px; +} +.tsd-navigation.settings .tsd-index-accordion { + position: relative; +} +.tsd-navigation.settings .tsd-accordion-summary { + display: inline-flex; + vertical-align: top; + align-items: center; + margin-left: 1rem; + height: 40px; +} +.tsd-navigation .tsd-accordion-summary { + display: flex; + align-items: center; +} +.tsd-navigation a { + display: flex; +} +.col-menu, +.col-content { + position: static; + margin: 0; + height: 100%; + box-sizing: border-box; +} +.col-menu { + flex: 0 0 20rem; + border-left: 0; + padding-left: 1rem; + padding-right: 0.1rem; +} +.col-content { + padding-top: 1rem; + padding-left: 1rem; + padding-right: 1rem; + flex: 1; +} +.menu-item-desc { + color: #5d5d5d; + font-size: 12px; + line-height: 1.26; + font-weight: normal; +} + +:root[data-theme='dark'] .menu-item-desc { + color: #989898; +} +@media (prefers-color-scheme: dark) { + .menu-item-desc { + color: #989898; + } +} + +a.tsd-index-link { + align-items: flex-start; +} +pre { + border: 0; +} +.tsd-signature { + background: var(--code-background); + border: 0; +} +code.tsd-tag { + border: 0; +} + +#tsd-search.has-focus .tsd-navigation.settings { + visibility: hidden; +} + +.tsd-page-toolbar .tsd-toolbar-icon { + text-align: center; +} +@media (max-width: 1024px) { + #tsd-search .title { + max-width: calc(100vw - 22rem); + overflow: hidden; + display: inline-block; + text-overflow: ellipsis; + } +} +@media (min-width: 1200px) { + .page-menu, + .site-menu { + max-height: calc(100vh - 60px); + padding: 10px 0 10px 10px; + top: 40px; + } + .container-main.empty-page-menu { + grid-template-columns: minmax(0, 1fr) minmax(0, 3.5fr) minmax(0, 0); + grid-template-areas: 'sidebar content'; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 60px); + top: 40px; + } +} +#tsd-search .title { + padding-left: 10px; +} diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 0000000000..fdbb3ebb4a --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6Wb23LbNhCG34XXTls7iZv6qolkTzR1pVaWnYuMxwOTsISGAlkQVOzp5N07BA8CeAB211e+2f//COK0u5S//hdp/qyji+h3Eb9RnMU6U9FJFO9Emiguo4uvXUScKR6dRDnTu+gi2mdJmfLi5wcRPzS6hyrip53ep9FJ9E3IJLo4+3HS6U2U38D8nXYodPARTEjPYXw4i/k1xGoxv3bt3p1EccqKIrqIdJG8EcUb/qy5kiydeG+fsiydGUWHMwaTuE7ggk/PPkyjrbc0y2ShVRnrzUvOoUxHRONe7nP9ghroUUEjXolnniykRkEd0Su4S0bgtiIiN82w0E5BJJYyxgFbAY2HnczXzSN2Cl83e8syxZ0DnYDGW+W40bXxNNpfSuyFFgeOOXUcEZkrY5Ez3Kt1VTTymuO2RhtPpmUqwQJbCZVZcHXgWKolonFvuDqImKOwtoZG3fBn3IbpBERemae4MR4VRCJia9J35K38JrPvEjUyW0Oj3jElGPL2sDVEKvIMuHvVGXAnClHn5zBYHU6+ibl6YjG/MrYvR6h+yX33saPqZeK//Pbr6fszEL9Kgo/MQzVTj9MZehXtst7CMCYFhXNMOAlkMrG3Z3BUI6DDzt8hYefvSLCF1HDQQmoq5PQchTk9p4Iws2TCqSDMDJlwKugDivOBhFkyxDJYMtoyWDLUMjDhVBBmGSzJW3WJ26hL8jZdMswyqKJpmDJFnNtVNAnTJfBwVichAdu0Fs5rFSRclVvCUVU0CdPkXXBSI6DdSqWMj6SnUsZaZNLXSXAx557Wm1v3wimrXJMga44YyprTRlIXcChOphISqimf4KxGQIKZOgaOMuEkUJPgw1GNgAbDLIk74pJIeJwliHdXx5NQXOJQdTwCdW/BPlZmfzLJthxU39jxgwLH9t1yqTG+VrzXt9S7WSq4vbg8rl00saXPZCISxDAcgW8cn7XOzZghrl3wK1t1ENbEbQ1l2etjlZtle6SKtkoNraxG2ati358PQFzvsgQFMIqBMWJsxuBGM83xXCPzjqqa5WrVogCOKGhPm52h0geaKc40X3MzdhxpTOpDzfkTK1Ntwt1GmxfTl/kQ3f7DjaQvo626RcKlFnazxAttw2mw2zxhmhPGOhQCN69ZsxZlqss1kIy2uPqM3jbymo/tnilX53t4wHX4YXzCtXyM3Z6m37gJp7f6rHMDNh4nPjSmGUvT0UN6yr4nCPtLUWiuFiDrNjbkevmsFYu19Rwf1RYwJeM6PG3Ndamke47BmUc1kNy0qlE8SwOk8GRQ5gQYnSJEuGqS4yXbA9ztaKgz7N3Y0SHnxezh8+pm87C83HxZrf94uF0vgI2AobDfELAw16vZx2siaVzrgcXm1h6vJnwFzFDXL2SGkNHSAgCZLDFGIE3+0TsZwxBbF4SYqC9C7+ork6VzftBZlhYY4qSJB7/lkqv2vX9mxQ4GHMgACLw70HjN/y15ofH+ltCD+afI5Ca70UrILczfVniMCxOwyeAPbisGxnYxf+h/pxz7ed1h7OvkxG/1zFE/55qJNPCptXW1Fb7618RdCZ4mGONaEPRdM5lke/fiDnofRUD/NS/yTBaBL/sjjFYY5GwUk8VTpvYIRKeBu2+qW4CCMEIfpymyzLQFC4mWYYu8hd+LZHsRz5lm7lSH/F2dD9HPRgZbIYCa0GOQ/T2CJI7tGBdoIrADs0VQ8+qOmlWHDInSqX24hczL4XkVoNiioDluKR8lPuM6d0dOtC3ymS/L/SNXuMe2ND7rNuFAPrkr8wG6XiTu8V2ZD1B/uEE+vy0KmJeqEAfsFu7p/Iii6mEpxV6q4wyBcHRhRD1mAuMo9EHMlybka7I0PuvmyxLS3FF57Xmlw7pbIm+bLK2XcFVUensQrbEjCDad0rTe6Bh7SxHyb+7Z7oEghL4Gy/jU/0cIOOrT2H9ETLQ06nM9U/v+xE/jxnTBFkT7bFcq2y/m19C3OKaDtjtmTPNt4HeHHaenCTHqO6vJ7+5YWsKW3YgMSuplAmHGWBYw4V4fcHDzOh7jbcaKBRhRiLLSO64Qr8eOD3l3uS5ymsd0YBZ4JN5MfMofvs19affAPc7kgSt909T39dka6gm0pFGxp+/Am26xTG4ypd2KyU8aKj0YUSz2bBvsmbXeTbjX8O+S2+dRyNCEew1vVQq3u1Wpx+zAUlF9+bpUKgNPnSMCmNdzS0JY0pHW0f2P+/8B57EhXoo6AAA=" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 0000000000..7f6034363e --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA819XZPbtrLtfxm/TmYTAD/9dL2d5MR1kvhee5Lz4EpN0RLtYaKRZlPUbPuk8t9vESAkoNlNASC0J0+WbaK52I3+WgDIP6+63b/3Vy8//Hn1R7tdX73k11fb+qG5enn1f9rVN11Tr/pd94/Vrmuurq8O3ebq5dXDbn3YNPt/3LWru/GCu+GCm/v+YXN1fbXa1Pt9s796eXX11/W8XPnnrGD5Z4DkfX8OsrxiVjLj5VH2q2HMT/W2/tx0R7HjKESseTlyj+urx7prtj0K+gQgY6eHW+22+747DNeF3P+FPd4RiyXH1EzC0yOyb7/7/tUvP97evXp9+/bd3fvbV7ffBSHE5ZyQ9vv1N+3+m8eufar7ZjnuOliX9USLF8H23prD3gD18Ji2rj83236BG7wAAmJiW9Xbdt833Zt1mIOYw2Piateb7+WYr0G4rOGXm3GH7f7wcb/q2o/Nq8FGQVgRIQs1mWeZyI8g7+76r49hLgGh3RxlhSC8mTwpodandt/23x+2q77dbYOAQwkLFcqTtDRcZrP5qenvd6EuYwyPiav50nf1qn/fdE/tKszeExEx8X1u+lfB2cMYHBNTu237tt60/xumL2v4ZXCFq2wqI2ogtPAeHtd136hp/b5XIgPCDSIlplaV/KX4pshipBWzbPasF4zLn6VshvcPLZvNxz5XNv9y+4N71TwBiIoJtKcD6tq1NpgArScFQXRsh/7euWae4jNGx7Rzu/9xt6o3322fgmBZw2PiOtYv3T4ImD0+qlWtSDfYpdn27cox1KGGNQQs1OGkDgh2CGNwTExGrgyGNpVxOftud3376ev7hbMRk3I5zP6tEu0+keZAaKN0BtiN/ddvWEDfZN5iVjpZ7AT0ppPnWtKbOkwJVVAtgGeNj4/MuVQkkC0sFYmEZJSKr+vtul2714rW9c9RLE4BBFaL9pMvLLwQVMsqLyd063b9+96JeEPwnQbHRWh5wbpd3+5+d0kuOMJx8FKbwvLh+2738FPT1+u6r8OwTYVcAuPtw+MP9eqPRRBPMhYjzE6pzuxC3z4OJNnJyO22b7pP9epsUzwODA8j51nyICwx+HKtFHfaPAzqYgL9DFCERw8DSjDq8YAeq+e329ddY+bdQMCYwAsA/3fb33/bPPW73WahD70Aoi4E9teBG98t9TFbUhyo0wiFEIoOcE+jwmPTbGvgj+HF3V27XTdfQldQDHGjJLKqMJPiYqA3numRQqufmwDddJ3fjDyDWsu7MOzNrl63288RgZ8kxoduudeQIl9J9s7duawxsdL+ob9/vWnNOt0XxAtLhlcXeNLADDzNg7nmegKhKeZiIN1n4zxKzznoBNPHyRF03j7tBKpdD0/cu5ZHCC5DQmRoxwpmwcyzhVwI4KJZB6QshjgJc0F9znRgpICHLG0EIVm+yHGmVnzcdT4xGYM4irgAuICqmwIZWnXPgjUnoeo+3qlleK9ZiI18tnabBBPab6N6idRw02CJjnvkztrtfdO1KklHgu7bgtPQ53e1XQJ6YFM+8wjzXfkFH8Uz7M48Qkjc9YHqHnhpkJ6R1weef+ilYZKx93ITwZsCmUePcSBRwZuZ5NvmU33YqJ1wt86EBBwVnkFMLL+c1t68ctp0XMyMtggDsugzbzpEB+aKQFWwjJOM1klfQ5/uwhgs0BQKxu79Z1Fckk1zvPGLMOrMoyX1AxJGMmmOZo5Wwho/T2yBbZ83QrPzC4UYwHe5YHxAyGNPiA/hW1EJhIQfmvvvzmDcoQewQsPAqYl2gmBdHg/G63qzMYLdWRzg+v9wXMLu7h+c4DPPaWfS+9DQ9KXxjPOdOhRgYH3VfT6fvPBhl4T1rukP3fbWxYRzg6NDHEtEH2DGkOhwmjU8InIGzHFAPCj6aM7Pw1/PwTAvjg/BySzmxeEQxOnub17f/fD2/e3dz9/d/s/bd/9998u7N0cQT3XX1h/xo7fIuCh4fnz7+tWPYZDwoQtissH6yNYIPUb8abQIhmg6LCYajDhzQBPllMYEzdg22un7PBpzWEQ0Ut7/tP296obqzYQnOA+NlBEF5+dm23R6cvxQ7++dkE1GRcXiDSM6gnfNvw7NvvcGYoyLguf3/W57u3vfd2ZbMQfEHBAFwV6Kut05q8IcsCA5oe9jeAI0FfZGhvEa53cyyMri26av2838vk4t2Bzg/oAa+rI9wyQGctOwK/WGSSbXHnaHgUwKRqpHO2vNCZU64tx+adZvzuxxprFBGYsReh+ocMTms20KFWk/6VmV/lwvV6mS8fdU6c+1Vuk3PIZSh2edVepmt1Cjo4C/nzoHYFqX6VJdyqecU+RCX/+buvnJw7/JF6rwnHsv9Oy/qVMb/lwuVOA5V27W75rVodu3T4sQ22J8z7CcUa91GGO49r+GgrVd3S5Tsy3l0pj7f+52myUqHscvnqxTZAMdsihoqvEXQPbzYbNIZ+P4iyB7+BhcRNoSLoDu7eOisKiGXwDX/+3a7ap9rBcZ1RRyAYzvmkXOoIZfBteumz9eeB6aknABdC7vKToDz+c9Rd74bpsvi1xiHH8JZIfHzSK9aQGXwLawkJnk1mjIfh0o7GXV80nEJfAtiyK/xokiE6ro+7bZrD2YInX9sxJFBoS4PNGoi3g1m4l0QcnmgMufKJpgC+eJXPF59WY4vqD+zAWfH4ExBRfGX7gg86rFp8CCSnEHXMsm26Xm2bIpdqnZ5de1TGEFNS1OuPx6FgRZWMvigM2rY5kAC2pYHFAF9CsTbAvaFQeEXt3KBFtQs+KGyqtXwYAFtSoO2Lw7lQm44EbFAZ1fnzKBFtamuODy61KmwMKaFBdkXj3KFFhQi+KAy7tDmUALblBc0C2KG0HtyQTVpDt5V2/XuwdrP+JZbKcxz9qlABhxOxVDLwSXv6+fJAUfDtiQsIgKR7Fa8+/j177Z3+5+aL6Eo7VkXBiv3h7zz/bzm23fnHs12yxuVNZ/CL9v+UdhR6rAi+JWV/7zq3nGJhi8LezCTxDAIUDcC3gER3z+XAKKMZxP8MHp1fDROIM6P1ecftwCDjKMX3BF6MUx4ACDeAYU37LFcxLdzfGX3wtbKemI4HiECfoUl3Sm5X50SRfyI1BweEEkiiM+L7IChRdEWDiiCyAtUIwLiAtHpIsK1nACwx2dF4lBAQwiMhwx+tEFKMIwysAVnx9tgAMMow4cEXq36SjG4FbdFeViTwlq2fHGE2/b3zX7x912721tPe5v0L5bUC7Rwh91FLmNt4HHbeURzJHaeRt17Jb+HO7lbb2N/1KtvetzhLX3+DPEbPFd8S9o8/GHiN7qn3uS4Hbfxr+45XfCGdr2I1iXtv7ueAPaFgrvgv7FDW8IDYCBXUIFuCENoAMwoAsoASeccSbrpedpnCl66dkZ0mFjMBd02U44AzptBOaCbtsJZXDHjWBd3HU7IV5cYy7tvl1RBnTgONAFXbgT1pBOHEG6pBt3wxnSkWNAl3TlbkgDiGAM6ALm1wlnIIOAQF3IIrihjeL5C9gErAeGjMJtV2/3n3bdgzvU45Bn5RFsFHEphJNS4vUfAO+C1sMNnX/XgSEMbzg8UHoVciTKoELOEaVfh4FCDGsuHPF59RUovKCWwg3d4kl4wfm3eOpdcNb50kwovMB9xG4IvXoGDF5Qu+CGLaBTwBAuaBLccHr1BxjCoNbAGZtXV0DAC2oI3BD69QIYvrA2wBGdXweAwgsr/h3xedX9KLygkt8NnXe1jwEMLvQdMS713qDyHsNGV/a3wwsIA1DKcX+PGv8E5UKFvtLRBap9A3mMkv88zgV1P8Qaofh3xBtWhqF4lxVkDngDe4EJ2IUNgQPSsK5gAnRZa3AeZ5zJeul5GmeKXnp2BvcME6BLG4fzWMO6Bwh0WQtxHuWSPgJijdFMnEcc1lFArMvaCieUYb0FAnRZg3Eea2CXAZEubDUccAb2GxOgC5sOB6RhnccE6LL24zzO8B4EQl3eiDigjeL5y1qSCcrpZ5jk8cQjUOKDQ1q6OWZJM2J/61kJ/bXeHM5+C4oE8gJIcdeYpQcHiGe/EOWG0e0rjT4gN/XHZhMOTg+PC+qh/vJjs/3c34cDM0WEt5hOYNvtYrCGiMuCdfmWO43T+2CQC6SnetOuHb6vSMMyJCyGNnvCKhhZyKEqS9rxEYmw/HVbP7Srb+u+tk6EnwNsD4sWnP2CCgIiJK4AFdCzzSNhYNCe/JMFCc20IfzkDHxT/RmsxPBoNnX/DK0LIupbtOdUSSmJTMH7VdfKr2lEQW3Luxhs9fG1iBPgBZQYE/rcJAbv0PN8hOVv1Is8ha3368WZwdM3fUxnQjQtvgDyIsI2Z4H8T8/pa46JZvG7u4AIMEHyAopxV5ulCRKkV77E4PmnSzdgPtUPhsu76CFgUZNr+FjS6/vWvRdFB0ecbqv7ZvVHEwHOC1NWmP5OyrmUd0wgx3ATB9j37XrdxEF8FHUxsMHOPcG6zMsdoIa6+wTpIr8/C3Q3fh4tAlRD1IXAPjUrh++tO0A9CooH1Ayrb7aPh8nXsc6gNcc8XxCdoAiMnZYGYoZMDCAVKX1JHzfQXjEIgzsNPZcB6hOBMJyTwBMJ5sRTvBjw04hn5b8BjHD229BATO57Dh96LNnPqvF4cAg0knfE5cQhyDiMuANQXz58AjQKG34eaNf869B2nnnGwGmMj+k63iFwjqCPrzVfuh5CRMn6KDCXUPcUyhDi3pB1hrb/KYDdMcdcJJuEI1mwVGlpggD5aZmeXhzHR4aFfdDdH5wt5TIQbz08gobovWXDBaJvWJnCC1oFJKAtCSU0spBgYkk7E07Ujj+vytQY8qylKcQRXpuaSogZ7WYRLqtOHSB7lacTqMvrUweID/WXYIBqbFQje9fLGKgIdagL1NaZSpiCbP3ISzc4SzUXpYJ3gOpbwk+QBtXwDsB8EsYElHeScADkm18noKLU7TjQJdmWxBmSbE1hZ3Lt25E49ive7VHPmnERKOFJF2gjZt49h3NZ6nUD/smnpMIAawGxNepVFmDAllcGbkC9szEGNk5CdgTsmwRRwFHyoBtgn6CJYfUOlm6wfPMOBi1K6iHhLsk+c2hDEhCQdyYHHQ8jebV89qhnzUEIlPAcBLQRMwedw7ksB7kB9wr1GODlod4NqHeox8DioT4SQN/QjgJEQ3scgL5dDYYvqLFxg+cTIDFo3lHRDZZvpsGgRck0JNwlmWYObUimAfLOZBp1QtOv1zHHPGuWmQChc4yvqS29xMw485j9FjFcQPqtrUzRBaytuMDySnpTVMtTngtI74Q3BRqns3EC65v8ELBRuhoXsD4BcorTOya6QPLNMlNYUXIMAXVJhqGRhuQXS9r57HLo9u2T52kRMOy5c8wES9Q0YykocqaZR76suXGE3qjjJYtAn2R4TVMC3kJXIuEFOpMlTz9ppKw5xRolcbrYPSR3TuFGS59OkAMyKAI5VhJ1gbz12JqCot367kpxBLbYqZa6UsQ0PwUXK9P/pyIUyPff8EVB6mzS3x82/auuq78OB6PdgVvDnufIOgYi4Mg6VEGMI+soNP8j6zS0qQ1VqedvxNO457QiQBFsRkML8ewIwYUaEgVnWlK+L8qv/DaGPGvpDXHEK7tNpcQsuWcR+5EoDhD9qJ0JtgBmxwGUl6NOMC0vTx0gepemE5hxylIXqL4l6RRqlHLUAapPkTJB6V3tOQDyrfQmoKJUeTjQJRUeiTOkATWFnanrxrfk+eUSa9CzZpMpkvAVaVsVMTPIGZR+4doJpl8WQfAF5BEnYF6ZBMG1PJc4wfTOJgjUOPnEDa5vRsHgRskpTnDVMf4l0/MkIfL89InZCC7vUO0EyjfpIcCipD0K7JLEN4M1JPXZ4s4lP/mOBs/cZ4x53tQHgSzIfKYeoia+WYzLlipcQHvtBJ6C9d8H7ALKLwVOQEXIgA4g/RPgBGik/OcC1jv9TcHGyX4OYL2C4wSnf0B0gOSdXyaw4qQXHOqi7EIiDUoupjQstyRVwbLTN3hebdR+reEI7ilmDrfF0VrXL0kuCBB1WMYDiTEgJpTx7arH53QAA4dcEs4/v74epAagGkfGBCff4qjeT7DrHkCdQiPDhsWEdXzk77vdw5tvf3Q0IzYsKqzxwPvrum8+77qvLpDAkJhwfhrf4YqVTTQiZNQSULOx0x9FyLviMD2c15r9YrPzSBe/1Gyhppa9R9N+aq+XmQVAuwl/86Mtc3xSx/eYhSH1X+DzwbhyjxU0SEPIZVCi7ywJQbrwtSV+aB3Twnm0gW8wcUO769bG97tCYGoJ0fDhMVEtDTsjVZc/W0Q0bh8eEMdHJhkJ/2g4hXWzLBSOAufnmF8cRDCGBkEndAvterPIuGew2ZswAsD5b8HwRedepVDwQl5yReGbix2/BihTjolZFr/t75vOvb4zL48J4/h5BL/yHBt2EViu+on3+RACinPXGe0jELlRnu22T03Xv++7dvv5dgc+tqnrAxwPOjYSrnFH96vt+v2u661v+MyDmg6MhKjdv3moPzeOMMaro937/x0ao4Y+d295dbR7/9JtnO/8S7eJdF/N/n3XdTvXGWmNuVhl5ovhhf1PAcWaLcDWzKzylE+GqNAY+cyKhEheYP+xQKmmGExvf/12fdVu182Xq5d/Xj013X6oY19e8RtxU11d640gLz/oUwWr3cPDcNffxv9TnPZwhbrkH8nV9YfkWvCbjJXX7DpNbkSW//bb9Qc9VF4h/0Fez8zrOXY9s67n5vUCu55b14ur6w/pdZbfFEVmXSasy9Kr6w/ZtShveFpYl6XWZdnV9Ycck5ZZl+VX1x8K7LLcuqy4uv5QXmfsJgc3LazLyqvrD9V1mt0U4LLSuqy6uv7AkuuU3yRAI5Wt8cEAjF2n5Q235TFgmkHzjGMAmW0UNuiciWue33CW2lfa5mCD2hlqEGZbhA2aZxl6pW0UNiifoWZhtl3YoH+GWobZpmGDCViJXmlbhw1WYBV6pW0gNtiBJ+iVton4YAjOMM1z20acUZODA7/h1AzntoX4YAbOMZTcthAfzMAFMpG4bSA+WIGjRue2gfhgBZ5hIm378MEIHLU5t+3DByNw1Obctg+X9kFtzm37CGkf1ObCto8YrCBQmwvbQGIwg2DolSCkCdLbhG0hkZIeLGwTicEOArW6sE0kcnJuCttGYjCEEKhM20aipCansE0kKmrKCdtC6WAGgU651LZQKi2ExpnUtlAqLYTOudS2UDqYQaBzLgV5ZzCDQOdcalsozShPT20DpTmZCFLbQGlBZYLUtk86WEFUmM1T20DpYIY0wUTaBsoGK6ToNMpsA2WDFVJ0ama2gTI6DWW2gTJZFqBTM7MNlA1WSFPkgTJQGgxWSNF5lNkGygYrpHgZYRsoG8yQovMosy2UDWZI0XmU2RbKpIXQ2JXZJsoT6tFz20L5YIYMDXK5baFcZiHU6rltoXwwQ4aGrty2UC5rN9SWuW2iPKOySw7qt8EMWYre3LZQXlDzPbcNlMsQh06P3DZQXlGOntv2KRLS0QvbQAWjHL2w7VNw0tEL2z6FoHRZ2OYpUlKXhW2eIqN0WdjmKXIydhSgwh6MkKGuVtj2KaR9UFcrbPsUZA4qbPuUgxEy1CdL2z6ldCDUJ0vbQCUd4krbQKWgvLe0DVSmpE+WtoHKjPTJ0rZQOZghRyNCaVuoJJugEnRBgxVytD4qbQOVgxlyNGGUtoWqhNRmZVuoYnR3ZVuoGsyQo+Gosi1UDXbI0Rqlsk1UDXbI0eBR2SaqZIeKTvjKNlElTVQg86OyLVQNdshL7ELbQpW0EDqLK9CqDmYo0OlRwWZ1sEOBml39n3ntYIkCNbz6P/PawRYFaib1f+a1gzUKvGlNQNeaDPYo8LY1AX1rMlikwBvXBHSuieQU8NY1Ab1rMtilwJvXBHSvyWCZAm9fE9C/JpVJvpQJytYkwICSVChxA04IB0b1AQwyDpJXKHFbQ85BMgulwJyXQdZB0Q44lQF5B8kulCkuF9hPUQ+EXGA/yTCUGS4X2E/RD4RcYD/JMpQ5LheYjdOhkQEOgkmqoSxQuRwyRXNUEbCb5BtKfB4DLoJJyqHE5zGgI5gkHSo0mDNASDDJO1QMvxbYTTIPFcdKNwZYCSa5h0rg1wK7SfahwucZYCaY5B8qfO4AboJJBqLC5wNgJ5jkICrcxgJyfINtKjSpM8BQMMlDVBUuF9hNMhEswQ0HaAomVBvMrlNxUwgBLgaWk3wESzguGZhOchIsweMJICyYULQswXgC40lqAo9/gLVgkpsg5jDgLZhkJ4j4B5gLJvkJIqalkKFN6TgF2Aum6AvcjwCBwSRNQcQpQGEwyVQQsQewGExyFYR/Ah6DSbqC8E9AZTBJWBD+CcgMJikLwj8BncEkaUH4JyA0mKQtCP8ElAaTzAXhnxnk1jPaPwGvwbJ8xj8BtcGyYsY/AbvBsnLGPwHBwbJqxj8Bx8Fy1UTjBRvgOVhO1yeA6GCSzmBJjioZcB1MMhosKfCLgfUkqcES3HyA8WC5CploR89yuDoi7ccS/GJgP8lvEAEIcB9MMhxEAALsB5MkBxGAAAHCJM1BBCBAgTDJdBABCLAgrJgpUgAPwiTdQQQrQIUwSXgQwQqQIUxyHkSwAnwIk6wHEYAKuLBV0AEIcCJMMh9EAAKsCJPkBxGAADHCJP1BBBVAjbCSzQQVwI4wRY8QcQIQJKwUM3ECkCRMUiGM4X0M4EmYIkrQOAGIElbmM3ECcCWsLGbiBOBLWFnOxAlAmbCymokTgDVhijYh4gQgTlg1U6gA6oRVM4UKIE9YNVOoAPqEVTOFCiBQWDVTqAAKhVUzhQpgUVg1U6gAIoVVM4UKoFJYNdMcADKFJ3RzwAGZwhO6OeCATOEJ3RxwQKZwSZjgvs8BmcKTlPZ9DtgUnmR0QcEBncKTnA4UHPApPCnoQMEBocIlacIYvoAOGBUuyRJ8VR7wKFxyJbgfccCjcEmW4H7EAZHCFZGCzh8OiBSuiBR8/gAihUuyBPcjDogUrogUfK4BIoVLsgT3Iw6IFC7JEryI54BI4ZIswf2IAyKFS7KE8CO4lUOSJYQfwc0cajcH/myT/Ryc9iO4pYOLGT+Cuzp4OuNHcGcHz2b8CG7u4PmMH8ENHlwtTqMMLYd7PDi5gYDDTR6KTCFUAWwnCRPCjwCZwiVhQvgRIFO4JEwIPwJkCldkCu5HgEzhkjAh/AiQKVzyJYQfAS6FS7qE8CNApXDJlhB+BJgULskSwo8AkcIlV0L4EeBRuCRLCD8CRApXRAruR4BI4Smf8SPApPBUzPgRoFJ4ms74EeBSeJrN+BEgU7jaDoJvueOATeHjjpDsWhQ3POXgYmC9VGW6/FrkN4JX4GJgPsmZMFZci/QmSaBkYL9MFZglCgMwKjxTi9sVfjGwoNoiwhMUM+BUuORNGGf4xcCCGb1wwAGpwiVxwohNdoBV4YpVITQHWBWuWBWOuypgVbhiVaiNecCAGb2/lANShStShWfoBkZAqvBcbTNFOyAOaBWuaBViOx+gVfhIq6CQAavCFavC0W6JA1aFK1YF3wDIAavCFasiEtQkgFXhkjlhguEXA/vl9NoPB7QKl9QJw3f4ccCrcLWzZNi6hygDECtcbS4hng8wK3xkVvApB6gVXogZZQBuhRcz/ge4FS75E4Zv+uOAXOGFsh+x1xRuS1X2w+cnoFd4Uc6pGRiwqObUDAxYJjOaAwwLVwwLrjlAsPBx/wm+SRYQLFwRLEQ2AQQLHwkWPJsAgoVLFoWKiYBi4YpiIbIJoFi4oliIbAIoFq4oFlFh+5UBw8IVw0JkHsCwcMWwEJkHMCy8mrEfYFh4xWfCHKBYeCVmTAI4Fi55FJbi8xOQLFxtU8E2n3DAsXC1TwXbfsIBxcKrYk5rwHbVTPAEHAuXPApLUfKPA5JFJAk96wVgWUTCaBULQLMISaUQs14AnkUk6qQFvqUbEC1CES24iwhAtAhFtOC7ZwUgWoQiWnB/EoBoEYpoQf1JAJ5FKJ4F9ycBeBaRVPTMEIBpEYze+iAA0yLUGZkUP2EEqBahjskQMwNwLYLNOJ8AZItQu1ZStOASgG0RbCZ4CkC3CDYTPAXgWwSbCZ4CEC6CzRkQMC6CzRkQUC5iZu+KAJSL4MqAaHYXgHMRfM6AgHQRfM6AgHQRinQhbAJIF6FIF8ImgHQRfM4BAeki+IwDAs5F8Dn7AdZF8Dn7wdM1YsZ+8HyNUPZDCy4Bj9iIOftNTtnM2Q8etBEz2U/AszZizgHhcRsx54DwxI2Yc0B46EbMGRAevBFzBgT8i0hnDAj4F5EqA6IVpQAEjEjnDAgIGJHOGRAQMEIRMPi5CAEIGKEIGOL5gP3SmfZdAP5FjPwLbmzAv4iRf8GNDfgXofgX/JCGAPyLUPwLMTMA/yIU/0LMDMC/iJkjOgLQL0LRLxl+JA7QLyKbC6CAfxEj/4KyJALwL0LxLxlxNg4YUPEvFAxgwJF/IWAAAyr+BT/nIgABI/K5GhQQMCKfq0EBASMUAUMEOkDACEXAENoADIzI52pQwMAIxcAQcx8wMEIxMMR0BgyMyGeaCAEYGDHDwAjAwAjFwGR4qQgYGFHMGRAwMKKYMyBgYEQxZ0DAwIhizoCAgRHFnAEBBSOKOQMCCkYoCgY/PSUABSMUBUNYG1AwQlEwhLUBBSNGCga1NmBghGJg8KNHAjAwQjEwhLUBBSMUBUNYG1AwQlEwRGMAKBhRzsVQQMGIcq4IBRSMKOeKUEDBiHLOgICCEeWcAQEHI8oZAwIKRigKBj8RJgAFIxQFg5/1EoCDEYqDwY97CcDBCMXB4EepBOBghOJg8ENSAnAwolKvTcDzGmBhhKRaGH6sSQAeRigeBj/ZJAAPI2Z4GAF4GKF4GHypQAAeJk3oIjQFNEyazHDYKaBhUkXD4ORqCmiYVNEw+NmtFNAwqWRaUFosBSRMKnkWlBZLAQWTKgoGPxSWAgomVRRMjp9dBxxMmtC2SwEFk44UDBqJUkDBpOM7StBIlAIOJh3fU4LGixRwMKniYPCaKwUcTKo4mBw/ng84mFRxMPj5txRwMKniYPAjcCngYNLxtSWoW6eAg0kVB4OfgksBB5MqDgY/BpcCDiZVHAx+Di4FHEyqOBj8IFwKSJhUkTD4SbgUkDCpImHwo3ApIGFSRcLgZ+FSQMKkioTBD8OlgIRJOd0DpoCDSRUHU+LWBhxMOnIwuGBlP/nSpuH1dM36jXp504cPV3d3q/tm9cfwoYQ/r+7GlzoNq0tS7vB+p2Hp7uWff11fDYtLL//866/T+5yGvw13Au92NgUlhqA814KY/lGpH0O0pETft+t1A6SmJjxODh1fYWqOZCaeQsMQ448y0XhooeqtWqbMk0jG1XgxCszGv5fjn9UofzgUOP7I9Y9y/MH1NXwcxIrxx7AjQP3IS41c/0upVVodf4zXDOyz+qElD3SY+pEef2TjD41Y6FsIbaOh1lE/tOQhIY4/9L/wTP8oCAXKN46Z+itO6svnxjzU2/pzYw01poFwGHr8gNdJgihPItJ0VoZ8Qem+lx8cMSDwk4CMmsRQgAUhMyCo+UdJmNw8q4yhszff97vOGmrcdPSCkrTY5+FvxlhuRodUTwr1p5otlJT60N9PVZgbKiSnwGk4eJLccOmSilByODKDTAWOfjP6j/aIfPaB6JmVGUrKyZm12cgX4vXqEylGUMkMtxAVOS02m618Lx8ioDQFkJPj0N+vNi0wcGrcPCOnxaG/b7Z9uwLm5MZgTtrDGGylntSAnTmMbrefreGGQTPSctg04mZOyYiRH7/2zb7f3TdfLF0nxiMPJ69U2CYdalVvNkZIsCazEU5KCv8wfjqUZQYIasKt6u26XSOOYGZ8QQPftvu+6Vr7xkaO1/l8zGq6dDgmpazSGYwK2KcPGxh3yI1nG/ofYuhuu++7A0ww5tjx7jrJ6ZzLRnxMJ8ThZN5oxTEODFvrx8HUtBzf/ruXb//td9vxzcHGcxTGJBuKX0rOYfjClBWujXnBGFWcrLqm7hsqWxZGoGQJFVJGGUS8LEwcZNGmZIxvF8Vio2GSnNSmKWTiroVZdZHVmpIhB/+77e8VlHqzbp763W5jYTJNw8gptq772oo3BoyMHKTe3H2nXuY6yX9m+jsn4dDfTwVwwyj8DAiJAZawmQGhoJx/FDB+n9CY1MyMnCmVwMfhT+p98ObwzByuS/JyjKJC15jiWFsfvVfoH+mxaNUX68AjyLLIxGNnTpabgHRZUOrYUR2RMY1M/wvXP3T9PywYjsj0xbr3ESU1aaleipuKyo+lNxVF1u36970dqc2+KaUCwLpd97vf7SrZDKGkQtW3yQYPqeXLyU3o5gzNyFmuJBwrIju7VWY9Q+oOiPj4daU+rWYmk8SURPlLo94Qbbi6oTzdiGkrlKQU9e516/5mjSLIpmMcadQJUKu5EXtIhUzFdE1/6LZQv7nxdLRORmHb9X7X9RMrF+Y04dT8GoU06716eb+FwnC9ipomUMBaf7jAnHBWNUelGChJf4DcFGRWs/kZLSNPZAYTduaJxtdwT0xjqLWanS7t8P29T7vuAXkQs00SpJhpdE+NuwtNWwhywksBqEUqU5GUJszhQ8Ze3bcAjzBDCdmcIQpITSqq0g8i9I9c5xCSTzoGlU/d7qFdbyYhyizeBTl99Sve8ULXLMMrKpdqEfJKc6YYk7XSZFulKZmENPoobjLxjF6s0olZyx0WDHBxn5tt0+k69L7e31tlltmlkIi0iI/t5+Fjq6AIHY6nG/2WptLI5l9Lm2AxffPs4yDlfFKZODKNg5qUWlJXb9e7B9lL2oVHYorTxCDZ/B/FNf86NPt+8nRmU5pQU+lz008YOWa1szMDJ8RQaboYPXBwoIemr2E1LXIzgcyP7x8e7+vVH9ZwA3dKBah2ZQ4xNK47v3Gej38jy6t2dXe/2/d326b/96774+7QtZbvGFOjoiZmux5YjN4KAZkBKadqrXa9+STNZkcPq8Eb3XT024IUtW37tt60/2vHMtPDqI7gNHQ6hUzPIB//NH4yk8waiXKA03grRWSGGnRUL6lIc5Kx26pu0ZpRBgzdCZD54SgKcFKZkRY0OVRS0UamcCx/mpObk02aqgAmSdykuTnZeLT7Vn3PxwwFlkuSk2i/2a3qTbN9soxoNSxjxTxGyYL0z/2/1Id9TBCmY3Ma/vANFWucye6TnfHv+9223ynWxgqgpg8klMana0xm+BwOqY7Ml87HmlASia44mP6XI5ku9L9oIk3ojkNkhS5YdGupV6+EblFTRnnMZlevIWNqGInszKR1Z+NdYZKAVMx8qG3e1Fw8ESTn8lB/2TTbz/29rWVzSmd6ibLU+kq0vvQCm9BLU8P251G5R1Xqi4tjfUtpQvVQNHlg9lGioiaNloKUySb5cCQNaI1KQVjfYqonP3IXlO/o1lB97tN8HtP1SCcwh08ZHjMXpiQ1TSywmd16SRUjD61NlZi0nCAru4d2i00ss1HJdDlQ6rmS6NnD9L/o0CaE/hedKoSOdsPexHFiUY8Aa3lmFgIipSbAdte3n77uDx8Hzuhj09m8jSmCit2qrkUaP3OpnJyAmlK1040Z+AtK/Xoo1quZXsQo5AizzExqedjkSYxUn88156iZ58hqeTd8GRJzWzP8pWSf/7jrLO/KjMfU9X5B+cdj125X7eOoL1tdBnhBJmn9ta8VoNINO1N5Qw+Vf1op3kiRZ8ZOKHxzFfnMWP0VNXNFxGyWyCq9a1a7DouP5hKnIH2ja1aHbt8+YcyQuVIpSFZ0aM7aDm6vMUNMqYNFcgwoVJhVAbbuuvorbJ2YWfUKcilCSVBamYow0zG5Er+vn5p111ht1PAqOqNl1M0TGeyOzB2VRs21qpTsQWcIQHOhKiU7GJr3M9eXUrKD0Ut9k97bbH8ScrSO2pP2x9ymJCjnIIK+VUFQD94fHjfYY5u7FgS5gD5hvrjJrektRPy4YSg5bkXSP7j+oZdghS7hhA6EotD+oHNvSmaCw5bWJbOWTnWGpgQ9rvXqp2UPyzPOj8XWPI2AQ26kUyKISshUMrl2rCRMx5rJ/KhpQob+5KOtRVNCpjfM6Q1tvDrWR9roTP/g+ofeIyR0VSX0DjxR6GlAknga1GRdhpnOlnLKsnq8KnemUsx8kvIZ1YDi1toMdWzOsuN+Or0zjly0x5oIs29lVCx/qru23vaYF5vlE8mRPzUT1kZYsYNUghyI3desQ8i9bEMyl9xlu4KBpDTjJm3KoRr4uNtZRWdleofu9Viqt3HomcaOW1E0Q8ZJplLeB0kupcmzkb22HC0zpSohLAkmtUASE1ICoubE3KogZtF/ar8069YOZqW5dUKvXTO9hs70xk9W6TiuoyYnmbjTvba1fS8TKjtaRd80r/S9dEDRq/ycrMnUvTY7cCNzXUG3ZizVawN6PwDTCz9cPzgn86u60WFrVTqVaXvd+TG9WZDp1X2mV124XjLjYt7M4xqMXWKadp4bDS1sVmM6DjPNJTFNGLHjGpG2DCcTo7wNNK65TsCPW6i08jWZwo5rR5qL4WQOVbc5bGzXNjM4P9pWz1PdWzOSZx+lwvWbytq5rcUdGTs9izidKGVb8mgppTKNplMf09UNK47LOsfb6B0m5LY7eZtj+2fdzJz1elc30+mV6QqK6000XE8GLmZ1pVaoJgv8iXm7fDYYKAlds3/cbfdgw4/pQiQxr6TYbUZlzmuhn1LXm0wXEVzvzOG61OHzUVL1Q9adzKmt9xkxXfYwvSeeaw6X6+nPyX018k7IDoHKzAV64xDLZvXSN1/sSWfmTb2kzbLjiqRWQ6KDnt5DxcnGVd2nq7f7YUOBbUBzCZ7sbmwBff1xA6aBWTiRjYqSMnQr9kw0s71my5nm2NnxNISmgbnemsXJdUV1J9jZJOZk1cwxy46OpQOnpu45ufAo5Y81m30LM7xpDpHpwpHpsyNcM49cVzec3Dyk7gV7dDPcHbe+6h25TO+445qH4Dq98ZQK18MWDWwzpbnXQsdTXYGRfOAgDCF6TB5Sh1G8NP3t+uqxfWw27ba5evnht7/++v9qobHijIoBAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000000..98a4377942 --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1414 @@ +: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: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/classes/_ic_reactor_store.ActorManager.html b/classes/_ic_reactor_store.ActorManager.html new file mode 100644 index 0000000000..919e513537 --- /dev/null +++ b/classes/_ic_reactor_store.ActorManager.html @@ -0,0 +1,56 @@ +ActorManager | IC ReActor +

Class ActorManager<A>

Type Parameters

Constructors

constructor +

Properties

DEFAULT_ACTOR_STATE +actor +actorStore +agentManager +canisterId +idlFactory +unsubscribeAgent +visitFunction +

Methods

callMethod +extractService +getActor +initialize +initializeActor +updateMethodState +updateState +

Constructors

constructor

Properties

Private DEFAULT_ACTOR_STATE

DEFAULT_ACTOR_STATE: ActorState<A> = ...

Private actor

actor: null | A = null

actorStore

actorStore: ActorStore<A>

agentManager

agentManager: AgentManager

canisterId

canisterId: CanisterId

Private idlFactory

idlFactory: InterfaceFactory

unsubscribeAgent

unsubscribeAgent: (() => void) = ...

Type declaration

    • (): void

    • Returns void

visitFunction

visitFunction: ExtractedService<A>

Methods

callMethod

extractService

getActor

initialize

Private initializeActor

updateMethodState

Private updateState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.AgentManager.html b/classes/_ic_reactor_store.AgentManager.html new file mode 100644 index 0000000000..eac4fa83a2 --- /dev/null +++ b/classes/_ic_reactor_store.AgentManager.html @@ -0,0 +1,54 @@ +AgentManager | IC ReActor +

Class AgentManager

Constructors

constructor +

Properties

DEFAULT_AUTH_STATE +agent +authStore +isLocalEnv +subscribers +

Methods

authenticate +getAgent +initializeAgent +notifySubscribers +subscribeAgent +unsubscribeAgent +updateAgent +updateState +

Constructors

constructor

Properties

Private DEFAULT_AUTH_STATE

DEFAULT_AUTH_STATE: AgentAuthState = ...

Private agent

agent: HttpAgent

authStore

authStore: AgentAuthStore

isLocalEnv

isLocalEnv: boolean

Private subscribers

subscribers: ((agent) => void)[] = []

Type declaration

    • (agent): void

    • Parameters

      Returns void

Methods

authenticate

getAgent

Private initializeAgent

Private notifySubscribers

subscribeAgent

unsubscribeAgent

updateAgent

Private updateState

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.AuthClient.html b/classes/_ic_reactor_store.AuthClient.html new file mode 100644 index 0000000000..d974542595 --- /dev/null +++ b/classes/_ic_reactor_store.AuthClient.html @@ -0,0 +1,97 @@ +AuthClient | IC ReActor +

Class AuthClient

Tool to manage authentication and identity

+

See

AuthClient

+

Constructors

constructor +

Properties

_chain +_createOptions +_eventHandler? +_getEventHandler +_handleFailure +_handleSuccess +_identity +_idpWindow? +_key +_registerDefaultIdleCallback +_removeEventListener +_storage +idleManager +

Methods

getIdentity +isAuthenticated +login +logout +create +

Constructors

Protected constructor

  • new AuthClient(_identity, _key, _chain, _storage, idleManager, _createOptions, _idpWindow?, _eventHandler?): AuthClient

  • Parameters

    • _identity: Identity | PartialIdentity
    • _key: SignIdentity | PartialIdentity
    • _chain: null | DelegationChain
    • _storage: AuthClientStorage
    • idleManager: undefined | IdleManager
    • _createOptions: undefined | AuthClientCreateOptions
    • Optional _idpWindow: Window
    • Optional _eventHandler: ((event) => void)

    Returns AuthClient

Properties

Private _chain

_chain: any

Private _createOptions

_createOptions: any

Private Optional _eventHandler

_eventHandler?: any

Private _getEventHandler

_getEventHandler: any

Private _handleFailure

_handleFailure: any

Private _handleSuccess

_handleSuccess: any

Private _identity

_identity: any

Private Optional _idpWindow

_idpWindow?: any

Private _key

_key: any

Private _registerDefaultIdleCallback

_registerDefaultIdleCallback: any

Private _removeEventListener

_removeEventListener: any

Private _storage

_storage: any

idleManager

idleManager: undefined | IdleManager

Methods

getIdentity

  • getIdentity(): Identity

  • Returns Identity

isAuthenticated

  • isAuthenticated(): Promise<boolean>

  • Returns Promise<boolean>

login

  • login(options?): Promise<void>

  • AuthClient Login - +Opens up a new window to authenticate with Internet Identity

    +

    Parameters

    • Optional options: {
          derivationOrigin?: string | URL;
          identityProvider?: string | URL;
          maxTimeToLive?: bigint;
          onError?: ((error?) => void) | ((error?) => Promise<void>);
          onSuccess?: (() => void) | (() => Promise<void>);
          windowOpenerFeatures?: string;
      }

      Options for logging in

      +
      • Optional derivationOrigin?: string | URL

        Origin for Identity Provider to use while generating the delegated identity. For II, the derivation origin must authorize this origin by setting a record at <derivation-origin>/.well-known/ii-alternative-origins.

        +

        See

        https://github.com/dfinity/internet-identity/blob/main/docs/internet-identity-spec.adoc

        +
      • Optional identityProvider?: string | URL

        Identity provider

        +

        Default

        "https://identity.ic0.app"
+
        +
      • Optional maxTimeToLive?: bigint

        Expiration of the authentication in nanoseconds

        +

        Default

        BigInt(8) hours * BigInt(3_600_000_000_000) nanoseconds
+
        +
      • Optional onError?: ((error?) => void) | ((error?) => Promise<void>)

        Callback in case authentication fails

        +
      • Optional onSuccess?: (() => void) | (() => Promise<void>)

        Callback once login has completed

        +
      • Optional windowOpenerFeatures?: string

        Configures the opened authentication window

        +

    Returns Promise<void>

    Example

    const authClient = await AuthClient.create();
    authClient.login({
     identityProvider: 'http://<canisterID>.127.0.0.1:8000',
     maxTimeToLive: BigInt (7) * BigInt(24) * BigInt(3_600_000_000_000), // 1 week
     windowOpenerFeatures: "toolbar=0,location=0,menubar=0,width=500,height=500,left=100,top=100",
     onSuccess: () => {
       console.log('Login Successful!');
     },
     onError: (error) => {
       console.error('Login Failed: ', error);
     }
    });
+
    +

logout

  • logout(options?): Promise<void>

  • Parameters

    • Optional options: {
          returnTo?: string;
      }
      • Optional returnTo?: string

    Returns Promise<void>

Static create

  • create(options?): Promise<AuthClient>

  • Create an AuthClient to manage authentication and identity

    +

    Parameters

    • Optional options: {
          identity?: SignIdentity | PartialIdentity;
          idleOptions?: IdleOptions;
          keyType?: BaseKeyType;
          storage?: AuthClientStorage;
      }

      Options for creating an AuthClient

      +
      • Optional identity?: SignIdentity | PartialIdentity

        An SignIdentity or PartialIdentity to authenticate via delegation.

        +
      • Optional idleOptions?: IdleOptions

        Options to handle idle timeouts

        +

        Default

        after 10 minutes, invalidates the identity
+
        +
      • Optional keyType?: BaseKeyType

        type to use for the base key

        +

        Default

        'ECDSA'
        If you are using a custom storage provider that does not support CryptoKey storage,
        you should use 'Ed25519' as the key type, as it can serialize to a string
+
        +
      • Optional storage?: AuthClientStorage

        AuthClientStorage

        +

        Description

        Optional storage with get, set, and remove. Uses IdbStorage by default

        +

    Returns Promise<AuthClient>

    Constructs

    See

      +
    • AuthClientCreateOptions
      • +
    • SignIdentity
      • +
    • AuthClientStorage
      • +
    • IdleOptions +Default behavior is to clear stored identity and reload the page when a user goes idle, unless you set the disableDefaultIdleCallback flag or pass in a custom idle callback.
      • +
    +

    Example

    const authClient = await AuthClient.create({
      idleOptions: {
        disableIdle: true
      }
    })
+
    +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.CandidManager.html b/classes/_ic_reactor_store.CandidManager.html new file mode 100644 index 0000000000..092a6b7c52 --- /dev/null +++ b/classes/_ic_reactor_store.CandidManager.html @@ -0,0 +1,46 @@ +CandidManager | IC ReActor +

Class CandidManager

Constructors

constructor +

Properties

agent +didjsId +

Methods

didTojs +getFromMetadata +getFromTmpHack +

Constructors

constructor

Properties

Private agent

agent: HttpAgent

Private didjsId

didjsId: string

Methods

didTojs

getFromMetadata

getFromTmpHack

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.HttpAgent.html b/classes/_ic_reactor_store.HttpAgent.html new file mode 100644 index 0000000000..1ba2becac9 --- /dev/null +++ b/classes/_ic_reactor_store.HttpAgent.html @@ -0,0 +1,71 @@ +HttpAgent | IC ReActor +

Class HttpAgent

Implements

  • Agent

Constructors

constructor +

Properties

#private +_callOptions? +_credentials +_fetch +_fetchOptions? +_host +_identity +_isAgent +_requestAndRetry +_retryTimes +_rootKeyFetched +_timeDiffMsecs +log +rootKey +

Methods

_transform +addTransform +call +createReadStateRequest +fetchRootKey +fetchSubnetKeys +getPrincipal +invalidateIdentity +isLocal +query +readState +replaceIdentity +status +syncTime +

Constructors

constructor

Properties

Private #private

#private: any

Private Optional Readonly _callOptions

_callOptions?: any

Private Readonly _credentials

_credentials: any

Private Readonly _fetch

_fetch: any

Private Optional Readonly _fetchOptions

_fetchOptions?: any

Private Readonly _host

_host: any

Private _identity

_identity: any

Readonly _isAgent

_isAgent: true = true

Private _requestAndRetry

_requestAndRetry: any

Private Readonly _retryTimes

_retryTimes: any

Private _rootKeyFetched

_rootKeyFetched: any

Private _timeDiffMsecs

_timeDiffMsecs: any

log

log: ObservableLog

rootKey

rootKey: ArrayBuffer

Methods

Protected _transform

  • _transform(request): Promise<HttpAgentRequest>

  • Parameters

    • request: HttpAgentRequest

    Returns Promise<HttpAgentRequest>

addTransform

  • addTransform(type, fn, priority?): void

  • Parameters

    • type: "query" | "update"
    • fn: HttpAgentRequestTransformFn
    • Optional priority: number

    Returns void

call

  • call(canisterId, options, identity?): Promise<SubmitResponse>

  • Parameters

    Returns Promise<SubmitResponse>

createReadStateRequest

  • createReadStateRequest(fields, identity?): Promise<any>

  • Parameters

    Returns Promise<any>

fetchRootKey

fetchSubnetKeys

  • fetchSubnetKeys(canisterId): Promise<undefined | SubnetStatus>

  • Parameters

    Returns Promise<undefined | SubnetStatus>

getPrincipal

  • getPrincipal(): Promise<Principal>

  • Returns Promise<Principal>

invalidateIdentity

  • invalidateIdentity(): void

  • Returns void

isLocal

  • isLocal(): boolean

  • Returns boolean

query

  • query(canisterId, fields, identity?): Promise<ApiQueryResponse>

  • Parameters

    Returns Promise<ApiQueryResponse>

readState

  • readState(canisterId, fields, identity?, request?): Promise<ReadStateResponse>

  • Parameters

    Returns Promise<ReadStateResponse>

replaceIdentity

  • replaceIdentity(identity): void

  • Parameters

    Returns void

status

  • status(): Promise<JsonObject>

  • Returns Promise<JsonObject>

syncTime

  • syncTime(canisterId?): Promise<void>

  • Allows agent to sync its time with the network. Can be called during intialization or mid-lifecycle if the device's clock has drifted away from the network time. This is necessary to set the Expiry for a request

    +

    Parameters

    • Optional canisterId: Principal

      Pass a canister ID if you need to sync the time with a particular replica. Uses the management canister by default

      +

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.BoolClass.html b/classes/_ic_reactor_store.IDL.BoolClass.html new file mode 100644 index 0000000000..65656a2682 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.BoolClass.html @@ -0,0 +1,59 @@ +BoolClass | IC ReActor +

Class BoolClass

Represents an IDL Bool

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is boolean

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is boolean

decodeValue

  • decodeValue(b, t): boolean

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns boolean

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: boolean

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: boolean

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.ConstructType.html b/classes/_ic_reactor_store.IDL.ConstructType.html new file mode 100644 index 0000000000..016f4deed8 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.ConstructType.html @@ -0,0 +1,59 @@ +ConstructType | IC ReActor +

Class ConstructType<T>Abstract

Represents an IDL type.

+

Type Parameters

  • T = any

Hierarchy (view full)

Constructors

constructor +

Properties

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Abstract Readonly name

name: string

Methods

Protected Abstract _buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

Abstract accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

Abstract covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T

Abstract decodeValue

  • decodeValue(x, t): T

  • Parameters

    • x: PipeArrayBuffer
    • t: Type<any>

    Returns T

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

Abstract encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.EmptyClass.html b/classes/_ic_reactor_store.IDL.EmptyClass.html new file mode 100644 index 0000000000..67230dbb06 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.EmptyClass.html @@ -0,0 +1,61 @@ +EmptyClass | IC ReActor +

Class EmptyClass

Represents an IDL Empty, a type which has no inhabitants. +Since no values exist for this type, it cannot be serialised or deserialised. +Result types like Result<Text, Empty> should always succeed.

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is never

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is never

decodeValue

  • decodeValue(): never

  • Returns never

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(): never
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Returns never

valueToString

  • valueToString(): never

  • Returns never

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.FixedIntClass.html b/classes/_ic_reactor_store.IDL.FixedIntClass.html new file mode 100644 index 0000000000..a2cea448a2 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.FixedIntClass.html @@ -0,0 +1,60 @@ +FixedIntClass | IC ReActor +

Class FixedIntClass

Represents an IDL fixed-width Int(n)

+

Hierarchy (view full)

Constructors

constructor +

Properties

_bits +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Readonly _bits

_bits: number

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is bigint

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is bigint

decodeValue

  • decodeValue(b, t): number | bigint

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns number | bigint

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: number | bigint

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: number | bigint

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.FixedNatClass.html b/classes/_ic_reactor_store.IDL.FixedNatClass.html new file mode 100644 index 0000000000..da18dd6a71 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.FixedNatClass.html @@ -0,0 +1,60 @@ +FixedNatClass | IC ReActor +

Class FixedNatClass

Represents an IDL fixed-width Nat(n)

+

Hierarchy (view full)

Constructors

constructor +

Properties

_bits +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Readonly _bits

_bits: number

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is bigint

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is bigint

decodeValue

  • decodeValue(b, t): number | bigint

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns number | bigint

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: number | bigint

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: number | bigint

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.FloatClass.html b/classes/_ic_reactor_store.IDL.FloatClass.html new file mode 100644 index 0000000000..5250885de1 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.FloatClass.html @@ -0,0 +1,60 @@ +FloatClass | IC ReActor +

Class FloatClass

Represents an IDL Float

+

Hierarchy (view full)

Constructors

constructor +

Properties

_bits +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Private _bits

_bits: any

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is number

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is number

decodeValue

  • decodeValue(b, t): number

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns number

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: number

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: number

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.FuncClass.html b/classes/_ic_reactor_store.IDL.FuncClass.html new file mode 100644 index 0000000000..50543d9d61 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.FuncClass.html @@ -0,0 +1,67 @@ +FuncClass | IC ReActor +

Class FuncClass

Represents an IDL function reference.

+

Param: argTypes

Argument types.

+

Param: retTypes

Return types.

+

Param: annotations

Function annotations.

+

Hierarchy (view full)

Constructors

constructor +

Properties

annotations +argTypes +encodeAnnotation +retTypes +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +argsToString +

Constructors

constructor

  • new FuncClass(argTypes, retTypes, annotations?): FuncClass

  • Parameters

    • argTypes: Type<any>[]
    • retTypes: Type<any>[]
    • Optional annotations: string[]

    Returns FuncClass

Properties

annotations

annotations: string[]

argTypes

argTypes: Type<any>[]

Private encodeAnnotation

encodeAnnotation: any

retTypes

retTypes: Type<any>[]

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(T): void

  • Parameters

    • T: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is [Principal, string]

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is [Principal, string]

decodeValue

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(__namedParameters): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

valueToString

  • valueToString(__namedParameters): string

  • Parameters

    Returns string

Static argsToString

  • argsToString(types, v): string

  • Parameters

    • types: Type<any>[]
    • v: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.IntClass.html b/classes/_ic_reactor_store.IDL.IntClass.html new file mode 100644 index 0000000000..a4836fb83b --- /dev/null +++ b/classes/_ic_reactor_store.IDL.IntClass.html @@ -0,0 +1,59 @@ +IntClass | IC ReActor +

Class IntClass

Represents an IDL Int

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is bigint

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is bigint

decodeValue

  • decodeValue(b, t): bigint

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns bigint

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: number | bigint

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: bigint

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.NatClass.html b/classes/_ic_reactor_store.IDL.NatClass.html new file mode 100644 index 0000000000..e276d6e369 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.NatClass.html @@ -0,0 +1,59 @@ +NatClass | IC ReActor +

Class NatClass

Represents an IDL Nat

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is bigint

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is bigint

decodeValue

  • decodeValue(b, t): bigint

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns bigint

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: number | bigint

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: bigint

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.NullClass.html b/classes/_ic_reactor_store.IDL.NullClass.html new file mode 100644 index 0000000000..a057db385c --- /dev/null +++ b/classes/_ic_reactor_store.IDL.NullClass.html @@ -0,0 +1,59 @@ +NullClass | IC ReActor +

Class NullClass

Represents an IDL Null

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is null

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is null

decodeValue

  • decodeValue(b, t): null

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns null

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: null

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.OptClass.html b/classes/_ic_reactor_store.IDL.OptClass.html new file mode 100644 index 0000000000..630ba5757b --- /dev/null +++ b/classes/_ic_reactor_store.IDL.OptClass.html @@ -0,0 +1,60 @@ +OptClass | IC ReActor +

Class OptClass<T>

Represents an IDL Option

+

Param: t

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor +

Properties

_type +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Protected _type

_type: Type<T>

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is [] | [T]

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is [] | [T]

decodeValue

  • decodeValue(b, t): [] | [T]

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns [] | [T]

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: [] | [T]

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: [] | [T]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.PrimitiveType.html b/classes/_ic_reactor_store.IDL.PrimitiveType.html new file mode 100644 index 0000000000..72907696b0 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.PrimitiveType.html @@ -0,0 +1,59 @@ +PrimitiveType | IC ReActor +

Class PrimitiveType<T>Abstract

Represents an IDL type.

+

Type Parameters

  • T = any

Hierarchy (view full)

Constructors

constructor +

Properties

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Abstract Readonly name

name: string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

Abstract accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

  • checkType(t): Type<any>

  • Parameters

    Returns Type<any>

Abstract covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T

Abstract decodeValue

  • decodeValue(x, t): T

  • Parameters

    • x: PipeArrayBuffer
    • t: Type<any>

    Returns T

display

  • display(): string

  • Returns string

Abstract encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

Abstract encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.PrincipalClass.html b/classes/_ic_reactor_store.IDL.PrincipalClass.html new file mode 100644 index 0000000000..df49fd1473 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.PrincipalClass.html @@ -0,0 +1,59 @@ +PrincipalClass | IC ReActor +

Class PrincipalClass

Represents an IDL principal reference

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is Principal

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is Principal

decodeValue

display

  • display(): string

  • Returns string

encodeType

encodeValue

valueToString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.RecClass.html b/classes/_ic_reactor_store.IDL.RecClass.html new file mode 100644 index 0000000000..3f474f4276 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.RecClass.html @@ -0,0 +1,65 @@ +RecClass | IC ReActor +

Class RecClass<T>

Represents a reference to an IDL type, used for defining recursive data +types.

+

Type Parameters

  • T = any

Hierarchy (view full)

Constructors

constructor +

Properties

_id +_type +_counter +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +fill +getType +valueToString +

Constructors

constructor

Properties

Private _id

_id: any

Private _type

_type: any

Private Static _counter

_counter: any

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T

decodeValue

  • decodeValue(b, t): T

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns T

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

fill

  • fill(t): void

  • Parameters

    Returns void

getType

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.RecordClass.html b/classes/_ic_reactor_store.IDL.RecordClass.html new file mode 100644 index 0000000000..20dcd2a501 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.RecordClass.html @@ -0,0 +1,62 @@ +RecordClass | IC ReActor +

Class RecordClass

Represents an IDL Record

+

Param: fields

mapping of function name to Type

+

Hierarchy (view full)

Constructors

constructor +

Properties

_fields +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +tryAsTuple +valueToString +

Constructors

constructor

Properties

Protected Readonly _fields

_fields: [string, Type<any>][]

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(T): void

  • Parameters

    • T: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is Record<string, any>

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is Record<string, any>

decodeValue

  • decodeValue(b, t): Record<string, any>

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns Record<string, any>

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

tryAsTuple

  • tryAsTuple(): null | Type<any>[]

  • Returns null | Type<any>[]

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.ReservedClass.html b/classes/_ic_reactor_store.IDL.ReservedClass.html new file mode 100644 index 0000000000..b2d8e1a5df --- /dev/null +++ b/classes/_ic_reactor_store.IDL.ReservedClass.html @@ -0,0 +1,59 @@ +ReservedClass | IC ReActor +

Class ReservedClass

Represents an IDL Reserved

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is any

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is any

decodeValue

  • decodeValue(b, t): null

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns null

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: any

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.ServiceClass.html b/classes/_ic_reactor_store.IDL.ServiceClass.html new file mode 100644 index 0000000000..9c1600c2da --- /dev/null +++ b/classes/_ic_reactor_store.IDL.ServiceClass.html @@ -0,0 +1,60 @@ +ServiceClass | IC ReActor +

Class ServiceClass

Represents an IDL type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

_fields +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Readonly _fields

_fields: [string, FuncClass][]

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(T): void

  • Parameters

    • T: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is Principal

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is Principal

decodeValue

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

valueToString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.TextClass.html b/classes/_ic_reactor_store.IDL.TextClass.html new file mode 100644 index 0000000000..cf03e42d67 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.TextClass.html @@ -0,0 +1,59 @@ +TextClass | IC ReActor +

Class TextClass

Represents an IDL Text

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is string

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is string

decodeValue

  • decodeValue(b, t): string

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns string

display

  • display(): string

  • Returns string

encodeType

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: string

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: string

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.TupleClass.html b/classes/_ic_reactor_store.IDL.TupleClass.html new file mode 100644 index 0000000000..6e5d33d7e0 --- /dev/null +++ b/classes/_ic_reactor_store.IDL.TupleClass.html @@ -0,0 +1,62 @@ +TupleClass | IC ReActor +

Class TupleClass<T>

Represents Tuple, a syntactic sugar for Record.

+

Param: components

Type Parameters

  • T extends any[]

Hierarchy (view full)

Constructors

constructor +

Properties

_components +_fields +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +tryAsTuple +valueToString +

Constructors

constructor

Properties

Protected Readonly _components

_components: Type<any>[]

Protected Readonly _fields

_fields: [string, Type<any>][]

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(T): void

  • Parameters

    • T: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T

decodeValue

  • decodeValue(b, t): T

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns T

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: any[]

    Returns ArrayBuffer

tryAsTuple

  • tryAsTuple(): null | Type<any>[]

  • Returns null | Type<any>[]

valueToString

  • valueToString(values): string

  • Parameters

    • values: any[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.Type.html b/classes/_ic_reactor_store.IDL.Type.html new file mode 100644 index 0000000000..261e2a241c --- /dev/null +++ b/classes/_ic_reactor_store.IDL.Type.html @@ -0,0 +1,59 @@ +Type | IC ReActor +

Class Type<T>Abstract

Represents an IDL type.

+

Type Parameters

  • T = any

Hierarchy (view full)

Constructors

constructor +

Properties

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

  • new Type<T>(): Type<T>

  • Type Parameters

    • T = any

    Returns Type<T>

Properties

Abstract Readonly name

name: string

Methods

Protected Abstract _buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

Abstract accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

Abstract checkType

  • checkType(t): Type<any>

  • Parameters

    Returns Type<any>

Abstract covariant

  • covariant(x): x is T

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T

Abstract decodeValue

  • decodeValue(x, t): T

  • Parameters

    • x: PipeArrayBuffer
    • t: Type<any>

    Returns T

display

  • display(): string

  • Returns string

Abstract encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

Abstract encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.UnknownClass.html b/classes/_ic_reactor_store.IDL.UnknownClass.html new file mode 100644 index 0000000000..db1632955a --- /dev/null +++ b/classes/_ic_reactor_store.IDL.UnknownClass.html @@ -0,0 +1,63 @@ +UnknownClass | IC ReActor +

Class UnknownClass

Represents an IDL Unknown, a placeholder type for deserialization only. +When decoding a value as Unknown, all fields will be retained but the names are only available in +hashed form. +A deserialized unknown will offer it's actual type by calling the type() function. +Unknown cannot be serialized and attempting to do so will throw an error.

+

Hierarchy (view full)

Constructors

constructor +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Accessors

name

  • get name(): string

  • Returns string

Methods

Protected _buildTypeTableImpl

  • _buildTypeTableImpl(): void

  • Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

  • checkType(t): Type<any>

  • Parameters

    Returns Type<any>

covariant

  • covariant(x): x is any

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is any

decodeValue

  • decodeValue(b, t): any

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns any

display

  • display(): string

  • Returns string

encodeType

  • encodeType(): never

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Returns never

encodeValue

  • encodeValue(): never
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Returns never

valueToString

  • valueToString(): never

  • Returns never

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.VariantClass.html b/classes/_ic_reactor_store.IDL.VariantClass.html new file mode 100644 index 0000000000..aec728dcab --- /dev/null +++ b/classes/_ic_reactor_store.IDL.VariantClass.html @@ -0,0 +1,61 @@ +VariantClass | IC ReActor +

Class VariantClass

Represents an IDL Variant

+

Param: fields

mapping of function name to Type

+

Hierarchy (view full)

Constructors

constructor +

Properties

_fields +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Private Readonly _fields

_fields: any

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is Record<string, any>

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is Record<string, any>

decodeValue

  • decodeValue(b, t): {
        [x: string]: any;
    }

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns {
        [x: string]: any;
    }

    • [x: string]: any

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.VecClass.html b/classes/_ic_reactor_store.IDL.VecClass.html new file mode 100644 index 0000000000..15f546e07e --- /dev/null +++ b/classes/_ic_reactor_store.IDL.VecClass.html @@ -0,0 +1,63 @@ +VecClass | IC ReActor +

Class VecClass<T>

Represents an IDL Array

+

Arrays of fixed-sized nat/int type (e.g. nat8), are encoded from and decoded to TypedArrays (e.g. Uint8Array). +Arrays of float or other non-primitive types are encoded/decoded as untyped array in Javascript.

+

Param: t

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor +

Properties

_blobOptimization +_type +

Accessors

name +

Methods

_buildTypeTableImpl +accept +buildTypeTable +checkType +covariant +decodeValue +display +encodeType +encodeValue +valueToString +

Constructors

constructor

Properties

Private _blobOptimization

_blobOptimization: any

Protected _type

_type: Type<T>

Accessors

name

  • get name(): string

  • Returns string

Methods

_buildTypeTableImpl

  • _buildTypeTableImpl(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

accept

  • accept<D, R>(v, d): R

  • Type Parameters

    • D

    • R

    Parameters

    Returns R

buildTypeTable

  • buildTypeTable(typeTable): void

  • Parameters

    • typeTable: TypeTable

    Returns void

checkType

covariant

  • covariant(x): x is T[]

  • Assert that JavaScript's x is the proper type represented by this +Type.

    +

    Parameters

    • x: any

    Returns x is T[]

decodeValue

  • decodeValue(b, t): T[]

  • Parameters

    • b: PipeArrayBuffer
    • t: Type<any>

    Returns T[]

display

  • display(): string

  • Returns string

encodeType

  • encodeType(typeTable): ArrayBuffer

  • Implement I in the IDL spec. +Encode this type for the type table.

    +

    Parameters

    • typeTable: TypeTable

    Returns ArrayBuffer

encodeValue

  • encodeValue(x): ArrayBuffer
  • Internal

    Encode the value. This needs to be public because it is used by +encodeValue() from different types.

    +

    Parameters

    • x: T[]

    Returns ArrayBuffer

valueToString

  • valueToString(x): string

  • Parameters

    • x: T[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc
+ + +

\ No newline at end of file diff --git a/classes/_ic_reactor_store.IDL.Visitor.html b/classes/_ic_reactor_store.IDL.Visitor.html new file mode 100644 index 0000000000..f90e74fb9e --- /dev/null +++ b/classes/_ic_reactor_store.IDL.Visitor.html @@ -0,0 +1,64 @@ +Visitor | IC ReActor +

Class Visitor<D, R>Abstract

Type Parameters

  • D

  • R

Hierarchy

  • Visitor

    Constructors

    constructor +

    Methods

    visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Methods

    visitBool

    • visitBool(t, data): R

    • Parameters

      Returns R

    visitConstruct

    • visitConstruct<T>(t, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitEmpty

    • visitEmpty(t, data): R

    • Parameters

      Returns R

    visitFixedInt

    • visitFixedInt(t, data): R

    • Parameters

      Returns R

    visitFixedNat

    • visitFixedNat(t, data): R

    • Parameters

      Returns R

    visitFloat

    • visitFloat(t, data): R

    • Parameters

      Returns R

    visitFunc

    • visitFunc(t, data): R

    • Parameters

      Returns R

    visitInt

    • visitInt(t, data): R

    • Parameters

      Returns R

    visitNat

    • visitNat(t, data): R

    • Parameters

      Returns R

    visitNull

    • visitNull(t, data): R

    • Parameters

      Returns R

    visitNumber

    • visitNumber<T>(t, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitOpt

    • visitOpt<T>(t, ty, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitPrimitive

    • visitPrimitive<T>(t, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitPrincipal

    • visitPrincipal(t, data): R

    • Parameters

      Returns R

    visitRec

    • visitRec<T>(t, ty, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitRecord

    • visitRecord(t, fields, data): R

    • Parameters

      Returns R

    visitReserved

    • visitReserved(t, data): R

    • Parameters

      Returns R

    visitService

    • visitService(t, data): R

    • Parameters

      Returns R

    visitText

    • visitText(t, data): R

    • Parameters

      Returns R

    visitTuple

    • visitTuple<T>(t, components, data): R

    • Type Parameters

      • T extends any[]

      Parameters

      Returns R

    visitType

    • visitType<T>(t, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    visitVariant

    • visitVariant(t, fields, data): R

    • Parameters

      Returns R

    visitVec

    • visitVec<T>(t, ty, data): R

    • Type Parameters

      • T

      Parameters

      Returns R

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_store.Principal.html b/classes/_ic_reactor_store.Principal.html new file mode 100644 index 0000000000..ecae3c10d2 --- /dev/null +++ b/classes/_ic_reactor_store.Principal.html @@ -0,0 +1,72 @@ +Principal | IC ReActor +

    Class Principal

    Constructors

    constructor +

    Properties

    _arr +_isPrincipal +

    Methods

    compareTo +gtEq +isAnonymous +ltEq +toHex +toJSON +toString +toText +toUint8Array +anonymous +from +fromHex +fromText +fromUint8Array +managementCanister +selfAuthenticating +

    Constructors

    Protected constructor

    Properties

    Private _arr

    _arr: any

    Readonly _isPrincipal

    _isPrincipal: true = true

    Methods

    compareTo

    • compareTo(other): "lt" | "eq" | "gt"

    • Utility method taking a Principal to compare against. Used for determining canister ranges in certificate verification

      +

      Parameters

      Returns "lt" | "eq" | "gt"

      'lt' | 'eq' | 'gt' a string, representing less than, equal to, or greater than

      +

    gtEq

    • gtEq(other): boolean

    • Utility method checking whether a provided Principal is greater than or equal to the current one using the Principal.compareTo method

      +

      Parameters

      Returns boolean

      boolean

      +

    isAnonymous

    • isAnonymous(): boolean

    • Returns boolean

    ltEq

    • ltEq(other): boolean

    • Utility method checking whether a provided Principal is less than or equal to the current one using the Principal.compareTo method

      +

      Parameters

      Returns boolean

      boolean

      +

    toHex

    • toHex(): string

    • Returns string

    toJSON

    • toJSON(): JsonnablePrincipal

    • Serializes to JSON

      +

      Returns JsonnablePrincipal

      a JSON object with a single key, JSON_KEY_PRINCIPAL, whose value is the principal as a string

      +

    toString

    • toString(): string

    • Returns string

    toText

    • toText(): string

    • Returns string

    toUint8Array

    • toUint8Array(): Uint8Array

    • Returns Uint8Array

    Static anonymous

    • anonymous(): Principal

    • Returns Principal

    Static from

    • from(other): Principal

    • Parameters

      • other: unknown

      Returns Principal

    Static fromHex

    • fromHex(hex): Principal

    • Parameters

      • hex: string

      Returns Principal

    Static fromText

    • fromText(text): Principal

    • Parameters

      • text: string

      Returns Principal

    Static fromUint8Array

    Static managementCanister

    • managementCanister(): Principal

    • Utility method, returning the principal representing the management canister, decoded from the hex string 'aaaaa-aa'

      +

      Returns Principal

      principal of the management canister

      +

    Static selfAuthenticating

    • selfAuthenticating(publicKey): Principal

    • Parameters

      Returns Principal

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitDetails.html b/classes/_ic_reactor_visitor.VisitDetails.html new file mode 100644 index 0000000000..ec25ec5454 --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitDetails.html @@ -0,0 +1,67 @@ +VisitDetails | IC ReActor +

    Class VisitDetails<A>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Properties

    counter +visitFixedInt +visitFixedNat +visitFloat +visitInt +visitNat +visitedRecursive +

    Methods

    visiGenericType +visitBool +visitConstruct +visitEmpty +visitFunc +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Properties

    counter

    counter: number = 0

    visitFixedInt

    visitFixedInt: (<T>(t, __label) => InputDetails) = ...

    Type declaration

    visitFixedNat

    visitFixedNat: (<T>(t, __label) => InputDetails) = ...

    Type declaration

    visitFloat

    visitFloat: (<T>(t, __label) => InputDetails) = ...

    Type declaration

    visitInt

    visitInt: (<T>(t, __label) => InputDetails) = ...

    Type declaration

    visitNat

    visitNat: (<T>(t, __label) => InputDetails) = ...

    Type declaration

    Private visitedRecursive

    visitedRecursive: Record<string, true> = {}

    Methods

    Private visiGenericType

    visitBool

    visitConstruct

    visitEmpty

    visitFunc

    visitNull

    visitNumber

    visitOpt

    visitPrimitive

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    visitService

    visitText

    visitTuple

    visitType

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitFields.html b/classes/_ic_reactor_visitor.VisitFields.html new file mode 100644 index 0000000000..36b353174e --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitFields.html @@ -0,0 +1,64 @@ +VisitFields | IC ReActor +

    Class VisitFields<A, M>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Methods

    visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Methods

    visitBool

    visitConstruct

    visitEmpty

    visitFixedInt

    visitFixedNat

    visitFloat

    visitFunc

    visitInt

    visitNat

    visitNull

    visitNumber

    visitOpt

    visitPrimitive

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    visitService

    visitText

    visitTuple

    visitType

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitRandomArgs.html b/classes/_ic_reactor_visitor.VisitRandomArgs.html new file mode 100644 index 0000000000..ae09fc0dc8 --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitRandomArgs.html @@ -0,0 +1,69 @@ +VisitRandomArgs | IC ReActor +

    Class VisitRandomArgs<A>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Properties

    savedRec +

    Methods

    bytesToHex +generateBigInteger +generateNumber +generateRandomBytes +visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Properties

    Private savedRec

    savedRec: Record<string, any> = {}

    Methods

    Private bytesToHex

    Private generateBigInteger

    Private generateNumber

    Private generateRandomBytes

    visitBool

    visitConstruct

    • visitConstruct<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitEmpty

    • visitEmpty(t, data): any

    • Parameters

      Returns any

    visitFixedInt

    visitFixedNat

    visitFloat

    visitFunc

    visitInt

    visitNat

    visitNull

    visitNumber

    • visitNumber<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitOpt

    visitPrimitive

    • visitPrimitive<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    • visitReserved(t, data): any

    • Parameters

      Returns any

    visitService

    • visitService(t, data): any

    • Parameters

      Returns any

    visitText

    visitTuple

    visitType

    • visitType<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitRandomResponse.html b/classes/_ic_reactor_visitor.VisitRandomResponse.html new file mode 100644 index 0000000000..1edc3ea216 --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitRandomResponse.html @@ -0,0 +1,69 @@ +VisitRandomResponse | IC ReActor +

    Class VisitRandomResponse<A, M>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Properties

    savedRec +

    Methods

    bytesToHex +generateBigInteger +generateNumber +generateRandomBytes +visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Properties

    Private savedRec

    savedRec: Record<string, any> = {}

    Methods

    Private bytesToHex

    Private generateBigInteger

    Private generateNumber

    Private generateRandomBytes

    visitBool

    visitConstruct

    • visitConstruct<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitEmpty

    • visitEmpty(t, data): any

    • Parameters

      Returns any

    visitFixedInt

    visitFixedNat

    visitFloat

    visitFunc

    visitInt

    visitNat

    visitNull

    visitNumber

    • visitNumber<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitOpt

    visitPrimitive

    • visitPrimitive<T>(t, data): any

    • Type Parameters

      • T

      Parameters

      Returns any

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    • visitReserved(t, data): any

    • Parameters

      Returns any

    visitService

    • visitService(t, data): any

    • Parameters

      Returns any

    visitText

    visitTuple

    visitType

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitTransform.html b/classes/_ic_reactor_visitor.VisitTransform.html new file mode 100644 index 0000000000..bb46fe1248 --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitTransform.html @@ -0,0 +1,64 @@ +VisitTransform | IC ReActor +

    Class VisitTransform<A, M>

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor +

    Methods

    visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Methods

    visitBool

    visitConstruct

    visitEmpty

    visitFixedInt

    visitFixedNat

    visitFloat

    visitFunc

    visitInt

    visitNat

    visitNull

    visitNumber

    visitOpt

    visitPrimitive

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    visitService

    visitText

    visitTuple

    visitType

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/classes/_ic_reactor_visitor.VisitTransformTable.html b/classes/_ic_reactor_visitor.VisitTransformTable.html new file mode 100644 index 0000000000..f0522a966a --- /dev/null +++ b/classes/_ic_reactor_visitor.VisitTransformTable.html @@ -0,0 +1,64 @@ +VisitTransformTable | IC ReActor +

    Class VisitTransformTable<A, M>

    Type Parameters

    Hierarchy (view full)

    • Visitor<DynamicDataArgs, MethodResult<A, M>>
      • VisitTransformTable

    Constructors

    constructor +

    Methods

    visitBool +visitConstruct +visitEmpty +visitFixedInt +visitFixedNat +visitFloat +visitFunc +visitInt +visitNat +visitNull +visitNumber +visitOpt +visitPrimitive +visitPrincipal +visitRec +visitRecord +visitReserved +visitService +visitText +visitTuple +visitType +visitVariant +visitVec +

    Constructors

    constructor

    Methods

    visitBool

    visitConstruct

    • visitConstruct<T>(t, data): MethodResult<A, M>

    • Type Parameters

      • T

      Parameters

      Returns MethodResult<A, M>

    visitEmpty

    • visitEmpty(t, data): MethodResult<A, M>

    • Parameters

      Returns MethodResult<A, M>

    visitFixedInt

    visitFixedNat

    visitFloat

    visitFunc

    visitInt

    visitNat

    visitNull

    • visitNull(t, data): MethodResult<A, M>

    • Parameters

      Returns MethodResult<A, M>

    visitNumber

    visitOpt

    visitPrimitive

    • visitPrimitive<T>(t, data): MethodResult<A, M>

    • Type Parameters

      • T

      Parameters

      Returns MethodResult<A, M>

    visitPrincipal

    visitRec

    visitRecord

    visitReserved

    • visitReserved(t, data): MethodResult<A, M>

    • Parameters

      Returns MethodResult<A, M>

    visitService

    • visitService(t, data): MethodResult<A, M>

    • Parameters

      Returns MethodResult<A, M>

    visitText

    visitTuple

    visitType

    visitVariant

    visitVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Func.html b/functions/_ic_reactor_store.IDL.Func.html new file mode 100644 index 0000000000..d948a8a8d3 --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Func.html @@ -0,0 +1,44 @@ +Func | IC ReActor +

    Function Func

    • Func(args, ret, annotations?): FuncClass

    • Parameters

      • args: Type<any>[]

        array of IDL Types

        +
      • ret: Type<any>[]

        array of IDL Types

        +
      • Optional annotations: string[]

        array of strings, [] by default

        +

      Returns FuncClass

      new FuncClass

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Opt.html b/functions/_ic_reactor_store.IDL.Opt.html new file mode 100644 index 0000000000..7aa1cab4ba --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Opt.html @@ -0,0 +1,42 @@ +Opt | IC ReActor +

    Function Opt

    • Opt<T>(t): OptClass<T>

    • Type Parameters

      • T

      Parameters

      Returns OptClass<T>

      OptClass of Type

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Rec.html b/functions/_ic_reactor_store.IDL.Rec.html new file mode 100644 index 0000000000..f7b43f25f9 --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Rec.html @@ -0,0 +1,41 @@ +Rec | IC ReActor +

    Function Rec

    • Rec(): RecClass

    • Returns RecClass

      new RecClass

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Record.html b/functions/_ic_reactor_store.IDL.Record.html new file mode 100644 index 0000000000..2e358f020e --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Record.html @@ -0,0 +1,42 @@ +Record | IC ReActor +

    Function Record

    • Record(t): RecordClass

    • Parameters

      • t: Record<string, Type<any>>

        Record of string and IDL Type

        +

      Returns RecordClass

      RecordClass of string and Type

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Service.html b/functions/_ic_reactor_store.IDL.Service.html new file mode 100644 index 0000000000..b2e9422d9f --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Service.html @@ -0,0 +1,42 @@ +Service | IC ReActor +

    Function Service

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Tuple.html b/functions/_ic_reactor_store.IDL.Tuple.html new file mode 100644 index 0000000000..95d574e12a --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Tuple.html @@ -0,0 +1,42 @@ +Tuple | IC ReActor +

    Function Tuple

    • Tuple<T>(...types): TupleClass<T>

    • Type Parameters

      • T extends any[]

      Parameters

      • Rest ...types: T

        array of any types

        +

      Returns TupleClass<T>

      TupleClass from those types

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Variant.html b/functions/_ic_reactor_store.IDL.Variant.html new file mode 100644 index 0000000000..dd375be814 --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Variant.html @@ -0,0 +1,42 @@ +Variant | IC ReActor +

    Function Variant

    • Variant(fields): VariantClass

    • Parameters

      • fields: Record<string, Type<any>>

        Record of string and IDL Type

        +

      Returns VariantClass

      VariantClass

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.Vec.html b/functions/_ic_reactor_store.IDL.Vec.html new file mode 100644 index 0000000000..1c0bbfdb38 --- /dev/null +++ b/functions/_ic_reactor_store.IDL.Vec.html @@ -0,0 +1,42 @@ +Vec | IC ReActor +

    Function Vec

    • Vec<T>(t): VecClass<T>

    • Type Parameters

      • T

      Parameters

      Returns VecClass<T>

      VecClass from that type

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.decode.html b/functions/_ic_reactor_store.IDL.decode.html new file mode 100644 index 0000000000..ee389c171f --- /dev/null +++ b/functions/_ic_reactor_store.IDL.decode.html @@ -0,0 +1,44 @@ +decode | IC ReActor +

    Function decode

    • decode(retTypes, bytes): JsonValue[]

    • Decode a binary value

      +

      Parameters

      • retTypes: Type<any>[]

        Types expected in the buffer.

        +
      • bytes: ArrayBuffer

        hex-encoded string, or buffer.

        +

      Returns JsonValue[]

      Value deserialised to JS type

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.IDL.encode.html b/functions/_ic_reactor_store.IDL.encode.html new file mode 100644 index 0000000000..3f00e11c1b --- /dev/null +++ b/functions/_ic_reactor_store.IDL.encode.html @@ -0,0 +1,44 @@ +encode | IC ReActor +

    Function encode

    • encode(argTypes, args): ArrayBuffer

    • Encode a array of values

      +

      Parameters

      • argTypes: Type<any>[]

        array of Types

        +
      • args: any[]

        array of values

        +

      Returns ArrayBuffer

      serialised value

      +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.createActorManager.html b/functions/_ic_reactor_store.createActorManager.html new file mode 100644 index 0000000000..fe1a8a306c --- /dev/null +++ b/functions/_ic_reactor_store.createActorManager.html @@ -0,0 +1,46 @@ +createActorManager | IC ReActor +

    Function createActorManager

    • createActorManager<A>(options): ActorManager<A>

    • Create an actor manager

      +

      Example


      // actor.ts
      import { createActorManager } from "@ic-reactor/store"
      import { candid, canisterId, idlFactory } from "./candid"
      import { agentManager } from "./agent"

      type Candid = typeof candid

      const actorManager = createActorManager<Candid>({
        agentManager,
        canisterId,
        idlFactory,
      })

      // later in your code
      const data = await actorManager.callMethod("version")
+
      +

      Type Parameters

      Parameters

      Returns ActorManager<A>

        +
      • The actor manager
        • +
      +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.createAgentManager.html b/functions/_ic_reactor_store.createAgentManager.html new file mode 100644 index 0000000000..b1313d540f --- /dev/null +++ b/functions/_ic_reactor_store.createAgentManager.html @@ -0,0 +1,56 @@ +createAgentManager | IC ReActor +

    Function createAgentManager

    • createAgentManager(options?): AgentManager

    • Create an agent manager

      +

      Example


      // agent.ts
      import { createAgentManager } from "@ic-reactor/store"

      export const agentManager = createAgentManager() // connect to the default ic network

      // later in your code
      const identity = await agentManager.authenticate()
+
      +
        +
      • Local Agent
        • +
      +
      // agent.ts
      import { createAgentManager } from "@ic-reactor/store"

      export const agentManager = createAgentManager({
        isLocalEnv: true,
        port: 8000, // default port is 4943
      })
+
      +
        +
      • Or you can use the host option directly
        • +
      +
      export const agentManager = createAgentManager({
        host: "http://localhost:8000",
      })
+
      +

      Parameters

      Returns AgentManager

        +
      • The agent manager
        • +
      +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.createReActorStore.html b/functions/_ic_reactor_store.createReActorStore.html new file mode 100644 index 0000000000..b5a0563694 --- /dev/null +++ b/functions/_ic_reactor_store.createReActorStore.html @@ -0,0 +1,47 @@ +createReActorStore | IC ReActor +

    Function createReActorStore

    • createReActorStore<A>(options): ActorManager<A>

    • Create a ReActor store.

      +

      Example


      import { createReActorStore } from "@ic-reactor/store"
      import { candid, canisterId, idlFactory } from "./candid"

      type Candid = typeof candid

      const { callMethod, agentManager } = createReActorStore<Candid>({
        canisterId,
        idlFactory,
      })

      // later in your code
      const identity = await agentManager.authenticate()
      const data = await callMethod("version")
+
      +

      Type Parameters

      Parameters

      Returns ActorManager<A>

        +
      • The actor manager.
        • +
      +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.createStoreWithOptionalDevtools.html b/functions/_ic_reactor_store.createStoreWithOptionalDevtools.html new file mode 100644 index 0000000000..14d4087ac8 --- /dev/null +++ b/functions/_ic_reactor_store.createStoreWithOptionalDevtools.html @@ -0,0 +1,40 @@ +createStoreWithOptionalDevtools | IC ReActor +

    Function createStoreWithOptionalDevtools

    • createStoreWithOptionalDevtools(initialState, options): WithDevtools<StoreApi<any>>

    • Parameters

      • initialState: any
      • options: StoreOptions

      Returns WithDevtools<StoreApi<any>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.generateActorHash.html b/functions/_ic_reactor_store.generateActorHash.html new file mode 100644 index 0000000000..cad45adb3c --- /dev/null +++ b/functions/_ic_reactor_store.generateActorHash.html @@ -0,0 +1,40 @@ +generateActorHash | IC ReActor +

    Function generateActorHash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.generateHash.html b/functions/_ic_reactor_store.generateHash.html new file mode 100644 index 0000000000..40afeaa07b --- /dev/null +++ b/functions/_ic_reactor_store.generateHash.html @@ -0,0 +1,40 @@ +generateHash | IC ReActor +

    Function generateHash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.generateRequestHash.html b/functions/_ic_reactor_store.generateRequestHash.html new file mode 100644 index 0000000000..c82aff5a0b --- /dev/null +++ b/functions/_ic_reactor_store.generateRequestHash.html @@ -0,0 +1,40 @@ +generateRequestHash | IC ReActor +

    Function generateRequestHash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.jsonToString.html b/functions/_ic_reactor_store.jsonToString.html new file mode 100644 index 0000000000..ad15645a3a --- /dev/null +++ b/functions/_ic_reactor_store.jsonToString.html @@ -0,0 +1,40 @@ +jsonToString | IC ReActor +

    Function jsonToString

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_store.stringToHash.html b/functions/_ic_reactor_store.stringToHash.html new file mode 100644 index 0000000000..10f3cc395c --- /dev/null +++ b/functions/_ic_reactor_store.stringToHash.html @@ -0,0 +1,40 @@ +stringToHash | IC ReActor +

    Function stringToHash

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.convertStringToNumber.html b/functions/_ic_reactor_visitor.convertStringToNumber.html new file mode 100644 index 0000000000..56db7ce6aa --- /dev/null +++ b/functions/_ic_reactor_visitor.convertStringToNumber.html @@ -0,0 +1,40 @@ +convertStringToNumber | IC ReActor +

    Function convertStringToNumber

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.extractAndSortArgs.html b/functions/_ic_reactor_visitor.extractAndSortArgs.html new file mode 100644 index 0000000000..79e7af8806 --- /dev/null +++ b/functions/_ic_reactor_visitor.extractAndSortArgs.html @@ -0,0 +1,40 @@ +extractAndSortArgs | IC ReActor +

    Function extractAndSortArgs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.isImage.html b/functions/_ic_reactor_visitor.isImage.html new file mode 100644 index 0000000000..5d8f416c69 --- /dev/null +++ b/functions/_ic_reactor_visitor.isImage.html @@ -0,0 +1,40 @@ +isImage | IC ReActor +

    Function isImage

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.isQuery.html b/functions/_ic_reactor_visitor.isQuery.html new file mode 100644 index 0000000000..8e15da2b6f --- /dev/null +++ b/functions/_ic_reactor_visitor.isQuery.html @@ -0,0 +1,40 @@ +isQuery | IC ReActor +

    Function isQuery

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.isUrl.html b/functions/_ic_reactor_visitor.isUrl.html new file mode 100644 index 0000000000..9380895e86 --- /dev/null +++ b/functions/_ic_reactor_visitor.isUrl.html @@ -0,0 +1,40 @@ +isUrl | IC ReActor +

    Function isUrl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.validateError.html b/functions/_ic_reactor_visitor.validateError.html new file mode 100644 index 0000000000..c68df9507b --- /dev/null +++ b/functions/_ic_reactor_visitor.validateError.html @@ -0,0 +1,40 @@ +validateError | IC ReActor +

    Function validateError

    • validateError(t): ((value) => string | true)

    • Parameters

      Returns ((value) => string | true)

        • (value): string | true

        • Parameters

          • value: any

          Returns string | true

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/functions/_ic_reactor_visitor.validateNumberError.html b/functions/_ic_reactor_visitor.validateNumberError.html new file mode 100644 index 0000000000..1fb7beff48 --- /dev/null +++ b/functions/_ic_reactor_visitor.validateNumberError.html @@ -0,0 +1,40 @@ +validateNumberError | IC ReActor +

    Function validateNumberError

    • validateNumberError(t): ((value) => string | true)

    • Parameters

      Returns ((value) => string | true)

        • (value): string | true

        • Parameters

          • value: string

          Returns string | true

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html new file mode 100644 index 0000000000..25b94d94b8 --- /dev/null +++ b/hierarchy.html @@ -0,0 +1,40 @@ +IC ReActor +

    IC ReActor

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/ic-reactor.png b/ic-reactor.png new file mode 100644 index 0000000000..e48f4a20f2 Binary files /dev/null and b/ic-reactor.png differ diff --git a/index.html b/index.html new file mode 100644 index 0000000000..9f2aa0290d --- /dev/null +++ b/index.html @@ -0,0 +1,111 @@ +IC ReActor +

    IC ReActor

    IC-Reactor: A Suite of Frontend Utilities for Internet Computer (IC) Development

    Welcome to IC-Reactor, a comprehensive collection of JavaScript libraries designed to simplify and enhance frontend development on the Internet Computer (IC) blockchain platform. This project provides a set of tools that cater to various aspects of frontend development, ranging from vanilla JavaScript applications to sophisticated React-based projects.

    +

    Packages Overview

    IC-Reactor comprises the following packages, each tailored for specific needs and use cases within the IC ecosystem:

    +

    1. @ic-reactor/react

    Aimed at React developers, this library integrates seamlessly with React applications, providing custom hooks and context for managing blockchain interactions. Whether you're querying data from IC actors, updating states, or handling authentication, @ic-reactor/react streamlines these processes in a React-friendly way.

    +

    2. @ic-reactor/core

    The core library serves as the foundation for managing and interacting with IC actors. It provides essential functionalities like actor initialization, state tracking, and simplified methods for queries and updates. It's a versatile toolkit that can be utilized in various JavaScript environments, ensuring flexibility across different front-end development scenarios.

    +

    3. @ic-reactor/store

    This package is the backbone of the IC-Reactor suite. It provides a simple yet powerful state management utility for IC actors. It's designed to be used in conjunction with the other packages, but it can also be used independently in any JavaScript application.

    +

    Versatility Across Front-End Development

    Whether you're building a simple vanilla JavaScript application, a complex React project, or anything in between, the IC-Reactor suite is equipped to support your development process. By abstracting the complexities of blockchain interactions and state management, these libraries allow developers to focus on building feature-rich, responsive, and user-friendly front-end applications on the Internet Computer platform.

    +

    Leveraging the power of these libraries, developers can efficiently handle a range of tasks from querying and displaying blockchain data to managing user authentication states - all within the familiar ecosystem of JavaScript and React.

    +

    @ic-reactor/react @ic-reactor/react

    @ic-reactor/react is a React library designed to seamlessly integrate Internet Computer (IC) blockchain interactions into your React applications. It simplifies the process of managing actor states, performing queries, and handling updates within the IC blockchain ecosystem.

    +

    Key Features

      +
    • React Context Integration: Utilizes React Context for managing global state related to IC actors.
      • +
    • Custom React Hooks: Provides custom hooks (useQueryCall, useUpdateCall, useAuthClient) for easy interaction with IC actors.
      • +
    • Simplified Actor Interaction: Streamlines the process of querying and updating data from IC actors.
      • +
    • Efficient State Management: Manages loading, error, and data states efficiently within React components.
      • +
    +

    Installation

    To install @ic-reactor/react, run the following command:

    +
    npm install @ic-reactor/react
+
    +

    Or using yarn:

    +
    yarn add @ic-reactor/react
+
    +

    Usage

    Examples

    For more complex examples, refer to the examples directory.

    +

    @ic-reactor/core npm version

    @ic-reactor/core is a foundational library for managing and interacting with Internet Computer (IC) blockchain actors within your application. It simplifies the process of initializing actors, handling state, authentication, performing queries and updates.

    +

    Key Features

      +
    • Efficient Actor Initialization and Management: Streamline the process of initializing and managing IC actors.
      • +
    • State Management: Track loading, authentication, and error states easily.
      • +
    • Query and Update Functionality: Simplified methods for querying data from actors and updating actor states.
      • +
    • Testability: Built with testing in mind, allowing you to easily test actor interactions.
      • +
    +

    Installation

    To install @ic-reactor/core, run:

    +
    npm install @ic-reactor/core
+
    +

    Or with yarn:

    +
    yarn add @ic-reactor/core
+
    +

    Usage

    @ic-reactor/store @ic-reactor/store

    @ic-reactor/store is a state management utility designed for applications working with the Internet Computer (IC) blockchain. It provides a simplified way to manage actor states, handle asynchronous calls, and maintain global state in your IC blockchain applications.

    +

    Key Features

      +
    • Simplified Actor State Management: Manage the state of your actors with ease.
      • +
    • Asynchronous Call Handling: Facilitate asynchronous calls to IC actors.
      • +
    • Error and Loading State Management: Easily track loading and error states across your application.
      • +
    • Default State Template: Start with a predefined default state structure.
      • +
    +

    Installation

    To install @ic-reactor/store, use npm:

    +
    npm install @ic-reactor/store
+
    +

    Or with yarn:

    +
    yarn add @ic-reactor/store
+
    +

    Usage

    We Welcome Feature Requests and Contributions

    Feature Requests

    Your feedback and ideas are invaluable in helping IC-Reactor evolve and improve. We warmly welcome feature requests and suggestions that can enhance the functionality and usability of our libraries. If there's something you'd like to see added or improved, please feel free to share your thoughts:

    +
      +

    • Submit a Feature Request: You can use the GitHub Issues section of the respective package repository to submit feature requests. Please provide as much detail as possible about the feature and how it would benefit users.

      +
      • +

    • Discussion and Planning: Our team is open to discussing potential features and their implementation. We value community input and are always looking for ways to make our tools more useful and accessible.

      +
      • +
    +

    Contributing to IC-Reactor

    IC-Reactor is an open-source project, and we encourage contributions from developers of all skill levels. Whether you're fixing bugs, adding features, or improving documentation, your help is welcome. Here's how you can contribute:

    +
      +

    1. Check the Issues: Browse the existing issues for bugs or feature requests that interest you. You can also create a new issue if you have a proposal or have identified a bug.

      +
      2. +

    2. Fork and Clone: Fork the repository you wish to contribute to, and clone it to your local machine.

      +
      3. +

    3. Create a Branch: Make your changes in a new branch. Naming your branch something relevant to your changes can be helpful.

      +
      4. +

    4. Develop and Test: Make your changes and test them thoroughly. Ensure you adhere to the existing code style and guidelines.

      +
      5. +

    5. Submit a Pull Request: Once you're satisfied with your changes, push your branch to your fork and submit a pull request to the main repository. Provide a clear description of your changes and any relevant issue numbers.

      +
      6. +

    6. Review and Merge: The maintainers will review your pull request and either merge it or request changes. If your pull request is merged, you will be credited as a contributor.

      +
      7. +
    +

    Join Our Community

    We believe in the power of community collaboration to create amazing tools. Your contributions, whether code, ideas, or feedback, are crucial to the success and growth of IC-Reactor. Join us in our mission to build effective and user-friendly tools for Internet Computer blockchain development!

    +

    License

    This project is licensed under the MIT License. See the LICENSE file for more details.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.ActorManagerOptions.html b/interfaces/_ic_reactor_store.ActorManagerOptions.html new file mode 100644 index 0000000000..60e1f10902 --- /dev/null +++ b/interfaces/_ic_reactor_store.ActorManagerOptions.html @@ -0,0 +1,46 @@ +ActorManagerOptions | IC ReActor +

    Interface ActorManagerOptions

    interface ActorManagerOptions {
        agentManager: AgentManager;
        canisterId: CanisterId;
        idlFactory: InterfaceFactory;
        initializeOnCreate?: boolean;
        withDevtools?: boolean;
        withVisitor?: boolean;
    }

    Properties

    agentManager +canisterId +idlFactory +initializeOnCreate? +withDevtools? +withVisitor? +

    Properties

    agentManager

    agentManager: AgentManager

    canisterId

    canisterId: CanisterId

    idlFactory

    idlFactory: InterfaceFactory

    Optional initializeOnCreate

    initializeOnCreate?: boolean

    Optional withDevtools

    withDevtools?: boolean

    Optional withVisitor

    withVisitor?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.ActorMethod.html b/interfaces/_ic_reactor_store.ActorMethod.html new file mode 100644 index 0000000000..8a13c5876d --- /dev/null +++ b/interfaces/_ic_reactor_store.ActorMethod.html @@ -0,0 +1,42 @@ +ActorMethod | IC ReActor +

    Interface ActorMethod<Args, Ret>

    An actor method type, defined for each methods of the actor service.

    +
    interface ActorMethod<Args, Ret> {
        withOptions(options): ((...args) => Promise<Ret>);
        (...args): Promise<Ret>;
    }

    Type Parameters

    • Args extends unknown[] = unknown[]

    • Ret = unknown

    • ActorMethod(...args): Promise<Ret>

    • Parameters

      Returns Promise<Ret>

    Methods

    withOptions +

    Methods

    withOptions

    • withOptions(options): ((...args) => Promise<Ret>)

    • Parameters

      • options: CallConfig

      Returns ((...args) => Promise<Ret>)

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.ActorMethodState.html b/interfaces/_ic_reactor_store.ActorMethodState.html new file mode 100644 index 0000000000..b1a2a8c7b4 --- /dev/null +++ b/interfaces/_ic_reactor_store.ActorMethodState.html @@ -0,0 +1,40 @@ +ActorMethodState | IC ReActor +

    Interface ActorMethodState<A, M>

    interface ActorMethodState<A, M> {
        [key: string]: {
            data: ExtractActorMethodReturnType<A[M]> | undefined;
            error: Error | undefined;
            loading: boolean;
        };
    }

    Type Parameters

    Indexable

    [key: string]: {
        data: ExtractActorMethodReturnType<A[M]> | undefined;
        error: Error | undefined;
        loading: boolean;
    }

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.AgentAuthState.html b/interfaces/_ic_reactor_store.AgentAuthState.html new file mode 100644 index 0000000000..173d677738 --- /dev/null +++ b/interfaces/_ic_reactor_store.AgentAuthState.html @@ -0,0 +1,47 @@ +AgentAuthState | IC ReActor +

    Interface AgentAuthState

    interface AgentAuthState {
        authClient: null | AuthClient;
        authenticated: boolean;
        authenticating: boolean;
        error: undefined | Error;
        identity: null | Identity;
        initialized: boolean;
        initializing: boolean;
    }

    Properties

    authClient +authenticated +authenticating +error +identity +initialized +initializing +

    Properties

    authClient

    authClient: null | AuthClient

    authenticated

    authenticated: boolean

    authenticating

    authenticating: boolean

    error

    error: undefined | Error

    identity

    identity: null | Identity

    initialized

    initialized: boolean

    initializing

    initializing: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.AgentManagerOptions.html b/interfaces/_ic_reactor_store.AgentManagerOptions.html new file mode 100644 index 0000000000..56e66c3be9 --- /dev/null +++ b/interfaces/_ic_reactor_store.AgentManagerOptions.html @@ -0,0 +1,68 @@ +AgentManagerOptions | IC ReActor +

    Interface AgentManagerOptions

    interface AgentManagerOptions {
        callOptions?: Record<string, unknown>;
        credentials?: {
            name: string;
            password?: string;
        };
        fetch?: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
        fetchOptions?: Record<string, unknown>;
        host?: string;
        identity?: Identity | Promise<Identity>;
        isLocalEnv?: boolean;
        logToConsole?: boolean;
        port?: number;
        retryTimes?: number;
        source?: HttpAgent;
        useQueryNonces?: boolean;
        verifyQuerySignatures?: boolean;
        withDevtools?: boolean;
    }

    Hierarchy (view full)

    Properties

    callOptions? +credentials? +fetch? +fetchOptions? +host? +identity? +isLocalEnv? +logToConsole? +port? +retryTimes? +source? +useQueryNonces? +verifyQuerySignatures? +withDevtools? +

    Properties

    Optional callOptions

    callOptions?: Record<string, unknown>

    Optional credentials

    credentials?: {
        name: string;
        password?: string;
    }

    Type declaration

    • name: string
    • Optional password?: string

    Optional fetch

    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

    Optional fetchOptions

    fetchOptions?: Record<string, unknown>

    Optional host

    host?: string

    Optional identity

    identity?: Identity | Promise<Identity>

    Optional isLocalEnv

    isLocalEnv?: boolean

    Optional logToConsole

    logToConsole?: boolean

    Whether to log to the console. Defaults to false.

    +

    Optional port

    port?: number

    Optional retryTimes

    retryTimes?: number

    Number of times to retry requests before throwing an error

    +

    Default

    3
+
    +

    Optional source

    source?: HttpAgent

    Optional useQueryNonces

    useQueryNonces?: boolean

    Adds a unique Nonce with each query. +Enabling will prevent queries from being answered with a cached response.

    +

    Example

    const agent = new HttpAgent({ useQueryNonces: true });
    agent.addTransform(makeNonceTransform(makeNonce);
+
    +

    Default

    false
+
    +

    Optional verifyQuerySignatures

    verifyQuerySignatures?: boolean

    Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister's subnet.

    +

    Default

    true
+
    +

    Optional withDevtools

    withDevtools?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.CreateReActorOptions.html b/interfaces/_ic_reactor_store.CreateReActorOptions.html new file mode 100644 index 0000000000..404f74882c --- /dev/null +++ b/interfaces/_ic_reactor_store.CreateReActorOptions.html @@ -0,0 +1,73 @@ +CreateReActorOptions | IC ReActor +

    Interface CreateReActorOptions

    interface CreateReActorOptions {
        agentManager?: AgentManager;
        callOptions?: Record<string, unknown>;
        canisterId: CanisterId;
        credentials?: {
            name: string;
            password?: string;
        };
        fetch?: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
        fetchOptions?: Record<string, unknown>;
        host?: string;
        identity?: Identity | Promise<Identity>;
        idlFactory: InterfaceFactory;
        initializeOnCreate?: boolean;
        isLocalEnv?: boolean;
        logToConsole?: boolean;
        port?: number;
        retryTimes?: number;
        source?: HttpAgent;
        useQueryNonces?: boolean;
        verifyQuerySignatures?: boolean;
        withDevtools?: boolean;
        withVisitor?: boolean;
    }

    Hierarchy (view full)

    Properties

    agentManager? +callOptions? +canisterId +credentials? +fetch? +fetchOptions? +host? +identity? +idlFactory +initializeOnCreate? +isLocalEnv? +logToConsole? +port? +retryTimes? +source? +useQueryNonces? +verifyQuerySignatures? +withDevtools? +withVisitor? +

    Properties

    Optional agentManager

    agentManager?: AgentManager

    Optional callOptions

    callOptions?: Record<string, unknown>

    canisterId

    canisterId: CanisterId

    Optional credentials

    credentials?: {
        name: string;
        password?: string;
    }

    Type declaration

    • name: string
    • Optional password?: string

    Optional fetch

    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

    Optional fetchOptions

    fetchOptions?: Record<string, unknown>

    Optional host

    host?: string

    Optional identity

    identity?: Identity | Promise<Identity>

    idlFactory

    idlFactory: InterfaceFactory

    Optional initializeOnCreate

    initializeOnCreate?: boolean

    Optional isLocalEnv

    isLocalEnv?: boolean

    Optional logToConsole

    logToConsole?: boolean

    Whether to log to the console. Defaults to false.

    +

    Optional port

    port?: number

    Optional retryTimes

    retryTimes?: number

    Number of times to retry requests before throwing an error

    +

    Default

    3
+
    +

    Optional source

    source?: HttpAgent

    Optional useQueryNonces

    useQueryNonces?: boolean

    Adds a unique Nonce with each query. +Enabling will prevent queries from being answered with a cached response.

    +

    Example

    const agent = new HttpAgent({ useQueryNonces: true });
    agent.addTransform(makeNonceTransform(makeNonce);
+
    +

    Default

    false
+
    +

    Optional verifyQuerySignatures

    verifyQuerySignatures?: boolean

    Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister's subnet.

    +

    Default

    true
+
    +

    Optional withDevtools

    withDevtools?: boolean

    Optional withVisitor

    withVisitor?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.DefaultActorType.html b/interfaces/_ic_reactor_store.DefaultActorType.html new file mode 100644 index 0000000000..e5ca626c61 --- /dev/null +++ b/interfaces/_ic_reactor_store.DefaultActorType.html @@ -0,0 +1,40 @@ +DefaultActorType | IC ReActor +

    Interface DefaultActorType

    interface DefaultActorType {
        [key: string]: ActorMethod<any, any>;
    }

    Indexable

    [key: string]: ActorMethod<any, any>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.HttpAgentOptions.html b/interfaces/_ic_reactor_store.HttpAgentOptions.html new file mode 100644 index 0000000000..dd297b6dcc --- /dev/null +++ b/interfaces/_ic_reactor_store.HttpAgentOptions.html @@ -0,0 +1,65 @@ +HttpAgentOptions | IC ReActor +

    Interface HttpAgentOptions

    interface HttpAgentOptions {
        callOptions?: Record<string, unknown>;
        credentials?: {
            name: string;
            password?: string;
        };
        fetch?: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
        fetchOptions?: Record<string, unknown>;
        host?: string;
        identity?: Identity | Promise<Identity>;
        logToConsole?: boolean;
        retryTimes?: number;
        source?: HttpAgent;
        useQueryNonces?: boolean;
        verifyQuerySignatures?: boolean;
    }

    Hierarchy (view full)

    Properties

    callOptions? +credentials? +fetch? +fetchOptions? +host? +identity? +logToConsole? +retryTimes? +source? +useQueryNonces? +verifyQuerySignatures? +

    Properties

    Optional callOptions

    callOptions?: Record<string, unknown>

    Optional credentials

    credentials?: {
        name: string;
        password?: string;
    }

    Type declaration

    • name: string
    • Optional password?: string

    Optional fetch

    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

    Optional fetchOptions

    fetchOptions?: Record<string, unknown>

    Optional host

    host?: string

    Optional identity

    identity?: Identity | Promise<Identity>

    Optional logToConsole

    logToConsole?: boolean

    Whether to log to the console. Defaults to false.

    +

    Optional retryTimes

    retryTimes?: number

    Number of times to retry requests before throwing an error

    +

    Default

    3
+
    +

    Optional source

    source?: HttpAgent

    Optional useQueryNonces

    useQueryNonces?: boolean

    Adds a unique Nonce with each query. +Enabling will prevent queries from being answered with a cached response.

    +

    Example

    const agent = new HttpAgent({ useQueryNonces: true });
    agent.addTransform(makeNonceTransform(makeNonce);
+
    +

    Default

    false
+
    +

    Optional verifyQuerySignatures

    verifyQuerySignatures?: boolean

    Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister's subnet.

    +

    Default

    true
+
    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.Identity.html b/interfaces/_ic_reactor_store.Identity.html new file mode 100644 index 0000000000..dd442c7f6a --- /dev/null +++ b/interfaces/_ic_reactor_store.Identity.html @@ -0,0 +1,49 @@ +Identity | IC ReActor +

    Interface Identity

    A General Identity object. This does not have to be a private key (for example, +the Anonymous identity), but it must be able to transform request.

    +
    interface Identity {
        getPrincipal(): Principal;
        transformRequest(request): Promise<unknown>;
    }

    Methods

    getPrincipal +transformRequest +

    Methods

    getPrincipal

    • getPrincipal(): Principal

    • Get the principal represented by this identity. Normally should be a +Principal.selfAuthenticating().

      +

      Returns Principal

    transformRequest

    • transformRequest(request): Promise<unknown>

    • Transform a request into a signed version of the request. This is done last +after the transforms on the body of a request. The returned object can be +anything, but must be serializable to CBOR.

      +

      Parameters

      • request: HttpAgentRequest

      Returns Promise<unknown>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_store.UpdateAgentOptions.html b/interfaces/_ic_reactor_store.UpdateAgentOptions.html new file mode 100644 index 0000000000..9374e758dc --- /dev/null +++ b/interfaces/_ic_reactor_store.UpdateAgentOptions.html @@ -0,0 +1,66 @@ +UpdateAgentOptions | IC ReActor +

    Interface UpdateAgentOptions

    interface UpdateAgentOptions {
        agent?: HttpAgent;
        callOptions?: Record<string, unknown>;
        credentials?: {
            name: string;
            password?: string;
        };
        fetch?: {
            (input, init?): Promise<Response>;
            (input, init?): Promise<Response>;
        };
        fetchOptions?: Record<string, unknown>;
        host?: string;
        identity?: Identity | Promise<Identity>;
        logToConsole?: boolean;
        retryTimes?: number;
        source?: HttpAgent;
        useQueryNonces?: boolean;
        verifyQuerySignatures?: boolean;
    }

    Hierarchy (view full)

    Properties

    agent? +callOptions? +credentials? +fetch? +fetchOptions? +host? +identity? +logToConsole? +retryTimes? +source? +useQueryNonces? +verifyQuerySignatures? +

    Properties

    Optional agent

    agent?: HttpAgent

    Optional callOptions

    callOptions?: Record<string, unknown>

    Optional credentials

    credentials?: {
        name: string;
        password?: string;
    }

    Type declaration

    • name: string
    • Optional password?: string

    Optional fetch

    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    }

    Type declaration

    Optional fetchOptions

    fetchOptions?: Record<string, unknown>

    Optional host

    host?: string

    Optional identity

    identity?: Identity | Promise<Identity>

    Optional logToConsole

    logToConsole?: boolean

    Whether to log to the console. Defaults to false.

    +

    Optional retryTimes

    retryTimes?: number

    Number of times to retry requests before throwing an error

    +

    Default

    3
+
    +

    Optional source

    source?: HttpAgent

    Optional useQueryNonces

    useQueryNonces?: boolean

    Adds a unique Nonce with each query. +Enabling will prevent queries from being answered with a cached response.

    +

    Example

    const agent = new HttpAgent({ useQueryNonces: true });
    agent.addTransform(makeNonceTransform(makeNonce);
+
    +

    Default

    false
+
    +

    Optional verifyQuerySignatures

    verifyQuerySignatures?: boolean

    Whether the agent should verify signatures signed by node keys on query responses. Increases security, but adds overhead and must make a separate request to cache the node keys for the canister's subnet.

    +

    Default

    true
+
    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.DefaultField.html b/interfaces/_ic_reactor_visitor.DefaultField.html new file mode 100644 index 0000000000..b1ee3e2426 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.DefaultField.html @@ -0,0 +1,47 @@ +DefaultField | IC ReActor +

    Interface DefaultField

    interface DefaultField {
        defaultValue?: any;
        defaultValues?: any;
        label: string;
        maxLength?: number;
        minLength?: number;
        type: FieldType;
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue? +defaultValues? +label +maxLength? +minLength? +type +validate +

    Properties

    Optional defaultValue

    defaultValue?: any

    Optional defaultValues

    defaultValues?: any

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    type

    type: FieldType

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.DynamicDataArgs.html b/interfaces/_ic_reactor_visitor.DynamicDataArgs.html new file mode 100644 index 0000000000..34bd13c9de --- /dev/null +++ b/interfaces/_ic_reactor_visitor.DynamicDataArgs.html @@ -0,0 +1,42 @@ +DynamicDataArgs | IC ReActor +

    Interface DynamicDataArgs<V>

    interface DynamicDataArgs<V> {
        label: string;
        value: V;
    }

    Type Parameters

    • V = any

    Properties

    label +value +

    Properties

    label

    label: string

    value

    value: V

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.ExtractedServiceDetails.html b/interfaces/_ic_reactor_visitor.ExtractedServiceDetails.html new file mode 100644 index 0000000000..0ce77f07ff --- /dev/null +++ b/interfaces/_ic_reactor_visitor.ExtractedServiceDetails.html @@ -0,0 +1,43 @@ +ExtractedServiceDetails | IC ReActor +

    Interface ExtractedServiceDetails<A>

    interface ExtractedServiceDetails<A> {
        canisterId: string;
        description: string;
        methodDetails: ServiceDetails<A>;
    }

    Type Parameters

    Properties

    canisterId +description +methodDetails +

    Properties

    canisterId

    canisterId: string

    description

    description: string

    methodDetails

    methodDetails: ServiceDetails<A>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.ExtractedServiceFields.html b/interfaces/_ic_reactor_visitor.ExtractedServiceFields.html new file mode 100644 index 0000000000..ba038642aa --- /dev/null +++ b/interfaces/_ic_reactor_visitor.ExtractedServiceFields.html @@ -0,0 +1,42 @@ +ExtractedServiceFields | IC ReActor +

    Interface ExtractedServiceFields<A>

    interface ExtractedServiceFields<A> {
        canisterId: string;
        methodFields: ServiceFields<A, FunctionName<A>>;
    }

    Type Parameters

    Properties

    canisterId +methodFields +

    Properties

    canisterId

    canisterId: string

    methodFields

    methodFields: ServiceFields<A, FunctionName<A>>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.FieldDetails.html b/interfaces/_ic_reactor_visitor.FieldDetails.html new file mode 100644 index 0000000000..204ef8f24a --- /dev/null +++ b/interfaces/_ic_reactor_visitor.FieldDetails.html @@ -0,0 +1,43 @@ +FieldDetails | IC ReActor +

    Interface FieldDetails

    interface FieldDetails {
        __description: string;
        __label: string;
        __type: FieldType;
        [key: string]: string | boolean | undefined;
    }

    Hierarchy (view full)

    Indexable

    [key: string]: string | boolean | undefined

    Properties

    __description +__label +__type +

    Properties

    __description

    __description: string

    __label

    __label: string

    __type

    __type: FieldType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.FieldDetailsWithChild.html b/interfaces/_ic_reactor_visitor.FieldDetailsWithChild.html new file mode 100644 index 0000000000..625ebcf644 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.FieldDetailsWithChild.html @@ -0,0 +1,47 @@ +FieldDetailsWithChild | IC ReActor +

    Interface FieldDetailsWithChild

    interface FieldDetailsWithChild {
        __checked?: boolean;
        __description: string;
        __hidden?: boolean;
        __label: string;
        __type: FieldType;
        optional?: OtherDetails;
        vector?: OtherDetails;
        [key: string]: string | boolean | undefined | OtherDetails;
    }

    Indexable

    [key: string]: string | boolean | undefined | OtherDetails

    Properties

    __checked? +__description +__hidden? +__label +__type +optional? +vector? +

    Properties

    Optional __checked

    __checked?: boolean

    __description

    __description: string

    Optional __hidden

    __hidden?: boolean

    __label

    __label: string

    __type

    __type: FieldType

    Optional optional

    optional?: OtherDetails

    Optional vector

    vector?: OtherDetails

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.InputDetails.html b/interfaces/_ic_reactor_visitor.InputDetails.html new file mode 100644 index 0000000000..586fab7a4f --- /dev/null +++ b/interfaces/_ic_reactor_visitor.InputDetails.html @@ -0,0 +1,44 @@ +InputDetails | IC ReActor +

    Interface InputDetails

    interface InputDetails {
        __checked?: boolean;
        __description: string;
        __label: string;
        __type: FieldType;
        [key: string]: string | boolean | undefined;
    }

    Hierarchy (view full)

    Indexable

    [key: string]: string | boolean | undefined

    Properties

    __checked? +__description +__label +__type +

    Properties

    Optional __checked

    __checked?: boolean

    __description

    __description: string

    __label

    __label: string

    __type

    __type: FieldType

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.InputField.html b/interfaces/_ic_reactor_visitor.InputField.html new file mode 100644 index 0000000000..814c067ccc --- /dev/null +++ b/interfaces/_ic_reactor_visitor.InputField.html @@ -0,0 +1,48 @@ +InputField | IC ReActor +

    Interface InputField<T>

    interface InputField<T> {
        defaultValue: FieldTypeFromIDLType<T>;
        defaultValues?: any;
        label: string;
        maxLength?: number;
        minLength?: number;
        required: true;
        type: FieldType;
        validate: ((value) => string | boolean);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues? +label +maxLength? +minLength? +required +type +validate +

    Properties

    defaultValue

    defaultValue: FieldTypeFromIDLType<T>

    Optional defaultValues

    defaultValues?: any

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    required

    required: true

    type

    type: FieldType

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.MethodFields.html b/interfaces/_ic_reactor_visitor.MethodFields.html new file mode 100644 index 0000000000..e80890a0fd --- /dev/null +++ b/interfaces/_ic_reactor_visitor.MethodFields.html @@ -0,0 +1,45 @@ +MethodFields | IC ReActor +

    Interface MethodFields<A, M>

    interface MethodFields<A, M> {
        defaultValues: ServiceDefaultValues<A, M>;
        fields: [] | AllFieldTypes<Type<any>>[];
        functionName: M;
        functionType: FunctionType;
        validate: ((value) => string | boolean);
    }

    Type Parameters

    Properties

    defaultValues +fields +functionName +functionType +validate +

    Properties

    defaultValues

    defaultValues: ServiceDefaultValues<A, M>

    fields

    fields: [] | AllFieldTypes<Type<any>>[]

    functionName

    functionName: M

    functionType

    functionType: FunctionType

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.NumberField.html b/interfaces/_ic_reactor_visitor.NumberField.html new file mode 100644 index 0000000000..ad61866c40 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.NumberField.html @@ -0,0 +1,50 @@ +NumberField | IC ReActor +

    Interface NumberField

    interface NumberField {
        defaultValue: string;
        defaultValues?: any;
        label: string;
        max?: string | number;
        maxLength?: number;
        min?: string | number;
        minLength?: number;
        required: true;
        type: "number";
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues? +label +max? +maxLength? +min? +minLength? +required +type +validate +

    Properties

    defaultValue

    defaultValue: string

    Optional defaultValues

    defaultValues?: any

    label

    label: string

    Optional max

    max?: string | number

    Optional maxLength

    maxLength?: number

    Optional min

    min?: string | number

    Optional minLength

    minLength?: number

    required

    required: true

    type

    type: "number"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.OptionalFields.html b/interfaces/_ic_reactor_visitor.OptionalFields.html new file mode 100644 index 0000000000..bdb0ec26ae --- /dev/null +++ b/interfaces/_ic_reactor_visitor.OptionalFields.html @@ -0,0 +1,48 @@ +OptionalFields | IC ReActor +

    Interface OptionalFields

    interface OptionalFields {
        defaultValue: [];
        defaultValues?: any;
        field: AllFieldTypes<Type<any>>;
        label: string;
        maxLength?: number;
        minLength?: number;
        type: "optional";
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues? +field +label +maxLength? +minLength? +type +validate +

    Properties

    defaultValue

    defaultValue: []

    Optional defaultValues

    defaultValues?: any

    field

    field: AllFieldTypes<Type<any>>

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    type

    type: "optional"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.PrincipalField.html b/interfaces/_ic_reactor_visitor.PrincipalField.html new file mode 100644 index 0000000000..d67915432f --- /dev/null +++ b/interfaces/_ic_reactor_visitor.PrincipalField.html @@ -0,0 +1,48 @@ +PrincipalField | IC ReActor +

    Interface PrincipalField

    interface PrincipalField {
        defaultValue: string;
        defaultValues?: any;
        label: string;
        maxLength: number;
        minLength: number;
        required: true;
        type: "principal";
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues? +label +maxLength +minLength +required +type +validate +

    Properties

    defaultValue

    defaultValue: string

    Optional defaultValues

    defaultValues?: any

    label

    label: string

    maxLength

    maxLength: number

    minLength

    minLength: number

    required

    required: true

    type

    type: "principal"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.RecordFields.html b/interfaces/_ic_reactor_visitor.RecordFields.html new file mode 100644 index 0000000000..2244c58ec2 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.RecordFields.html @@ -0,0 +1,48 @@ +RecordFields | IC ReActor +

    Interface RecordFields<T>

    interface RecordFields<T> {
        defaultValue?: any;
        defaultValues: Record<string, FieldTypeFromIDLType<T>>;
        fields: AllFieldTypes<T>[];
        label: string;
        maxLength?: number;
        minLength?: number;
        type: "record";
        validate: ((value) => string | boolean);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    defaultValue? +defaultValues +fields +label +maxLength? +minLength? +type +validate +

    Properties

    Optional defaultValue

    defaultValue?: any

    defaultValues

    defaultValues: Record<string, FieldTypeFromIDLType<T>>

    fields

    fields: AllFieldTypes<T>[]

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    type

    type: "record"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.RecursiveFields.html b/interfaces/_ic_reactor_visitor.RecursiveFields.html new file mode 100644 index 0000000000..674bc658f2 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.RecursiveFields.html @@ -0,0 +1,49 @@ +RecursiveFields | IC ReActor +

    Interface RecursiveFields

    interface RecursiveFields {
        defaultValue?: any;
        defaultValues?: any;
        extract: (() => VariantFields<Type<any>>);
        label: string;
        maxLength?: number;
        minLength?: number;
        name: string;
        type: "recursive";
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue? +defaultValues? +extract +label +maxLength? +minLength? +name +type +validate +

    Properties

    Optional defaultValue

    defaultValue?: any

    Optional defaultValues

    defaultValues?: any

    extract

    extract: (() => VariantFields<Type<any>>)

    Type declaration

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    name

    name: string

    type

    type: "recursive"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.ResultArrayData.html b/interfaces/_ic_reactor_visitor.ResultArrayData.html new file mode 100644 index 0000000000..7bd4e00534 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.ResultArrayData.html @@ -0,0 +1,42 @@ +ResultArrayData | IC ReActor +

    Interface ResultArrayData<A, M>

    interface ResultArrayData<A, M> {
        label: string;
        value: ExtractActorMethodReturnType<A[M]>[];
    }

    Type Parameters

    Properties

    label +value +

    Properties

    label

    label: string

    value

    value: ExtractActorMethodReturnType<A[M]>[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.ResultRecordData.html b/interfaces/_ic_reactor_visitor.ResultRecordData.html new file mode 100644 index 0000000000..9241269f1a --- /dev/null +++ b/interfaces/_ic_reactor_visitor.ResultRecordData.html @@ -0,0 +1,42 @@ +ResultRecordData | IC ReActor +

    Interface ResultRecordData<A, M>

    interface ResultRecordData<A, M> {
        label: string;
        value: Record<string, ExtractActorMethodReturnType<A[M]>>;
    }

    Type Parameters

    Properties

    label +value +

    Properties

    label

    label: string

    value

    value: Record<string, ExtractActorMethodReturnType<A[M]>>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.TupleFields.html b/interfaces/_ic_reactor_visitor.TupleFields.html new file mode 100644 index 0000000000..ceafc786c3 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.TupleFields.html @@ -0,0 +1,48 @@ +TupleFields | IC ReActor +

    Interface TupleFields<T>

    interface TupleFields<T> {
        defaultValue?: any;
        defaultValues: FieldTypeFromIDLType<T>[];
        fields: AllFieldTypes<T>[];
        label: string;
        maxLength?: number;
        minLength?: number;
        type: "tuple";
        validate: ((value) => string | boolean);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    defaultValue? +defaultValues +fields +label +maxLength? +minLength? +type +validate +

    Properties

    Optional defaultValue

    defaultValue?: any

    defaultValues

    defaultValues: FieldTypeFromIDLType<T>[]

    fields

    fields: AllFieldTypes<T>[]

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    type

    type: "tuple"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.VariantFields.html b/interfaces/_ic_reactor_visitor.VariantFields.html new file mode 100644 index 0000000000..424dc261d2 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.VariantFields.html @@ -0,0 +1,49 @@ +VariantFields | IC ReActor +

    Interface VariantFields<T>

    interface VariantFields<T> {
        defaultValue: string;
        defaultValues: FieldTypeFromIDLType<T>;
        fields: AllFieldTypes<T>[];
        label: string;
        maxLength?: number;
        minLength?: number;
        options: string[];
        type: "variant";
        validate: ((value) => string | boolean);
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues +fields +label +maxLength? +minLength? +options +type +validate +

    Properties

    defaultValue

    defaultValue: string

    defaultValues

    defaultValues: FieldTypeFromIDLType<T>

    fields

    fields: AllFieldTypes<T>[]

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    options

    options: string[]

    type

    type: "variant"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/interfaces/_ic_reactor_visitor.VectorFields.html b/interfaces/_ic_reactor_visitor.VectorFields.html new file mode 100644 index 0000000000..b990b38794 --- /dev/null +++ b/interfaces/_ic_reactor_visitor.VectorFields.html @@ -0,0 +1,48 @@ +VectorFields | IC ReActor +

    Interface VectorFields

    interface VectorFields {
        defaultValue: [];
        defaultValues?: any;
        field: AllFieldTypes<Type<any>>;
        label: string;
        maxLength?: number;
        minLength?: number;
        type: "vector";
        validate: ((value) => string | boolean);
    }

    Hierarchy (view full)

    Properties

    defaultValue +defaultValues? +field +label +maxLength? +minLength? +type +validate +

    Properties

    defaultValue

    defaultValue: []

    Optional defaultValues

    defaultValues?: any

    field

    field: AllFieldTypes<Type<any>>

    label

    label: string

    Optional maxLength

    maxLength?: number

    Optional minLength

    minLength?: number

    type

    type: "vector"

    validate

    validate: ((value) => string | boolean)

    Type declaration

      • (value): string | boolean

      • Parameters

        • value: any

        Returns string | boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/modules/_ic_reactor_core.html b/modules/_ic_reactor_core.html new file mode 100644 index 0000000000..79b0f1f673 --- /dev/null +++ b/modules/_ic_reactor_core.html @@ -0,0 +1,69 @@ +@ic-reactor/core | IC ReActor +

    Module @ic-reactor/core

    IC-ReActor - Core

    ReActor is a JavaScript utility designed to streamline state management and interaction with actors in the Internet Computer (IC) blockchain environment. It provides a simple and effective way to handle asynchronous calls, state updates, and subscriptions, making it easier to build responsive and data-driven applications.

    +

    Features

      +
    • State Management: Efficiently manage the state of your application with actor-based interactions.
      • +
    • Asynchronous Handling: Simplify asynchronous calls and data handling with built-in methods.
      • +
    • Subscription Mechanism: Subscribe to state changes and update your UI in real-time.
      • +
    • Auto-Refresh Capability: Automatically refresh data at specified intervals.
      • +
    • Customizable: Easily adaptable to various use cases within the IC ecosystem.
      • +
    +

    Installation

    npm install @ic-reactor/core
+
    +

    or

    +
    yarn add @ic-reactor/core
+
    +

    Usage

    To get started with ReActor, you'll need to initialize it with your actor configurations. Here's a basic example:

    +
    import { createReActor } from "@ic-reactor/core"

    const { actorStore, authStore, queryCall, updateCall } = createReActor(
      (agent) => createActor("bd3sg-teaaa-aaaaa-qaaba-cai", { agent }),
      {
        host: "https://localhost:4943",
        initializeOnMount: true,
      }
    )
+
    +

    Querying Data

    const { recall, subscribe, getState, initialData, intervalId } = queryCall({
      functionName: "yourFunctionName",
      args: ["arg1", "arg2"],
      autoRefresh: true,
      refreshInterval: 3000,
    })

    // Subscribe to changes
    const unsubscribe = subscribe((newState) => {
      // Handle new state
    })

    // Fetch data
    recall().then((data) => {
      // Handle initial data
    })

    // Get initial data
    initialData.then((data) => {
      // Handle initial data
    })

    // Clear interval if autoRefresh is enabled
    if (intervalId) {
      clearInterval(intervalId)
    }
+
    +

    Updating Data

    const { call, getState, subscribe } = updateCall({
      functionName: "yourUpdateFunction",
      args: ["arg1", "arg2"],
    })

    call().then((result) => {
      // Handle result
    })

    // Get state
    const state = getState()

    // Subscribe to changes
    const unsubscribe = subscribe((newState) => {
      // Handle new state
    })
+
    +

    API Reference

      +
    • queryCall: Fetches and subscribes to data from an actor method. Returns an object containing methods for recalling data, subscribing to changes, getting the current state, and the initial data promise.
      • +
    • updateCall: Updates data and handles state changes for an actor method. Returns an object containing methods for calling the update function, subscribing to changes, and getting the current state.
      • +
    • getState: Retrieves the current state based on the request hash.
      • +
    • subscribe: Allows subscription to state changes.
      • +
    +

    For more detailed API usage and options, please refer to the documentation.

    +

    Contributing

    Contributions are welcome! Please read our contributing guidelines to get started.

    +

    License

    This project is licensed under MIT License.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/modules/_ic_reactor_react.html b/modules/_ic_reactor_react.html new file mode 100644 index 0000000000..63dc8399f3 --- /dev/null +++ b/modules/_ic_reactor_react.html @@ -0,0 +1,76 @@ +@ic-reactor/react | IC ReActor +

    Module @ic-reactor/react

    IC-ReActor - React

    @ic-reactor/react is a comprehensive React library designed to streamline interactions with the Internet Computer (IC) blockchain. It provides React hooks and utilities for efficient state management, authentication, and interaction with IC actors.

    +

    Features

      +
    • React Hooks Integration: Custom hooks for managing blockchain actor states and authentication within React applications.
      • +
    • Efficient State Management: Utilize the power of Zustand for global state management in React components.
      • +
    • Asynchronous Data Handling: Easy handling of asynchronous operations related to IC actors.
      • +
    • Authentication Support: Integrated hooks for managing authentication with the IC blockchain.
      • +
    • Auto-Refresh and Query Capabilities: Support for auto-refreshing data and querying IC actors.
      • +
    +

    Installation

    Install the package using npm:

    +
    npm install @ic-reactor/react
+
    +

    or using yarn:

    +
    yarn add @ic-reactor/react
+
    +

    Usage

    Here's a simple example to get you started:

    +

    First, create an actor declaration file:

    +
    // store.ts
    import { canisterId, idlFactory, actor } from "declaration/actor"
    import { createReActor } from "@ic-reactor/react"

    type Actor = typeof actor

    export const { useActorStore, useAuthClient, useQueryCall } =
      createReActor<Actor>({
        canisterId: "rrkah-fqaaa-aaaaa-aaaaq-cai",
        idlFactory,
        host: "https://localhost:4943",
      })
+
    +

    Then, use the useQueryCall hook to call your canister method:

    +
    // Balance.tsx
    import { useQueryCall } from "./store"

    const Balance = ({ principal }) => {
      const { call, data, loading, error } = useQueryCall({
        functionName: "get_balance",
        args: [principal],
        refetchInterval: 1000,
        refetchOnMount: true,
        onLoading: () => console.log("Loading..."),
        onSuccess: (data) => console.log("Success!", data),
        onError: (error) => console.log("Error!", error),
      })

      return (
        <div>
          <button onClick={() => call()} disabled={loading}>
            {loading ? "Loading..." : "Refresh"}
          </button>
          {loading && <p>Loading...</p>}
          {data && <p>Balance: {data}</p>}
          {error && <p>Error: {error}</p>}
        </div>
      )
    }

    export default Balance
+
    +

    Authentication

    @ic-reactor/react provides a custom hook for managing authentication with the IC blockchain. To use it, first create an authentication declaration file:

    +
    // Login.tsx
    import { useAuthClient } from "./store"

    const Login = () => {
      const {
        login,
        logout,
        loginLoading,
        loginError,
        identity,
        authenticating,
        authenticated,
      } = useAuthClient()

      return (
        <div>
          <h2>Login:</h2>
          <div>
            {loginLoading && <div>Loading...</div>}
            {loginError ? <div>{JSON.stringify(loginError)}</div> : null}
            {identity && <div>{identity.getPrincipal().toText()}</div>}
          </div>
          {authenticated ? (
            <div>
              <button onClick={() => logout()}>Logout</button>
            </div>
          ) : (
            <div>
              <button
                onClick={() =>
                  login({
                    identityProvider:
                      process.env.DFX_NETWORK === "ic"
                        ? "https://identity.ic0.app/#authorize"
                        : "http://rdmx6-jaaaa-aaaaa-aaadq-cai.localhost:4943/#authorize",
                  })
                }
                disabled={authenticating}
              >
                Login
              </button>
            </div>
          )}
        </div>
      )
    }

    export default Login
+
    +

    API Reference

    The library provides various hooks and utilities for interacting with IC actors:

    +
      +
    • useActorStore: Hook for managing actor states.
      • +
    • useAuthStore Hook for managing authentication states.
      • +
    • useAuthClient: Hook for managing authentication with the IC blockchain.
      • +
    • useQueryCall: Hook for querying data from an actor.
      • +
    • useUpdateCall: Hook for updating data in an actor.
      • +
    • Additional hooks for handling loading, errors, authentication, and more.
      • +
    +

    For detailed API usage and options, please refer to the documentation.

    +

    Contributing

    Contributions to @ic-reactor/react are welcome! Please read our contributing guidelines for more information.

    +

    License

    @ic-reactor/react is licensed under the MIT License. See the LICENSE file for more details.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/modules/_ic_reactor_store.IDL.html b/modules/_ic_reactor_store.IDL.html new file mode 100644 index 0000000000..406a297f29 --- /dev/null +++ b/modules/_ic_reactor_store.IDL.html @@ -0,0 +1,94 @@ +IDL | IC ReActor +

    Namespace IDL

    Index

    Classes

    BoolClass +ConstructType +EmptyClass +FixedIntClass +FixedNatClass +FloatClass +FuncClass +IntClass +NatClass +NullClass +OptClass +PrimitiveType +PrincipalClass +RecClass +RecordClass +ReservedClass +ServiceClass +TextClass +TupleClass +Type +UnknownClass +VariantClass +VecClass +Visitor +

    Type Aliases

    InterfaceFactory +

    Variables

    Bool +Empty +Float32 +Float64 +Int +Int16 +Int32 +Int64 +Int8 +Nat +Nat16 +Nat32 +Nat64 +Nat8 +Null +Principal +Reserved +Text +Unknown +

    Functions

    Func +Opt +Rec +Record +Service +Tuple +Variant +Vec +decode +encode +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/modules/_ic_reactor_store.html b/modules/_ic_reactor_store.html new file mode 100644 index 0000000000..d8af196a0a --- /dev/null +++ b/modules/_ic_reactor_store.html @@ -0,0 +1,122 @@ +@ic-reactor/store | IC ReActor +

    Module @ic-reactor/store

    IC-ReActor - Store

    @ic-reactor/store is a state management library designed for applications interacting with the Internet Computer (IC) blockchain. It facilitates the management of actor states, authentication processes, and seamless interaction with IC actors, leveraging the power of zustand for global state management.

    +

    Features

      +
    • Actor State Management: Efficiently manage and update the state of IC actors.
      • +
    • Authentication Handling: Integrated functionality for managing authentication with IC.
      • +
    • Zustand Integration: Utilize zustand for global state management in a React-friendly way.
      • +
    • Error and Loading State Management: Easily handle loading states and errors across your application.
      • +
    • Asynchronous Interaction Support: Built-in support for managing asynchronous interactions with IC actors.
      • +
    +

    Installation

    Install the package using npm:

    +
    npm install @ic-reactor/store
+
    +

    or using yarn:

    +
    yarn add @ic-reactor/store
+
    +

    Usage

    You can this packages in two ways:

    +
      +
    1. Automatic Agent Creation: You can use the createReActorStore factory function to create a new ReActor store instance. This will automatically create an agent and manage its state for you.
      2. +
    +
    import { createReActorStore } from "@ic-reactor/store"
    import { candid, canisterId, idlFactory } from "./candid"

    type Candid = typeof candid

    const { callMethod, agentManager } = createReActorStore<Candid>({
      canisterId,
      idlFactory,
    })

    // later in your code
    const identity = await agentManager.authenticate()
    const data = await callMethod("version")
+
    +
      +
    1. Manual Agent Creation: You can use the createAgentManager to manually create and manage an agent instance.
      2. +
    +
      +
    • IC Agent
      • +
    +
    // agent.ts
    import { createAgentManager } from "@ic-reactor/store"

    export const agentManager = createAgentManager() // connect to the default ic network

    // later in your code
    const identity = await agentManager.authenticate()
+
    +
      +
    • Local Agent
      • +
    +
    // agent.ts
    import { createAgentManager } from "@ic-reactor/store"

    export const agentManager = createAgentManager({
      isLocalEnv: true,
      port: 8000, // default port is 4943
    })
+
    +
      +
    • Or you can use the host option directly
      • +
    +
    export const agentManager = createAgentManager({
      host: "http://localhost:8000",
    })
+
    +

    then you can use the "createActorManager" to create an actor manager

    +
    // actor.ts
    import { createActorManager } from "@ic-reactor/store"
    import { candid, canisterId, idlFactory } from "./candid"
    import { agentManager } from "./agent"

    type Candid = typeof candid

    const actorManager = createActorManager<Candid>({
      agentManager,
      canisterId,
      idlFactory,
    })

    // later in your code
    const data = await actorManager.callMethod("version")
+
    +

    Index

    Main Functions

    createActorManager +createAgentManager +createReActorStore +

    Other

    IDL +ActorManager +AgentManager +AuthClient +CandidManager +HttpAgent +Principal +ActorManagerOptions +ActorMethod +ActorMethodState +AgentAuthState +AgentManagerOptions +CreateReActorOptions +DefaultActorType +HttpAgentOptions +Identity +UpdateAgentOptions +ActorMethodStates +ActorState +ActorStore +ActorSubclass +AgentAuthStore +CallActorMethod +CanisterId +ExtractActorMethodArgs +ExtractActorMethodReturnType +ExtractVisitorType +ExtractedService +FunctionName +FunctionType +IC_HOST_NETWORK_URI +LOCAL_HOST_NETWORK_URI +createStoreWithOptionalDevtools +generateActorHash +generateHash +generateRequestHash +jsonToString +stringToHash +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/modules/_ic_reactor_visitor.html b/modules/_ic_reactor_visitor.html new file mode 100644 index 0000000000..49aae8c3f4 --- /dev/null +++ b/modules/_ic_reactor_visitor.html @@ -0,0 +1,88 @@ +@ic-reactor/visitor | IC ReActor +

    Module @ic-reactor/visitor

    IC-ReActor - Visitor

    This package provides a visitor pattern implementation for the IC-ReActor framework.

    +

    Index

    Classes

    VisitDetails +VisitFields +VisitRandomArgs +VisitRandomResponse +VisitTransform +VisitTransformTable +

    Interfaces

    DefaultField +DynamicDataArgs +ExtractedServiceDetails +ExtractedServiceFields +FieldDetails +FieldDetailsWithChild +InputDetails +InputField +MethodFields +NumberField +OptionalFields +PrincipalField +RecordFields +RecursiveFields +ResultArrayData +ResultRecordData +TupleFields +VariantFields +VectorFields +

    Type Aliases

    AllFieldTypes +AllNumberTypes +DynamicFieldType +DynamicFieldTypeByClass +ExtraInputFormFields +FieldTypeFromIDLType +FunctionCategory +MethodDefaultValues +MethodDetails +MethodResult +MethodResultValue +OtherDetails +ServiceDefaultValues +ServiceDetails +ServiceFields +

    Functions

    convertStringToNumber +extractAndSortArgs +isImage +isQuery +isUrl +validateError +validateNumberError +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ActorMethodStates.html b/types/_ic_reactor_store.ActorMethodStates.html new file mode 100644 index 0000000000..8072a187fc --- /dev/null +++ b/types/_ic_reactor_store.ActorMethodStates.html @@ -0,0 +1,40 @@ +ActorMethodStates | IC ReActor +

    Type alias ActorMethodStates<A>

    ActorMethodStates<A>: {
        [M in FunctionName<A>]: ActorMethodState<A, M>
    }

    Type Parameters

    • A

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ActorState.html b/types/_ic_reactor_store.ActorState.html new file mode 100644 index 0000000000..22ceb7fab1 --- /dev/null +++ b/types/_ic_reactor_store.ActorState.html @@ -0,0 +1,40 @@ +ActorState | IC ReActor +

    Type alias ActorState<A>

    ActorState<A>: {
        error: Error | undefined;
        initialized: boolean;
        initializing: boolean;
        methodState: ActorMethodStates<A>;
    }

    Type Parameters

    • A

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ActorStore.html b/types/_ic_reactor_store.ActorStore.html new file mode 100644 index 0000000000..bd8f4cfc62 --- /dev/null +++ b/types/_ic_reactor_store.ActorStore.html @@ -0,0 +1,40 @@ +ActorStore | IC ReActor +

    Type alias ActorStore<A>

    ActorStore<A>: StoreApi<ActorState<A>>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ActorSubclass.html b/types/_ic_reactor_store.ActorSubclass.html new file mode 100644 index 0000000000..3f5f40d1d5 --- /dev/null +++ b/types/_ic_reactor_store.ActorSubclass.html @@ -0,0 +1,41 @@ +ActorSubclass | IC ReActor +

    Type alias ActorSubclass<T>

    ActorSubclass<T>: Actor & T

    A subclass of an actor. Actor class itself is meant to be a based class.

    +

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.AgentAuthStore.html b/types/_ic_reactor_store.AgentAuthStore.html new file mode 100644 index 0000000000..acea746c7a --- /dev/null +++ b/types/_ic_reactor_store.AgentAuthStore.html @@ -0,0 +1,40 @@ +AgentAuthStore | IC ReActor +

    Type alias AgentAuthStore

    AgentAuthStore: StoreApi<AgentAuthState>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.CallActorMethod.html b/types/_ic_reactor_store.CallActorMethod.html new file mode 100644 index 0000000000..bcf4a61bf6 --- /dev/null +++ b/types/_ic_reactor_store.CallActorMethod.html @@ -0,0 +1,40 @@ +CallActorMethod | IC ReActor +

    Type alias CallActorMethod<A>

    CallActorMethod<A>: (<M>(functionName, ...args) => Promise<ExtractActorMethodReturnType<A[M]>>)

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.CanisterId.html b/types/_ic_reactor_store.CanisterId.html new file mode 100644 index 0000000000..c067af0f80 --- /dev/null +++ b/types/_ic_reactor_store.CanisterId.html @@ -0,0 +1,40 @@ +CanisterId | IC ReActor +

    Type alias CanisterId

    CanisterId: string | Principal

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ExtractActorMethodArgs.html b/types/_ic_reactor_store.ExtractActorMethodArgs.html new file mode 100644 index 0000000000..45e4be3952 --- /dev/null +++ b/types/_ic_reactor_store.ExtractActorMethodArgs.html @@ -0,0 +1,40 @@ +ExtractActorMethodArgs | IC ReActor +

    Type alias ExtractActorMethodArgs<T>

    ExtractActorMethodArgs<T>: T extends ActorMethod<infer A>
        ? A
        : never

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ExtractActorMethodReturnType.html b/types/_ic_reactor_store.ExtractActorMethodReturnType.html new file mode 100644 index 0000000000..a09ad19550 --- /dev/null +++ b/types/_ic_reactor_store.ExtractActorMethodReturnType.html @@ -0,0 +1,40 @@ +ExtractActorMethodReturnType | IC ReActor +

    Type alias ExtractActorMethodReturnType<T>

    ExtractActorMethodReturnType<T>: T extends ActorMethod<any, infer R>
        ? R
        : never

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ExtractVisitorType.html b/types/_ic_reactor_store.ExtractVisitorType.html new file mode 100644 index 0000000000..79a34aec70 --- /dev/null +++ b/types/_ic_reactor_store.ExtractVisitorType.html @@ -0,0 +1,40 @@ +ExtractVisitorType | IC ReActor +

    Type alias ExtractVisitorType<T>

    ExtractVisitorType<T>: T extends Visitor<infer U, infer V>
        ? {
            data: U;
            return: V;
        }
        : never

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.ExtractedService.html b/types/_ic_reactor_store.ExtractedService.html new file mode 100644 index 0000000000..7e8f8baeac --- /dev/null +++ b/types/_ic_reactor_store.ExtractedService.html @@ -0,0 +1,40 @@ +ExtractedService | IC ReActor +

    Type alias ExtractedService<A, M>

    ExtractedService<A, M>: {
        [K in M]: (<V>(extractorClass, data?) => ReturnType<V["visitFunc"]>)
    }

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.FunctionName.html b/types/_ic_reactor_store.FunctionName.html new file mode 100644 index 0000000000..c4815ce13e --- /dev/null +++ b/types/_ic_reactor_store.FunctionName.html @@ -0,0 +1,40 @@ +FunctionName | IC ReActor +

    Type alias FunctionName<A>

    FunctionName<A>: keyof A & string

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.FunctionType.html b/types/_ic_reactor_store.FunctionType.html new file mode 100644 index 0000000000..0ded74b730 --- /dev/null +++ b/types/_ic_reactor_store.FunctionType.html @@ -0,0 +1,40 @@ +FunctionType | IC ReActor +

    Type alias FunctionType

    FunctionType: "query" | "update"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_store.IDL.InterfaceFactory.html b/types/_ic_reactor_store.IDL.InterfaceFactory.html new file mode 100644 index 0000000000..629f2d4b25 --- /dev/null +++ b/types/_ic_reactor_store.IDL.InterfaceFactory.html @@ -0,0 +1,41 @@ +InterfaceFactory | IC ReActor +

    Type alias InterfaceFactory

    InterfaceFactory: ((idl) => ServiceClass)

    An Interface Factory, normally provided by a Candid code generation.

    +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.AllFieldTypes.html b/types/_ic_reactor_visitor.AllFieldTypes.html new file mode 100644 index 0000000000..7be6946f97 --- /dev/null +++ b/types/_ic_reactor_visitor.AllFieldTypes.html @@ -0,0 +1,40 @@ +AllFieldTypes | IC ReActor +

    Type alias AllFieldTypes<T>

    AllFieldTypes<T>: RecordFields<T> | TupleFields<T> | VariantFields<T> | VectorFields | OptionalFields | RecursiveFields | PrincipalField | NumberField | InputField<T>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.AllNumberTypes.html b/types/_ic_reactor_visitor.AllNumberTypes.html new file mode 100644 index 0000000000..259ca30168 --- /dev/null +++ b/types/_ic_reactor_visitor.AllNumberTypes.html @@ -0,0 +1,40 @@ +AllNumberTypes | IC ReActor +

    Type alias AllNumberTypes

    AllNumberTypes: NatClass | IntClass | NatClass | FixedNatClass | FixedIntClass | FloatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.DynamicFieldType.html b/types/_ic_reactor_visitor.DynamicFieldType.html new file mode 100644 index 0000000000..a9b2ede0c7 --- /dev/null +++ b/types/_ic_reactor_visitor.DynamicFieldType.html @@ -0,0 +1,40 @@ +DynamicFieldType | IC ReActor +

    Type alias DynamicFieldType<T>

    DynamicFieldType<T>: T extends "record"
        ? RecordFields<Type>
        : T extends "variant"
            ? VariantFields<Type>
            : T extends "tuple"
                ? TupleFields<Type>
                : T extends "optional"
                    ? OptionalFields
                    : T extends "vector"
                        ? VectorFields
                        : T extends "recursive"
                            ? RecursiveFields
                            : T extends "unknown"
                                ? InputField<Type>
                                : T extends "text"
                                    ? InputField<TextClass>
                                    : T extends "number"
                                        ? NumberField
                                        : T extends "principal"
                                            ? PrincipalField
                                            : T extends "boolean"
                                                ? InputField<BoolClass>
                                                : T extends "null"
                                                    ? InputField<NullClass>
                                                    : never

    Type Parameters

    • T extends FieldType = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.DynamicFieldTypeByClass.html b/types/_ic_reactor_visitor.DynamicFieldTypeByClass.html new file mode 100644 index 0000000000..71755cccb9 --- /dev/null +++ b/types/_ic_reactor_visitor.DynamicFieldTypeByClass.html @@ -0,0 +1,40 @@ +DynamicFieldTypeByClass | IC ReActor +

    Type alias DynamicFieldTypeByClass<T>

    DynamicFieldTypeByClass<T>: T extends RecordClass
        ? RecordFields<T>
        : T extends TupleClass<any>
            ? TupleFields<T>
            : T extends VariantClass
                ? VariantFields<T>
                : T extends VecClass<any>
                    ? VectorFields
                    : T extends OptClass<any>
                        ? OptionalFields
                        : T extends RecClass<any>
                            ? RecursiveFields
                            : T extends PrincipalClass
                                ? PrincipalField
                                : T extends AllNumberTypes
                                    ? NumberField
                                    : InputField<T>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.ExtraInputFormFields.html b/types/_ic_reactor_visitor.ExtraInputFormFields.html new file mode 100644 index 0000000000..2bb4de3f75 --- /dev/null +++ b/types/_ic_reactor_visitor.ExtraInputFormFields.html @@ -0,0 +1,40 @@ +ExtraInputFormFields | IC ReActor +

    Type alias ExtraInputFormFields

    ExtraInputFormFields: Partial<{
        maxLength: number;
        minLength: number;
    }>

    Type declaration

    • maxLength: number
    • minLength: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.FieldTypeFromIDLType.html b/types/_ic_reactor_visitor.FieldTypeFromIDLType.html new file mode 100644 index 0000000000..b507a93653 --- /dev/null +++ b/types/_ic_reactor_visitor.FieldTypeFromIDLType.html @@ -0,0 +1,40 @@ +FieldTypeFromIDLType | IC ReActor +

    Type alias FieldTypeFromIDLType<T>

    FieldTypeFromIDLType<T>: T extends Type
        ? ReturnType<T["decodeValue"]>
        : any

    Type Parameters

    • T = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.FunctionCategory.html b/types/_ic_reactor_visitor.FunctionCategory.html new file mode 100644 index 0000000000..aa07b2eb84 --- /dev/null +++ b/types/_ic_reactor_visitor.FunctionCategory.html @@ -0,0 +1,40 @@ +FunctionCategory | IC ReActor +

    Type alias FunctionCategory

    FunctionCategory: "home" | "wallet" | "governance" | "setting"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.MethodDefaultValues.html b/types/_ic_reactor_visitor.MethodDefaultValues.html new file mode 100644 index 0000000000..3c9c53476e --- /dev/null +++ b/types/_ic_reactor_visitor.MethodDefaultValues.html @@ -0,0 +1,40 @@ +MethodDefaultValues | IC ReActor +

    Type alias MethodDefaultValues<T>

    MethodDefaultValues<T>: {
        [key: `arg${number}`]: FieldTypeFromIDLType<T>;
    }

    Type Parameters

    • T = string

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.MethodDetails.html b/types/_ic_reactor_visitor.MethodDetails.html new file mode 100644 index 0000000000..7b727d3593 --- /dev/null +++ b/types/_ic_reactor_visitor.MethodDetails.html @@ -0,0 +1,40 @@ +MethodDetails | IC ReActor +

    Type alias MethodDetails<A>

    MethodDetails<A>: {
        __description: string;
        __label: string;
        category: FunctionCategory;
        functionName: FunctionName<A>;
        functionType: FunctionType;
        order: number;
        [key: `arg${number}`]: FieldDetailsWithChild;
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.MethodResult.html b/types/_ic_reactor_visitor.MethodResult.html new file mode 100644 index 0000000000..15113d587f --- /dev/null +++ b/types/_ic_reactor_visitor.MethodResult.html @@ -0,0 +1,40 @@ +MethodResult | IC ReActor +

    Type alias MethodResult<A, M>

    MethodResult<A, M>: {
        description: string;
        label: string;
        type: ReturnDataType;
        value?: MethodResultValue<A, M>;
        values?: MethodResult<A, M>[];
    }

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.MethodResultValue.html b/types/_ic_reactor_visitor.MethodResultValue.html new file mode 100644 index 0000000000..1dec3448bd --- /dev/null +++ b/types/_ic_reactor_visitor.MethodResultValue.html @@ -0,0 +1,40 @@ +MethodResultValue | IC ReActor +

    Type alias MethodResultValue<A, M>

    MethodResultValue<A, M>: ExtractActorMethodReturnType<A[M]> | MethodResult<A, M> | number | string | boolean | Principal | Uint8Array | null

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.OtherDetails.html b/types/_ic_reactor_visitor.OtherDetails.html new file mode 100644 index 0000000000..fb7aebb2b8 --- /dev/null +++ b/types/_ic_reactor_visitor.OtherDetails.html @@ -0,0 +1,40 @@ +OtherDetails | IC ReActor +

    Type alias OtherDetails

    OtherDetails: FieldDetails | FieldDetailsWithChild | FieldDetailsWithChild[] | FieldDetails[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.ServiceDefaultValues.html b/types/_ic_reactor_visitor.ServiceDefaultValues.html new file mode 100644 index 0000000000..0a1451a8d2 --- /dev/null +++ b/types/_ic_reactor_visitor.ServiceDefaultValues.html @@ -0,0 +1,40 @@ +ServiceDefaultValues | IC ReActor +

    Type alias ServiceDefaultValues<A, M>

    ServiceDefaultValues<A, M>: {
        [key in M]: MethodDefaultValues<M>
    }

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.ServiceDetails.html b/types/_ic_reactor_visitor.ServiceDetails.html new file mode 100644 index 0000000000..7d8244c432 --- /dev/null +++ b/types/_ic_reactor_visitor.ServiceDetails.html @@ -0,0 +1,40 @@ +ServiceDetails | IC ReActor +

    Type alias ServiceDetails<A>

    ServiceDetails<A>: {
        [K in FunctionName<A>]: (<ExtractorClass>(extractorClass?) => MethodDetails<A>)
    }

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/types/_ic_reactor_visitor.ServiceFields.html b/types/_ic_reactor_visitor.ServiceFields.html new file mode 100644 index 0000000000..539586dcb8 --- /dev/null +++ b/types/_ic_reactor_visitor.ServiceFields.html @@ -0,0 +1,40 @@ +ServiceFields | IC ReActor +

    Type alias ServiceFields<A, M>

    ServiceFields<A, M>: {
        [key in M]: (<ExtractorClass>(extractorClass?) => MethodFields<A, M>)
    }

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IC_HOST_NETWORK_URI.html b/variables/_ic_reactor_store.IC_HOST_NETWORK_URI.html new file mode 100644 index 0000000000..1bcf8e7fd6 --- /dev/null +++ b/variables/_ic_reactor_store.IC_HOST_NETWORK_URI.html @@ -0,0 +1,40 @@ +IC_HOST_NETWORK_URI | IC ReActor +

    Variable IC_HOST_NETWORK_URIConst

    IC_HOST_NETWORK_URI: "https://ic0.app" = "https://ic0.app"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Bool.html b/variables/_ic_reactor_store.IDL.Bool.html new file mode 100644 index 0000000000..9bda70936e --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Bool.html @@ -0,0 +1,40 @@ +Bool | IC ReActor +

    Variable BoolConst

    Bool: BoolClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Empty.html b/variables/_ic_reactor_store.IDL.Empty.html new file mode 100644 index 0000000000..7e72ffd663 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Empty.html @@ -0,0 +1,40 @@ +Empty | IC ReActor +

    Variable EmptyConst

    Empty: EmptyClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Float32.html b/variables/_ic_reactor_store.IDL.Float32.html new file mode 100644 index 0000000000..1360fb86d9 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Float32.html @@ -0,0 +1,40 @@ +Float32 | IC ReActor +

    Variable Float32Const

    Float32: FloatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Float64.html b/variables/_ic_reactor_store.IDL.Float64.html new file mode 100644 index 0000000000..8bd46efbaf --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Float64.html @@ -0,0 +1,40 @@ +Float64 | IC ReActor +

    Variable Float64Const

    Float64: FloatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Int.html b/variables/_ic_reactor_store.IDL.Int.html new file mode 100644 index 0000000000..2b10e46544 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Int.html @@ -0,0 +1,40 @@ +Int | IC ReActor +

    Variable IntConst

    Int: IntClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Int16.html b/variables/_ic_reactor_store.IDL.Int16.html new file mode 100644 index 0000000000..15c30db0cf --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Int16.html @@ -0,0 +1,40 @@ +Int16 | IC ReActor +

    Variable Int16Const

    Int16: FixedIntClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Int32.html b/variables/_ic_reactor_store.IDL.Int32.html new file mode 100644 index 0000000000..d5dabee655 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Int32.html @@ -0,0 +1,40 @@ +Int32 | IC ReActor +

    Variable Int32Const

    Int32: FixedIntClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Int64.html b/variables/_ic_reactor_store.IDL.Int64.html new file mode 100644 index 0000000000..f27eb6891d --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Int64.html @@ -0,0 +1,40 @@ +Int64 | IC ReActor +

    Variable Int64Const

    Int64: FixedIntClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Int8.html b/variables/_ic_reactor_store.IDL.Int8.html new file mode 100644 index 0000000000..b438da77de --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Int8.html @@ -0,0 +1,40 @@ +Int8 | IC ReActor +

    Variable Int8Const

    Int8: FixedIntClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Nat.html b/variables/_ic_reactor_store.IDL.Nat.html new file mode 100644 index 0000000000..fd9cdffe1d --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Nat.html @@ -0,0 +1,40 @@ +Nat | IC ReActor +

    Variable NatConst

    Nat: NatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Nat16.html b/variables/_ic_reactor_store.IDL.Nat16.html new file mode 100644 index 0000000000..9d436faec9 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Nat16.html @@ -0,0 +1,40 @@ +Nat16 | IC ReActor +

    Variable Nat16Const

    Nat16: FixedNatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Nat32.html b/variables/_ic_reactor_store.IDL.Nat32.html new file mode 100644 index 0000000000..2442e3e6c3 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Nat32.html @@ -0,0 +1,40 @@ +Nat32 | IC ReActor +

    Variable Nat32Const

    Nat32: FixedNatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Nat64.html b/variables/_ic_reactor_store.IDL.Nat64.html new file mode 100644 index 0000000000..de9c0fd7f7 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Nat64.html @@ -0,0 +1,40 @@ +Nat64 | IC ReActor +

    Variable Nat64Const

    Nat64: FixedNatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Nat8.html b/variables/_ic_reactor_store.IDL.Nat8.html new file mode 100644 index 0000000000..3a17360610 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Nat8.html @@ -0,0 +1,40 @@ +Nat8 | IC ReActor +

    Variable Nat8Const

    Nat8: FixedNatClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Null.html b/variables/_ic_reactor_store.IDL.Null.html new file mode 100644 index 0000000000..6db166ef41 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Null.html @@ -0,0 +1,40 @@ +Null | IC ReActor +

    Variable NullConst

    Null: NullClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Principal.html b/variables/_ic_reactor_store.IDL.Principal.html new file mode 100644 index 0000000000..3b2fc1c49b --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Principal.html @@ -0,0 +1,40 @@ +Principal | IC ReActor +

    Variable PrincipalConst

    Principal: PrincipalClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Reserved.html b/variables/_ic_reactor_store.IDL.Reserved.html new file mode 100644 index 0000000000..a7dab6a342 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Reserved.html @@ -0,0 +1,40 @@ +Reserved | IC ReActor +

    Variable ReservedConst

    Reserved: ReservedClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Text.html b/variables/_ic_reactor_store.IDL.Text.html new file mode 100644 index 0000000000..d7901fa638 --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Text.html @@ -0,0 +1,40 @@ +Text | IC ReActor +

    Variable TextConst

    Text: TextClass

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.IDL.Unknown.html b/variables/_ic_reactor_store.IDL.Unknown.html new file mode 100644 index 0000000000..a2a3c3558d --- /dev/null +++ b/variables/_ic_reactor_store.IDL.Unknown.html @@ -0,0 +1,41 @@ +Unknown | IC ReActor +

    Variable UnknownConst

    Unknown: UnknownClass

    Client-only type for deserializing unknown data. Not supported by Candid, and its use is discouraged.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file diff --git a/variables/_ic_reactor_store.LOCAL_HOST_NETWORK_URI.html b/variables/_ic_reactor_store.LOCAL_HOST_NETWORK_URI.html new file mode 100644 index 0000000000..7f3223506f --- /dev/null +++ b/variables/_ic_reactor_store.LOCAL_HOST_NETWORK_URI.html @@ -0,0 +1,40 @@ +LOCAL_HOST_NETWORK_URI | IC ReActor +

    Variable LOCAL_HOST_NETWORK_URIConst

    LOCAL_HOST_NETWORK_URI: "http://127.0.0.1:4943" = "http://127.0.0.1:4943"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc
    + + +

    \ No newline at end of file