diff --git a/dist/.gitkeep b/dist/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e2ac661 --- /dev/null +++ b/docs/.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/docs/assets/highlight.css b/docs/assets/highlight.css new file mode 100644 index 0000000..13b6af8 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,78 @@ +:root { + --light-hl-0: #AF00DB; + --dark-hl-0: #C586C0; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #000000; + --dark-hl-7: #C8C8C8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --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); + --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); + --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); + --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); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..3092fea --- /dev/null +++ b/docs/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/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..c4d1167 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VZTVPbMBT8L86VtgQCLdxayq2lFMqJ6XQcWwQVowRLpjCd/vfKn9HH05MszHCAoLe7sfS0GynXfxNBnkRynFCWk6dkJ9mk4la+vF/nVUH4u+bfb2/FfSHH7uSr5HhvJ8luaZGXhCXH1wPBpUhFxbcMhFX3Pb4d02k+/NvZYgkTlJHipKDyry1HVqScD+9Cr9LZ5nsaH10xylaBtFAxxv4pZfkfmkuqgZEyQcqbNBtIhxpj7g4OFaKTNWUIRz2Mwc/WOUHg9TAGP09X5II8VIQLhEWpQsmKFHuUehiFl+tHmpMSo+hKMJpLwjldY2+kq0BJqiXPSroRHialDKMDuuUxLWm6LOxmeTPXmfb3nN1ictSjKFzvFhNej6JwsFtMFqUIJ9O6xWKRozjc6haLoqtAaaxuMVm6ApwE7BaLSakC6H4qhJ3zJrDLMm0Ve5fufv9i9paHac7CaGZdXcu1mB8t9ncXynv9ylcXZEW53BqnLJO135a/SQbbiUbuAGL7SEK6WVyS0WIg0qN2tclTQT4TkdKCj1Z0ooNU28CMFLXBvhQ5fRKEOZ1TU9HKPc/SL/GP5w25Kgtoe7i6ooMgG09d1RECJgZX0FZxhAqEC1Fql260kAZDdMpmdstnL3NfiHBR7t39NxXLasczyJ1IXe1wYap59j8mF2AAtl6AA2CagRbg0sU8wC/rMwFNlRNRbRxG4JCyIRa/mmobLfHNwNnYHw/h3DoPo5l1dUhunZREzlKwwzbUIMzjgV8ou2umaawSBJw8H3uxqHxkReyzwdDXSMZBMSIZ6yYKS8ZGRSv3PEvbRgE+r/ddUJL0jTOC3YBMl7pWf4Vl4dAeIyQs0KR5C/XRNHnbMIfmLeZatlE31A6cL4Nw38K0/MY1QbJv5eKS3eNdmGCIeU2T6YpmZKY7LMwhZUPwTLeO4VYgw3c2jmwfRzdT6qc8nw4icWfUdqWi1GxoyJVZYEL1OhZsujMcNHMjvHikggZ6qQf3vK917hkEos8+WF/59HyNBfiGu7kQMRiKeshDRUpKuHvPdwVhX0F0V/jfJebZvPQXslNsWgBiSO0evZ8fqA2wrKQyKmVPUS/nwqJzxM17SnOOOHip7ZqjEWSzbTVisacsD/a7nt2G+c42Ii1FjIwFfJVrP0Uw6uavm+gwM+/FTJDnyeSEB3isvkJhJ4J6isdRq5Bpr+BcKzFNUvTsoUHh3Bu2R/TUEM77+dm9OzxCnu0x0aWYJhlzL9ZEi3uTuBVBIG634Dc6lk26v/5zGG8c7czAIT78sSjW2ZgPn5qYg8B3kZGyjBTRijY89JvZQKdU9UC45/n6KQkxHsdsBrlcOxERKhrwpeamcoc6HN51wMZURZwMPhfC+i5E09d4gPngzecRdVMAXiR//gP/Vj8gmSMAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..efbb2ef --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE91dbZPbNpL+LzNfJ3MEwNd8y2W9W7668+bWyV7VTaVc8oh2uNFIs5LGji+V/34kQJCNZjcIvmjt8SePJaC7gQfobjxoUr9fHQ8fT1ff3v1+9Wu13159K2+u9puH8urbq/q/5W9XN1dPx139v4fD9mlXnv5Nf3r7y/lhV391v9ucTmXd/erqj5uhBNvnn0/lsaqbYVntv2/a771S07gT+/ap2m1fl/tztS93/133/fT9rqr/28l/97S/P1eH/VAD15VQfXP1uDk2UofjAGONikwk/Yh9Vp0/PRJjXtOYwcTvD9uSnfXmy4lAPu42e1Ze8+VUecfDh2pbHnmZbYOJcusmpxp/Vmz7/VSpT29P98fq8ewVDRp55QuZ98umer+v9u/tWkALp+3ebj2yrX/JmJ0MV23c674/7Pfl/fl/qvMvjWgARqjea0qExxJaFLAvERKadzofn+7Ph3mGgc69SefT9pvq9E29us613eV2uokikr1DOsE9PN1K3H3J1JF2/fjbfKN03yUWpUmi0s6kN28aN7jEnNtOxGSrbsGgmClzPOZ8625bOUtMtAO9+FRqY9u/vxHrWG0mgJnkY/m+Op3neJoR22+B5LUG8Zlg6IZiP5Hrj6mfLgaop8ft5lz+qTxvqt1p/SFi8c8dMmc89uP0Ari5E+cF7/V5c366GHad9K8DOjMc+2l+MeTaaePCtkkh315gmFD0c4esG4v9KL4AXv2EMWA5R6IFY2vlPI+EQR/1LBDRStOuZ4CZ5ftjWW+b9U2/7QSvNYLPBUI7ku6DtfI4oMVO1r8o3qDxQfGrZamfFTF3RN0XxQWQCwk7u2r/66uVjj9opED0s0fNjqX7SF0Ar27CuL22vyBajvBnj1c/mu7D7BI7bD+G2appHRpkJ/vr8IxgON2nyQVAG8/uMEG9ZIy9rGeS5Vny3TIQq60tOxP/An5oOIiO9Vhvr7g6Pgs0YFTdh2tRRkhbIG10oXF2wr8a5MyIug/WOsZi1NqJY+8K3CuzBUPsRT0PP2dvAy0AazF2dh64GT9vjtMv+ULsv7WiVxzFZ4TDDKf7/1rnI1dPO2f/KiJ8OEhHxWqh6QtADw3MfqMuM8Qwbrzcby8zWCP4K0GuHkz3v7XOTAitZr785yW33GLJ+Fx5zyQ2wXISu3PWYhycGeGY183+vtxdbii3nYK1R/S5QWpH1n2wWlox1GYnkcFws9sd7lfKyJmxAhVfHY52bN1Ha2XoFJLdRDLlWs3l1N9mn49R7yV1PQOrflqWI1EiLmDf3PsJQsKq1r2ezw7i7qvZ1VBl38+8eXP6rmrRMhwJCata95+zeXnUe905W3BfMOi/qmUL1j3uvp5dLXMy388SEla37qeZLNug/2qWtbn967nEhtN7basWhidGytpWvph3MAV917MIZCffzz0FUDIuYuF383NcWsqiKmxY2+82Yswb2uU3YaSaP1zNdd/DO2JuqBNr9WkD5hbps/M/uTrfcz4IKsvnLFH97Pz7Zr/9WG3Pv3Q2fNgcq83b/qmqrsU3YtoS8B6IxrRcd+19I+ytZ1Zeub+H6UWg1tuuW5Dy4VnQsWFbzrKh67aGDe+Oh4f/eP3XV5OtAB3XsON8mGVF120NG1DZXqgNQUV5U/D4oU4pqs1uFiR937nWJKnHB1T7Oj18t7kf2jLNBaDrit1hsw3Vcd01n+oAHKXbw8f9JLWgw1TFILy658By//TQOXVTzT1tGnusXv/43Y8/vX7z06vXP7z4/uWfX77405iWa7KLN24MKvIG+r/7/seXf38RqrprvVDry1dG0psfXrz608tXfwnVT/RbyZKpFizQ/NOrv734/q9/efXyfwMwR40n6QTZwfeHas/6p+bLi+YEQEFYOqDNnZcJDHWFJQFNv2Xxn9AcFPoDNI9GfUJ3YMAP0D4S6wndQWE+QPNIhCc0BwX3wBkfi+vMpIeFdMYGEM2dPTuIdrr//Bi+LfeHhwDp17bhhO3q3g49HJ7AwdSjqWs5QRVwcT9s3pd/K//5VJ7OLGKgzUUd3lBPmN+DY5jn/ljNYV4QdF/mDHk7gnxiuB2jrpG3JNBDhtsy4ih5S4L8ZbgdI26TtyPIe07DZsyJ+uEJ86V+i4BLpXzEwCNBafMd7K/lp3AV16b1dNfgqDy8e3cqJwzsuuuwUPGueqim6LXtF6q9b+LFj4czWF3jup1OCw04lh/K46mcoL3vMV01iHWvfK63+fKi0Q0oCAtr6LmVKfFsqCsskIEncmZGMEJzUOgK0DwaswjdgcEqQPtIlCJ0B4WnAM0jcYnQHBSQAmd8LBIxkx4WghgbQOxx9uzAU7yiX5cVGm022+2xPJ0C5F/3TSdsWUfZ++r95u2nc/nDsaoVhOgc9Jir+pdDretTuGLUfq7aY/lwOJc/HT2BptcJG89VWO039+fqQ/mdJ6z2Gp3Wc1WeXKrTo+4UUtoyripsbKDtBHXwXAhfoTDIPusvL3sS7BUEHgHd9xRMOvsNdAUe+siHMSed9oaaw45545rHz3dD3aEHu3HtYye6oe6wo9y45rEz3FBz2OEtbMZHT230pAce12gb4DkN7tlhVk2/CjI0VlaeO6RO9HU1dnGENir5YO93Y2G51zfsMlf59um4cZ5q8GgFbeeqs7E9aJSw8fzJ9Ud/OKcBcd+naiwm9qqCYuK4Kl9MxMpGYyJSB2MifvB8sL/bBpeNja6SwPg4fLp7UowkdQbGSfZx3kmxkrYgLF6GWTAeM2kbQuNmmBVjsZO2ISx+hlkwFkNpC8LiaDgSo7GUByMwnvK2wJiK9/zQwfCvQ17tHOroCDyLElvefatq80+gxrbtEnX1d/tzdfbRu45K0H6J2o/l21N1Dh5o33yJ0m05fEhyRLHbZYny0ejr6A2LwEEqvVGYUDoeiYdqFXytu/tyBOwg2u8vGotdHWGh+PXgDQRTIjGpMSwQv+YeXp4Sh2n9QWE4TP9oFKYtCAzCYTaMxGDagqAQHKZ/JALT+sPemhiMwVj85WEIC7+8JSD64j0+8CtWymXOtVD6+NF2uLHZR+dfhioddFpgQPNI4ujR2tHu9ligejTBcdSG5TcjKt+OV/U6SmH7BWrHaQRHayCTMKI0hPd213Io9T22pkdyDXctBz3bGaIweJyBicZQKcwzqFdeDLwhaHTZjGOoKDDtoN8rMSn3YHUHJiDeFwhMykJ4S8JSkXBLxvMR3pbQpCTcmrHMhLclLD0Jt2QsR+EtCUtUpiE0mq34QQpMWfw2wbyF8hlDV+X/WaJVMhisIiCNCXgBzeHj3keJDLXaDksVOz8FE6A35CdfAtRqSnyKXtthqeJt+Xg4+arEhqr7LotH7b1PIgYd8Lr8oDF7i6ypEY8XW4coLn97rI4egmqoueuxVPW7YzlpfbXtl6odzd8GisOSuGDV3kyOUT6eztHqY1HEKuotcEqL2B/iu/a+YMP5UT8yffyv03v7wokf64ABq2H6IOVoHfbwB4cgG5x3JIQbQnVbzRrz6NVUY5xeK9jSva0k3BDcZZYV4MczqxPA/IVOpf/69h/wlQHDX8/UtrAdV7HIAX+yWWzvFW0za2GmacPOq1jWLY7JZpE9Z9kEc9GxpQX8LueGFtvjeP4z2mdzDLjuhYwbwkniDPyw2T2R0TjcPCtiFeMQmuPb0mPyurtyLq5+KyaDy8/IUoRHDJ0Gc4iZJNYeNzdq+0pebhnSjBEzgSamYx2cOTPnwOw1EqHsDxkes9eLGHPx5S2YDC49C0uR9Rg4DdYx80AecCrPT4/NueHFb+dy79xgMfF/2GNx3Kf1czO1XHcQTzOi08/XOIi4wwtk0ydacjvCrPMGeX9qt/mOPHRPsOnWCpll2cTX9y4xsXtB70Jb2wH7pvTPhyNXAj3Z7F7Wlz7BraV2nvmfZJoyz3b4F9jeUI/nJxW+mAkGP3e1xtSyZOvmuHlY7BU6KV/wpBob7aTyv2EQOKntkEl6x/woEuB0GU7HtpsV+DCv6PggzCs+duXoQe7lkS1GrzMS8yrncdpK68Ttw4bq1T+NxbNWzGbxvLbYlzSH24F6rDEf3QuZJ8wG7rOCHRMYTWvGPEYTWYGZMLPeAmkwbQnTbRVrZjCGvU3LztIjltmVONkqquM6c9WtyukzRXZdxaqpzGpv1IJzMrIJndw9S5yIjq4jXmzL1DP7iPrgAzsvZ/Zpfcy0sKN6kGErMGxUKPtsaK7DsI1JW4zsGgzbBCMRyl4X67F6NQ87F13WgMnIklOwFFXevGmIjhiH96w/PPlW4XrRafZ+5U2YvlvpiVi8Vz0mTtypYwYuZcIHCexnw3UFJtwrajGqi5nwUPMwE96cdEOYcC1/2GNxnkbr52Zque6gIroRnf5iOgcRd3jzuRufJaFMOCFjbHK8nFeATbdWyCzLllNewSaGM+F+W9sB+6a0oW/Nw5OrWO6I+9KnuTc2nBIPmXAwCRfY6lBVANH82ad5CiseMLuz6VstaBp9i/QN6Fv8xP+AwnWeZQbNR9R6n2aeVCbaWTC3VHTUFnPCmmaJ02e2HQvLIjuDFpZGBlhmxjvLrmHX2VYtLPWjltIqdk1Oo0MMCc+kR6TNT6aDzAzMp8ONJEmrORivuPKWIMyYMQtfYjLWQJczcTq2XgMHh6W2Y9CBySqhe67iU3h7fPO3ni3kG+IW2HANZARCOJyCBflVoHXBBy5eXuhk+g9g0+y9hUIXW75COjvX/Alnh+BxgMn5F6xvrDQkUf+SIelPHAEH6OmYzK/LmTygsBqdLxMMp3ZnzRW1tI6nEzfxMDiEHx8IX6OX0ODz4Am+caJv7Nd78r1youFYm19cHj9/Wd2oR9jYx2yY+MwgsGX+Y4NjNr3YbydZ0refq39QhdDMc+CpzxpCd1zLojnP6TmWLXwoaNzCGoU5dqFuc63Bd0wsgISDxBtsDXumHpxGbQg+NvkkzT40jZsXdmQKNG6Np+E4V/WZ0V3psbgQiWugvcrDcRONRehzjsVv+Ep+ZQHSlAVz8MXjXwFV0rTJWPKGYcKjzZhC+A4rn+y3RnRgbfFM2Vp2uG/H4F98GKT/uhcQBtlg5PPPFEGGhfIbrLCwCfQe3KYYegsELrN4+aFtlt3hhEbgAPoZGYHgz4fjd/f33O+ZLhqUI/pZwtKPIPyBmKkAgVkah6qp1brEKFu5zxWkV/0TR9+Icd5jBkSvPA+HgWZjr5ZbOlAk/7niRbyr7xsxThzOwC3oZVdgJ+52h3v2FbGLfQmU/lyx6wdhkSsu4hP7ubpwFoaUB/CmXyY4Uyj4iYDMp98nDSSQe//Cpn8q6x469wspdyttGuM+BHxAuFMhbsC6D94OOC1y0V4bPWC72d+XuwC+GdqC+wXOSog9rccKqMvCFqGei2waPOapRxvK70LDmO6rWmdHPts+SsAiC/EjhPz0UX6DXGqr2TaZ0gozJ5zaGpU3n+IKNDWQ6ppiKELcuyQDLF99RS5FnTVoNu7kFK2FPG/uPOxHjB0QnqB7EOsJ1fESVvNJfvvG5nd929hfUVnBpmskbwLw9DQtyAhnWBzMoo7Lnjr5/px8/lhusZJVR7ZC4r7W0Lp0PoDwmzVINJMhmAZStWtNwRT69tniPGR4RQCdsQLiAbQvaj7K/a44J2F88HNGHVLGMuDQvg7kXhoZtR17W96asxH0uqtnjTd8C58MIMjWwdv3mr5LJkuUPSHU1HNFGDzwGHCFuhxbDtNN2P3BglFvJtwhPCc0N4NrhYs55c3o1ULf4mKJtKviqwRywjP1i5HkH9rYfDo8nS8GYy/+K4KwHdSE+7158NnJ80N3+WMPpejrg5M46lzMxQ5ndBTjSx5vBlq+SnSdKpiL+Vw0l15cLzvmrxHHCXVmS+BbcKG/aIhh9/vPCzZ4+3+xw8fSYgAocmJFgHPs+fnG/Izf1be/X30oj5pV//ZK3qrbJkt4V5W7bS3ozphWiz48PDTifm6/+3t5fz4cmxamyb9FVzd30U2S3Io8//nnmzvbQ3+hP9DN6kB1J6hmwmkm6/9Jqpl0mtW+8U5RzZTTLK7/F1PNYqdZjfldQjVLnGZp/b+UapY6zeqNf5dRzTKnWV7/L6ea5U6zGpS7gmpWuNPbzLYgcRAICI1EDUV0G6GGLhSimXIhqYYuGE2kuhMkHMLFQzTzLuIbkd0mWeq2dCFpSIA7kdyo4jYqYreli4pIeZkuMKIBQKTUgFxoRM6LdNFpqOY7kVEiXXxkxIqULj5S45MTIiXaKpIX6QIkNUAFJdLFR/L4SBcf2YAgIwof6eIjeXyki49sUJDiRqW3mXIbuvhIHh/p4iMLdjJdfBSPj3LxUQ0KkvRRygVI8QAp5M4aGCTt0FyEFI+QchFSCQe6cgFSPEDKBUhpgOKbOLpNZOK2dBFSPELKRUgV3KZULkIxj1DsIhRrhEiHHrsIxTxCsYtQrBFKqaHHKObwCMUuQrHeQ2SoiF2IYh6i2IUozjiHFLsIxTxCsYtQ3OAgyVAVuxAlPESJC1GiISqo6UxciBIeosSFKNFJARkCExeihIcoQZlBg4Mi85bEhSjhIUpciJIGCEU6kMTFKGmAUKRbSFyMkgYIRaY6iYtR2gChyM2RuhilDRCKTnhcjNIGCEUu5NTFKNUYkWspdTFKGyAUmfmkLkZpA0RM4p6iBK4BIibRTF2M0gaImMQodTFKGyBiEqPUxShtgIhJjFIXo6wBIiYxylyMsgaImMQoczHKGiBiOi91McoaIGISo8zFKNP5NYlR5mKUJVzSmbkQZSmXdGYoy25gSKKbuE4WhOtBMhehjPd0mYtQ1sCQ1AlIdpvH0m3pIpQ3MCSSapm7COUNDIkiW7oI5Q0MSUy2dBHKFZco5S5AeYNCkpAiXYDyhJ3O3EUob3BIyCWXuxDlGiJyyeXoLNTgkORUOMhdiHINEbnkcheiosEhJd1C4UJUNDikpFsoXIiKBoeUdAuFC1HRAJGSbqFwMSoaINKYWPGFC1GRsOu4cCEqUnYdFy5ERcau48KFqMjZdVygE2vBruMCH1ojbiGbr2BTwS5l8x1sK7kpNV/BphqnhGyKzq6RBopc+OY72LYBJCXPhRE6vkae82uEDrBRxgJrvoNtcxZa8x1sW7Dgmu9AW00n0PCKAdUgWHwx2aA5BQZfzDdoVoGeXUw4aFohJYOZwJSDJhZS0rcITDpoaiGj+RZMO2h2IaPJL8w8aH4hIz2MwNyDIR9ojgTRD8LDPwhEQAjNMzCrTGKOSPKrDLEQQpMNzCpDRITQdAOzyhAVIQwXQa4yxEUIzTgwqwyxEUKTDsz0IkJCaNohU1T4FIiSEJp5yMg8UCBWQmjuISMzQYF4CaHZh4z2T4iZEJp/yMgdpDC5p9jYLBA5ITQFkdVt5a0ocFuEmuIZJIEYCuGhKATiKITy+EjEUgjl8ZGIpxDK4yMRVSFij49EZIWIeR+J2AoRe3wk4iuEISzo6Y0xK6thK8jVizgLoZmJnHZ8iLUQmpvISaoZ0RZCsxM57fcQcyE0P5HTfDPiLoRmKJjVi9gLoTkKZvUi/kIYAoOkwgRiMISHwhCIwxCaqWBWL2IxhOYqmNWbYDo94VcvYjKE5iuY1Yu4DJGwnK1AZIbQlAWzehGdITRpwU0vgk3TFozvRZSG0MRFTvteRGoITV3ktO9FtIbQ5EVO+15EbAhNX+TksUggakNoAoNZvim+B0n55YvoDaFJDJrOFIjgEKnnNgRRHCLlT9ACkRwi48/QAtEcIuNP0QIRHSLjz9ECUR0iY0/SAnEdIuPP0gKxHUKTGsz0IsJDaF6Dcb4ZvsDSXpLOZhHrITS3kdPZLOI9hGY3mC2EmA9hqA+SKRCI+xCa4aADACI/RM5nJIj9ELknI0EEiMg9GQmiQIQmOmhSWiASROSejATRICL3ZCSICBG5JyNBVIjIPRkJIkNE4clIEB0iCj4jQXyIKDwZCWJEhOY9mOlFnIgoPBkJokWEJj8KOiNBxIjQ9AeT0yNqRGgCpKCPbYgcEZoCKej0BdEjQpMgTGaGCBKpWRCSnpCIIJGaBCnIrEgigkRqFqQgw6BEDImM+N0mEUUiI363SUSRyIi/4ZeII5GaBynoaUB3yJoGKaj7RIkYEqlZkIJyORIRJFKTIAV5j4z4Eak5kIK8bEf0iDSlGFFEtkWQmWqMiPKlEvEj0hRkRBSLLhFBIk1JRqTItggyU5QR1V5E3NbjRo0RZqYuI0roxgg1U5oRkbAhikSa6gzOCgSc4Ug4KxB0hiSJyBWBqzRMmQZjxaBSQ3qswMUaplojIhcbrtcwBRucFQg+mfisQPCZso2IzB8kLtwwVAldfiRx8Yap3qA3Pi7fMPUbTI0LQs+UcAjSYUtElkhNiDCCEVkiTR2HoMvSEF0iNSXCCUbomWIOeiYQXSIVz/5LRJdIQ5eIOp+La6Alaoyw05wIJxhBZ8o66saUg0eEiVR8nJOIMJGmuEOQhy2JGBOpaRHabyPGRJoCD0EezCSiTKSmRYQgT2YScSZS8yJ0RECUiYzN5SeZtkvEmUhT6kH7eUSaSFPsIeg9ilgTaQo+JL1HEW0i44KPIIg2kabqQ9L7DvEmMvG5TUScyMTnNhFzIhPFO2/EnMjE5zYRdSITn9tE3Ik0ZSB0eZhE5IlMMp8ZCL8k95mB8NMciaAryiQiUGQaecxADIpMhccMRKHIVPKhDFEoMlU+KxCAaeyzAgGoiRIh6XQXsSgyNQDSngjRKNLQKLSLQzSK9NAoEtEoMjXw0W4L8Sgy85SWIh5Faq5E0DVnEhEpMvMUmCIiRWY83SwRkyIzT5UpYlJkWzhCRxxEpUhNl9CsoURUitR0CX2kQEyKNAUkdAWcRFSK1HQJnf4jJkXmxnHS7htRKTI3+47M0xGXInPp2UqITZG58mwlRKdITZkIushOIj5F5r7jAiJUZO47LiBGRWrWRNB1eRJRKlLTJoIuuJOIU5E5TzxLxKnIwrPxEKciNXEi6Fo+iVgVWXg2HmJVpGFVaIMRqyILz8ZDrIo01SZMDoloFVl4arwRrSKLzLOjEa8iNXdCE6kS8SpScyeCLoKUiFhRmj0haQKFiBUVGejIiKAQs6I0eyLoqkmFqBUVma1Hnf8VolZUZHYe6bkV4laU4VboOkuFyBVlClDobaoQvaKijN+mChEsKjIpCz3LqAw8KnxWIPTap11oKxDLogzLQpeSKkSzKOFxnQrxLEp4XKdCRItqn30hXadCTIsyTAtdqqoQ06I0mUJvEoWIFiX4055CRItqH4NhHnVA+An+pK4Qz6LaYhT6eQdEtCjJn9QV4llU+0gM6QIU4lmU5E/qCvEsqn0whvYBiGdRkj+qK0SzqPbpGNpfIJpFSQ94iGVRkvecCrEsysOyKPycTMuykHFB4UdlPCyLwg/LtCwLGRfU4HkZ/i5B4Sdm2kdmaM+JH5ppaRbac+IHZ9qyFNqz4GdnDM+S0PsfPz5jiJaE3v/4CRrlc52IaVGxz3UipkVpOkUktAdAXIuKfa4TcS0q9rlOxLUo80hNQvsLxLYow7YktA9AbIvSjAqzjhDbomLP7kNkizJkS0L7C0S2qNiz/RDZogzZQpdfK0S2qMSz/RDXogzXQldrK8S1qMTjOhHXogzXktA7CnEtKvG4TkS1qMSDHWJaVOLBDhEtyhAtdI25QkSLSjzYIZ5FGZ6FLklXiGdRqQc7RLMoQ7PQFewK8Swq9WCHaBZlaBa64F0hmkWlHuwQy6IMy0LXxyvEsqjUAx5iWZRhWVJ69yOaRaUe8BDLojJf3EM0i8o84CGWRWW+uNfSLPqZ/Q/l8VxuX5pn9+/uurci/H71pn2gX3Svgfj9qs4ov/39j5urOgE0/+bm3zq9Mv/K9t+2nWzbybadatuptp1q26m2nWrbxW27uG0Xt+3itl3ctkvadknbLmnbJW27rG1XHy2NvZE13FosrGphZTTlR+3grPV1umL+qNOL9g9l/0jsH5kdsp2TzE5KZmcls9NS2K8K+1XRfWWnQmT2j8JOmrB/KPtHYv+wja2pypraRJH2D/tVYr9KrJzEykls48Q2Tm3j1DZObePUNk5t40w3/qN/wUPzv2btbbbbY3k6wXWVKbCu7AJpauvMH1nBiWpf3A1lKdHLMmPhO+pX5IHlXfvkrm/jicc6O4NoHG/f2xhP9X4wr4/qO6YpGH0UM/3ebvbbj9X2/AvsmgCVWQtBbhd4zpnw9qnabU/1J9W+3P3zqTx+ut9VpWuU7AVLRsy9fmW+M/fAHLOgqG6Hypn1FDgVu/Sbx2i43vu9ft1+LyAGqGXc9LX9PlbnX07V+315dKCLIAK8hNP5+NS8ncTpC9abaDdIxq07/aKr8+G8caYtc0RkXN9jiZa6BP3srs+VnUG7e6xRwnqIpuy79XOZ3WG2V8Ht2m15r9+LBdYeWCJ5q6ywAiO7iW0YENafC+uYhXWKTd0Zp3R/eHDWSgKBso434iDblo+HU+UslgJY3VROcR3Be1f7znkGOqfcUtsePu53h83WmSzQM+cQ3j4dBz4ph2sj7mItB1O5H8AEBGStc7aBpXmmq4XJLgkbu4QNCMJ6dMHaXe6dscq81xhzrrv87bFq3kcEkAFBoCkoo/u9O5bO8IoY9uK8xrvj4eEfJ3dmE6Avb4df2EUa2UHb+No8gtFOjN1GmZ2znBtko/ZxczxX7n5PwCrOO49npQm7Y2zGJGzqIxJrns0eRMGN+H31fvP207l8PFb3pRtsYRInOdNtf6drDjdPzC2HXw5Px90nQjHcvIrbs5WzlrICauw8h52ZgtuD1bYJb2dngeVQf8pNXLXf3J+rD7WvdeyAO9+mrE3hMCek6QX6gwDDDvz0cHpvMxqzjw/tT8vAFAUmGYqDQMsy8ZmVBMOmMqkvK0mHHlaSABu+qTfxSKpdBStGgTlWbB6kxeyq/a/7WgpvUgFN8k6TeddZeeRkFVCU6BJ5buNomadzvev5gaZwoOwa0oLMq9Xe8iONYKYmbEhk/a6W+rQfnUAZwQnk4qSRpn/2fWt+9p23Ewq0OYmKuCwRSOZthMiw2S6QVMNyfvKYCPMp0Z1fua3xa+m4lxTsAiG45burHtyEJIO5p+B0WbycOAuQV1y8tO/ow51BEOBMtV0f9Zv/QfgCSf5Y1+PhQ+2KnYQZLH5utLZ7czap3CAC06GR3t2vf4LJBrnQWG/n3fsgioDYzYkI8eMQvJgdSi+p4WKadzc6LjyHLpwFYzQUwBxRKc+wjBzSFOi8FbukRmOJc6ZJuD3dyaFMEQl0XR4R3mAEo6Pw4FMLoYxQCfTxnv7jnhg6+ITdMr0kck5SOCdcyAmIhk2FEHCSlqpiDyRAJGFXAaGyhJzM2L05Glnhhog8G0KLIXGD54mCi6JhkRmmRfYcIdnEE8qkpgpKs8cTGXt2WkiUh2AmntH2ssjVlcHVxYX08FQBLtaO+4w8fsmRS00elBh1Ej2+YST1gEyXzH0gBCUecP46Ap1l0JBYarxQoOVipC/MGIEUuPA4LzMOBN0Chkl4ykw5xTgrga5b2HO26M7ilpuw/IWMLOVuSWPJhp5GFUE95/CAyY+u2UT9TynCpQ8XguQcV9PfukGHMAW+PfF1dnMgyDlK9iSt+707HHH+1jxpArpz/kh3tw7JMRqAxNLcTW9nVzoSgNthafZeglnmjgCwuli3dXj37lS6TDsEW3Dh4fAR0cMFTNELrtvj5n2NcZ2ynlydkDmIujXN7W37AnQIF3TS9o5K2nss1V2kZRwW9l348K4CTKBKOQi6ny6BPWGuyAaztme9+jb29zKgDJj8sjxqL2PgJlIFBXA5EV74zpnWIqE6VrzjwLsrPvuHvd2SGQtbrWpI0MODPusDm660b5EwO/KOkjoewlwo9dnt4ithqEy5vaX7Nb7FHPBcCTD4sNeAWgLlXmKAUsputrr3Ez1ssMf5pdV053wLMJ9f3w276fgIeDAtOFc+JEVzePXJ8izUOVrCLdyx9t3Vjl27WXfvbj8p2MXQaqHCJHSBLMVnBdDLGQY7yd75WBlUuIzBJPP7oRXgLmsYciR7y2X7mrXhqAbGpxy8lM3w5NXlsty26n+nAfp/eCSx12gys6mPvXNTXSVFxq3aY/lwOOMEL4MGsjzSsWx+y8GZkgzeBggOT3vPPLxihuwF61ida2rXzcBrDDPyjFsTI5fdMJqMSDj/5i4rOHds1wEPBZ1sF3fS7ja2g7YFW9kiGyX5adZK0FVcDCIImx7YruSmhVtOsSlTK8LdcrHDT44YzqUKMcRGjgxBC6FLO2LIuUt+nXRyBjlHDP2t5LYYkMAxiAKioiQXo6ykhqlwMAUzwmZubWc2A4eDYYO8/q16/ugTQfrdM6W1EE+OA50bG+6NEH90gWci9qpaC/IveHjBxtL4Rg4AmBYG75gVy9U0BSnV/j3vKcFEs1jhZQKzMDZgD7OfBPLbrfsRtsRN2LoxkXZFRl0RBuv+tI435lbVORmBmS7YnW1621tZpz/wL+w9OOr/5rH2kPVcO3LAymEzg1bO0/70WN5X76rSLe8ACLHVAEYEuleGl0a2BFLYWkaRdgUflmhl70XJXNq5Bu0q/PwSBv4KXrN1+WVXZVZYsXaRKFuloliyGmqiavjgZQKbzEAhw1I06O/ZM0jABoZOn99GQI5bv5BDfFleG/Z3YygsFVHs8cDpzwTSBAZA9mIFSxoSdPCeJwnBhqSgoJtRCbemz4dB0Q7AI2+zPnteF/ZyXtiaY2GLh4WtAha2AFewHofiQCMYpSwxKbuSZ1s9JbtiZ7tPZNJ90hUFW37XVtFKOxBpN5WyVyHKEv3KprjKkhKKvcWhz8WQ6lecr37aH8v7Qx2N/s/1b5BvYY+Pw0MTJDBY8pnNUeCtguWA2VIO7jTv1KZYUDgP/fQ4qNsDuybn3NmHze7J3SURZG5s8i7tIGRXG29ZKGkrzmXSfWIXl626lml32dYtnG6ZdAXilgwUnTe2n7D3Mh/Lt6fKBS6HZ0KaPPr55uqxeizrpVa3uvv5jz/+H8w/ArP2UAEA"; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..98a4377 --- /dev/null +++ b/docs/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/docs/classes/index.SentinelClient.html b/docs/classes/index.SentinelClient.html new file mode 100644 index 0000000..8a9a725 --- /dev/null +++ b/docs/classes/index.SentinelClient.html @@ -0,0 +1,40 @@ +SentinelClient | @sentinel-official/sentinel-js-sdk

Class SentinelClient

Hierarchy

  • StargateClient
    • SentinelClient

Constructors

constructor +

Properties

sentinelQuery +

Methods

broadcastTx +broadcastTxSync +disconnect +forceGetCometClient +forceGetQueryClient +getAccount +getAllBalances +getBalance +getBalanceStaked +getBlock +getChainId +getCometClient +getDelegation +getHeight +getQueryClient +getSequence +getTx +searchTx +connect +create +

Constructors

Protected constructor

  • new SentinelClient(tmClient, options?): SentinelClient

  • Parameters

    • tmClient: undefined | Tendermint34Client
    • options: StargateClientOptions = {}

    Returns SentinelClient

Properties

Readonly sentinelQuery

sentinelQuery: undefined | SentinelQueryClient

Methods

broadcastTx

  • broadcastTx(tx, timeoutMs?, pollIntervalMs?): Promise<DeliverTxResponse>

  • Broadcasts a signed transaction to the network and monitors its inclusion in a block.

    +

    If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), +an error is thrown.

    +

    If the transaction is not included in a block before the provided timeout, this errors with a TimeoutError.

    +

    If the transaction is included in a block, a DeliverTxResponse is returned. The caller then +usually needs to check for execution success or failure.

    +

    Parameters

    • tx: Uint8Array
    • Optional timeoutMs: number
    • Optional pollIntervalMs: number

    Returns Promise<DeliverTxResponse>

broadcastTxSync

  • broadcastTxSync(tx): Promise<string>

  • Broadcasts a signed transaction to the network without monitoring it.

    +

    If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), +an error is thrown.

    +

    If the transaction is broadcasted, a string containing the hash of the transaction is returned. The caller then +usually needs to check if the transaction was included in a block and was successful.

    +

    Parameters

    • tx: Uint8Array

    Returns Promise<string>

    Returns the hash of the transaction

    +

disconnect

  • disconnect(): void

  • Returns void

Protected forceGetCometClient

  • forceGetCometClient(): CometClient

  • Returns CometClient

Protected forceGetQueryClient

  • forceGetQueryClient(): QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

  • Returns QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

getAccount

  • getAccount(searchAddress): Promise<null | Account>

  • Parameters

    • searchAddress: string

    Returns Promise<null | Account>

getAllBalances

  • getAllBalances(address): Promise<readonly Coin[]>

  • Queries all balances for all denoms that belong to this address.

    +

    Uses the grpc queries (which iterates over the store internally), and we cannot get +proofs from such a method.

    +

    Parameters

    • address: string

    Returns Promise<readonly Coin[]>

getBalance

  • getBalance(address, searchDenom): Promise<Coin>

  • Parameters

    • address: string
    • searchDenom: string

    Returns Promise<Coin>

getBalanceStaked

  • getBalanceStaked(address): Promise<null | Coin>

  • Parameters

    • address: string

    Returns Promise<null | Coin>

getBlock

  • getBlock(height?): Promise<Block>

  • Parameters

    • Optional height: number

    Returns Promise<Block>

getChainId

  • getChainId(): Promise<string>

  • Returns Promise<string>

Protected getCometClient

  • getCometClient(): undefined | CometClient

  • Returns undefined | CometClient

getDelegation

  • getDelegation(delegatorAddress, validatorAddress): Promise<null | Coin>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string

    Returns Promise<null | Coin>

getHeight

  • getHeight(): Promise<number>

  • Returns Promise<number>

Protected getQueryClient

  • getQueryClient(): undefined | QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

  • Returns undefined | QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

getSequence

  • getSequence(address): Promise<SequenceResponse>

  • Parameters

    • address: string

    Returns Promise<SequenceResponse>

getTx

  • getTx(id): Promise<null | IndexedTx>

  • Parameters

    • id: string

    Returns Promise<null | IndexedTx>

searchTx

  • searchTx(query): Promise<IndexedTx[]>

  • Parameters

    • query: SearchTxQuery

    Returns Promise<IndexedTx[]>

Static connect

Static create

  • create(cometClient, options?): Promise<StargateClient>

  • Creates an instance from a manually created Comet client. +Use this to use Comet38Client or Tendermint37Client instead of Tendermint34Client.

    +

    Parameters

    • cometClient: CometClient
    • Optional options: StargateClientOptions

    Returns Promise<StargateClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/index.SigningSentinelClient.html b/docs/classes/index.SigningSentinelClient.html new file mode 100644 index 0000000..f08f642 --- /dev/null +++ b/docs/classes/index.SigningSentinelClient.html @@ -0,0 +1,97 @@ +SigningSentinelClient | @sentinel-official/sentinel-js-sdk

Class SigningSentinelClient

Hierarchy

  • SigningStargateClient
    • SigningSentinelClient

Constructors

constructor +

Properties

broadcastPollIntervalMs +broadcastTimeoutMs +registry +sentinelQuery +sentinelTx +

Methods

broadcastTx +broadcastTxSync +delegateTokens +disconnect +forceGetCometClient +forceGetQueryClient +getAccount +getAllBalances +getBalance +getBalanceStaked +getBlock +getChainId +getCometClient +getDelegation +getHeight +getQueryClient +getSequence +getTx +nodeRegister +nodeSubscribe +nodeUpdateDetails +nodeUpdateStatus +planCreate +planLinkNode +planSubscribe +planUnlinkNode +planUpdateStatus +providerRegister +providerUpdate +searchTx +sendIbcTokens +sendTokens +sessionEnd +sessionStart +sessionUpdateDetails +sign +signAndBroadcast +signAndBroadcastSync +simulate +subscriptionAllocate +subscriptionCancel +undelegateTokens +withdrawRewards +connect +connectWithSigner +create +createWithSigner +offline +

Constructors

Protected constructor

Properties

Readonly broadcastPollIntervalMs

broadcastPollIntervalMs: undefined | number

Readonly broadcastTimeoutMs

broadcastTimeoutMs: undefined | number

Readonly registry

registry: Registry

Readonly sentinelQuery

sentinelQuery: undefined | SentinelQueryClient

Readonly sentinelTx

sentinelTx: {
    node: {
        register: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>);
        subscribe: ((from, nodeAddress, gigabytes?, hours?, denom?, fee?, memo?) => Promise<DeliverTxResponse>);
        updateDetails: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>);
        updateStatus: ((from, status, fee?, memo?) => Promise<DeliverTxResponse>);
    };
    plan: {
        create: ((from, duration, gigabytes, prices, fee?, memo?) => Promise<DeliverTxResponse>);
        linkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>);
        subscribe: ((from, id, denom?, fee?, memo?) => Promise<DeliverTxResponse>);
        unlinkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>);
        updateStatus: ((from, id, status, fee?, memo?) => Promise<DeliverTxResponse>);
    };
    provider: {
        register: ((from, name, identity, website, description, fee?, memo?) => Promise<DeliverTxResponse>);
        update: ((from, name, identity, website, description, status, fee?, memo?) => Promise<DeliverTxResponse>);
    };
    session: {
        end: ((from, id, rating, fee?, memo?) => Promise<DeliverTxResponse>);
        start: ((from, id, address, fee?, memo?) => Promise<DeliverTxResponse>);
        updateDetails: ((from, proof, signature, fee?, memo?) => Promise<DeliverTxResponse>);
    };
    subscription: {
        allocate: ((from, id, address, bytes, fee?, memo?) => Promise<DeliverTxResponse>);
        cancel: ((from, id, fee?, memo?) => Promise<DeliverTxResponse>);
    };
} = ...

Type declaration

  • node: {
        register: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>);
        subscribe: ((from, nodeAddress, gigabytes?, hours?, denom?, fee?, memo?) => Promise<DeliverTxResponse>);
        updateDetails: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>);
        updateStatus: ((from, status, fee?, memo?) => Promise<DeliverTxResponse>);
    }
    • register: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • gigabytePrices: Coin[]
          • hourlyPrices: Coin[]
          • remoteUrl: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • subscribe: ((from, nodeAddress, gigabytes?, hours?, denom?, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, nodeAddress, gigabytes?, hours?, denom?, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • nodeAddress: string
          • gigabytes: Long = Long.ZERO
          • hours: Long = Long.ZERO
          • denom: string = "udvpn"
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • updateDetails: ((from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • gigabytePrices: Coin[]
          • hourlyPrices: Coin[]
          • remoteUrl: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • updateStatus: ((from, status, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, status, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • status: Status
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

  • plan: {
        create: ((from, duration, gigabytes, prices, fee?, memo?) => Promise<DeliverTxResponse>);
        linkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>);
        subscribe: ((from, id, denom?, fee?, memo?) => Promise<DeliverTxResponse>);
        unlinkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>);
        updateStatus: ((from, id, status, fee?, memo?) => Promise<DeliverTxResponse>);
    }
    • create: ((from, duration, gigabytes, prices, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, duration, gigabytes, prices, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • duration: undefined | Duration
          • gigabytes: Long
          • prices: Coin[]
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • linkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, nodeAddress, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • nodeAddress: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • subscribe: ((from, id, denom?, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, denom?, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • denom: string = "udvpn"
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • unlinkNode: ((from, id, nodeAddress, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, nodeAddress, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • nodeAddress: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • updateStatus: ((from, id, status, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, status, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • status: Status
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

  • provider: {
        register: ((from, name, identity, website, description, fee?, memo?) => Promise<DeliverTxResponse>);
        update: ((from, name, identity, website, description, status, fee?, memo?) => Promise<DeliverTxResponse>);
    }
    • register: ((from, name, identity, website, description, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, name, identity, website, description, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • name: string
          • identity: string
          • website: string
          • description: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • update: ((from, name, identity, website, description, status, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, name, identity, website, description, status, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • name: string
          • identity: string
          • website: string
          • description: string
          • status: Status
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

  • session: {
        end: ((from, id, rating, fee?, memo?) => Promise<DeliverTxResponse>);
        start: ((from, id, address, fee?, memo?) => Promise<DeliverTxResponse>);
        updateDetails: ((from, proof, signature, fee?, memo?) => Promise<DeliverTxResponse>);
    }
    • end: ((from, id, rating, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, rating, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • rating: Long
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • start: ((from, id, address, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, address, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • address: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • updateDetails: ((from, proof, signature, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, proof, signature, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • proof: undefined | Proof
          • signature: Uint8Array
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

  • subscription: {
        allocate: ((from, id, address, bytes, fee?, memo?) => Promise<DeliverTxResponse>);
        cancel: ((from, id, fee?, memo?) => Promise<DeliverTxResponse>);
    }
    • allocate: ((from, id, address, bytes, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, address, bytes, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • address: string
          • bytes: string
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

    • cancel: ((from, id, fee?, memo?) => Promise<DeliverTxResponse>)
        • (from, id, fee?, memo?): Promise<DeliverTxResponse>

        • Parameters

          • from: string
          • id: Long
          • fee: number | StdFee | "auto" = "auto"
          • memo: string = ""

          Returns Promise<DeliverTxResponse>

Methods

broadcastTx

  • broadcastTx(tx, timeoutMs?, pollIntervalMs?): Promise<DeliverTxResponse>

  • Broadcasts a signed transaction to the network and monitors its inclusion in a block.

    +

    If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), +an error is thrown.

    +

    If the transaction is not included in a block before the provided timeout, this errors with a TimeoutError.

    +

    If the transaction is included in a block, a DeliverTxResponse is returned. The caller then +usually needs to check for execution success or failure.

    +

    Parameters

    • tx: Uint8Array
    • Optional timeoutMs: number
    • Optional pollIntervalMs: number

    Returns Promise<DeliverTxResponse>

broadcastTxSync

  • broadcastTxSync(tx): Promise<string>

  • Broadcasts a signed transaction to the network without monitoring it.

    +

    If broadcasting is rejected by the node for some reason (e.g. because of a CheckTx failure), +an error is thrown.

    +

    If the transaction is broadcasted, a string containing the hash of the transaction is returned. The caller then +usually needs to check if the transaction was included in a block and was successful.

    +

    Parameters

    • tx: Uint8Array

    Returns Promise<string>

    Returns the hash of the transaction

    +

delegateTokens

  • delegateTokens(delegatorAddress, validatorAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • amount: Coin
    • fee: number | StdFee | "auto"
    • Optional memo: string

    Returns Promise<DeliverTxResponse>

disconnect

  • disconnect(): void

  • Returns void

Protected forceGetCometClient

  • forceGetCometClient(): CometClient

  • Returns CometClient

Protected forceGetQueryClient

  • forceGetQueryClient(): QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

  • Returns QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

getAccount

  • getAccount(searchAddress): Promise<null | Account>

  • Parameters

    • searchAddress: string

    Returns Promise<null | Account>

getAllBalances

  • getAllBalances(address): Promise<readonly Coin[]>

  • Queries all balances for all denoms that belong to this address.

    +

    Uses the grpc queries (which iterates over the store internally), and we cannot get +proofs from such a method.

    +

    Parameters

    • address: string

    Returns Promise<readonly Coin[]>

getBalance

  • getBalance(address, searchDenom): Promise<Coin>

  • Parameters

    • address: string
    • searchDenom: string

    Returns Promise<Coin>

getBalanceStaked

  • getBalanceStaked(address): Promise<null | Coin>

  • Parameters

    • address: string

    Returns Promise<null | Coin>

getBlock

  • getBlock(height?): Promise<Block>

  • Parameters

    • Optional height: number

    Returns Promise<Block>

getChainId

  • getChainId(): Promise<string>

  • Returns Promise<string>

Protected getCometClient

  • getCometClient(): undefined | CometClient

  • Returns undefined | CometClient

getDelegation

  • getDelegation(delegatorAddress, validatorAddress): Promise<null | Coin>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string

    Returns Promise<null | Coin>

getHeight

  • getHeight(): Promise<number>

  • Returns Promise<number>

Protected getQueryClient

  • getQueryClient(): undefined | QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

  • Returns undefined | QueryClient & AuthExtension & BankExtension & StakingExtension & TxExtension

getSequence

  • getSequence(address): Promise<SequenceResponse>

  • Parameters

    • address: string

    Returns Promise<SequenceResponse>

getTx

  • getTx(id): Promise<null | IndexedTx>

  • Parameters

    • id: string

    Returns Promise<null | IndexedTx>

nodeRegister

  • nodeRegister(from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • gigabytePrices: Coin[]
    • hourlyPrices: Coin[]
    • remoteUrl: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

nodeSubscribe

  • nodeSubscribe(from, nodeAddress, gigabytes?, hours?, denom?, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • nodeAddress: string
    • gigabytes: Long = Long.ZERO
    • hours: Long = Long.ZERO
    • denom: string = "udvpn"
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

nodeUpdateDetails

  • nodeUpdateDetails(from, gigabytePrices, hourlyPrices, remoteUrl, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • gigabytePrices: Coin[]
    • hourlyPrices: Coin[]
    • remoteUrl: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

nodeUpdateStatus

  • nodeUpdateStatus(from, status, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • status: Status
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

planCreate

  • planCreate(from, duration, gigabytes, prices, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • duration: undefined | Duration
    • gigabytes: Long
    • prices: Coin[]
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

planLinkNode

  • planLinkNode(from, id, nodeAddress, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • nodeAddress: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

planSubscribe

  • planSubscribe(from, id, denom?, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • denom: string = "udvpn"
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

planUnlinkNode

  • planUnlinkNode(from, id, nodeAddress, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • nodeAddress: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

planUpdateStatus

  • planUpdateStatus(from, id, status, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • status: Status
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

providerRegister

  • providerRegister(from, name, identity, website, description, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • name: string
    • identity: string
    • website: string
    • description: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

providerUpdate

  • providerUpdate(from, name, identity, website, description, status, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • name: string
    • identity: string
    • website: string
    • description: string
    • status: Status
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

searchTx

  • searchTx(query): Promise<IndexedTx[]>

  • Parameters

    • query: SearchTxQuery

    Returns Promise<IndexedTx[]>

sendIbcTokens

  • sendIbcTokens(senderAddress, recipientAddress, transferAmount, sourcePort, sourceChannel, timeoutHeight, timeoutTimestamp, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • senderAddress: string
    • recipientAddress: string
    • transferAmount: Coin
    • sourcePort: string
    • sourceChannel: string
    • timeoutHeight: undefined | Height
    • timeoutTimestamp: undefined | number

      timeout in seconds

      +
    • fee: number | StdFee | "auto"
    • Optional memo: string

    Returns Promise<DeliverTxResponse>

    Deprecated

    This API does not support setting the memo field of MsgTransfer (only the transaction memo). +We'll remove this method at some point because trying to wrap the various message types is a losing strategy. +Please migrate to signAndBroadcast with an MsgTransferEncodeObject created in the caller code instead.

    +

    See

    https://github.com/cosmos/cosmjs/issues/1493

    +

sendTokens

  • sendTokens(senderAddress, recipientAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • senderAddress: string
    • recipientAddress: string
    • amount: readonly Coin[]
    • fee: number | StdFee | "auto"
    • Optional memo: string

    Returns Promise<DeliverTxResponse>

sessionEnd

  • sessionEnd(from, id, rating, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • rating: Long
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

sessionStart

  • sessionStart(from, id, address, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • address: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

sessionUpdateDetails

  • sessionUpdateDetails(from, proof, signature, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • proof: undefined | Proof
    • signature: Uint8Array
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

sign

  • sign(signerAddress, messages, fee, memo, explicitSignerData?, timeoutHeight?): Promise<TxRaw>

  • Gets account number and sequence from the API, creates a sign doc, +creates a single signature and assembles the signed transaction.

    +

    The sign mode (SIGN_MODE_DIRECT or SIGN_MODE_LEGACY_AMINO_JSON) is determined by this client's signer.

    +

    You can pass signer data (account number, sequence and chain ID) explicitly instead of querying them +from the chain. This is needed when signing for a multisig account, but it also allows for offline signing +(See the SigningStargateClient.offline constructor).

    +

    Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: StdFee
    • memo: string
    • Optional explicitSignerData: SignerData
    • Optional timeoutHeight: bigint

    Returns Promise<TxRaw>

signAndBroadcast

  • signAndBroadcast(signerAddress, messages, fee, memo?, timeoutHeight?): Promise<DeliverTxResponse>

  • Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: number | StdFee | "auto"
    • Optional memo: string
    • Optional timeoutHeight: bigint

    Returns Promise<DeliverTxResponse>

signAndBroadcastSync

  • signAndBroadcastSync(signerAddress, messages, fee, memo?, timeoutHeight?): Promise<string>

  • This method is useful if you want to send a transaction in broadcast, +without waiting for it to be placed inside a block, because for example +I would like to receive the hash to later track the transaction with another tool.

    +

    Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • fee: number | StdFee | "auto"
    • Optional memo: string
    • Optional timeoutHeight: bigint

    Returns Promise<string>

    Returns the hash of the transaction

    +

simulate

  • simulate(signerAddress, messages, memo): Promise<number>

  • Parameters

    • signerAddress: string
    • messages: readonly EncodeObject[]
    • memo: undefined | string

    Returns Promise<number>

subscriptionAllocate

  • subscriptionAllocate(from, id, address, bytes, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • address: string
    • bytes: string
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

subscriptionCancel

  • subscriptionCancel(from, id, fee?, memo?): Promise<DeliverTxResponse>

  • Parameters

    • from: string
    • id: Long
    • fee: number | StdFee | "auto" = "auto"
    • memo: string = ""

    Returns Promise<DeliverTxResponse>

undelegateTokens

  • undelegateTokens(delegatorAddress, validatorAddress, amount, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • amount: Coin
    • fee: number | StdFee | "auto"
    • Optional memo: string

    Returns Promise<DeliverTxResponse>

withdrawRewards

  • withdrawRewards(delegatorAddress, validatorAddress, fee, memo?): Promise<DeliverTxResponse>

  • Parameters

    • delegatorAddress: string
    • validatorAddress: string
    • fee: number | StdFee | "auto"
    • Optional memo: string

    Returns Promise<DeliverTxResponse>

Static connect

  • connect(endpoint, options?): Promise<StargateClient>

  • Creates an instance by connecting to the given CometBFT RPC endpoint.

    +

    This uses auto-detection to decide between a CometBFT 0.38, Tendermint 0.37 and 0.34 client. +To set the Comet client explicitly, use create.

    +

    Parameters

    • endpoint: string | HttpEndpoint
    • Optional options: StargateClientOptions

    Returns Promise<StargateClient>

Static connectWithSigner

Static create

  • create(cometClient, options?): Promise<StargateClient>

  • Creates an instance from a manually created Comet client. +Use this to use Comet38Client or Tendermint37Client instead of Tendermint34Client.

    +

    Parameters

    • cometClient: CometClient
    • Optional options: StargateClientOptions

    Returns Promise<StargateClient>

Static createWithSigner

  • createWithSigner(cometClient, signer, options?): Promise<SigningStargateClient>

  • Creates an instance from a manually created Comet client. +Use this to use Comet38Client or Tendermint37Client instead of Tendermint34Client.

    +

    Parameters

    • cometClient: CometClient
    • signer: OfflineSigner
    • Optional options: SigningStargateClientOptions

    Returns Promise<SigningStargateClient>

Static offline

  • offline(signer, options?): Promise<SigningStargateClient>

  • Creates a client in offline mode.

    +

    This should only be used in niche cases where you know exactly what you're doing, +e.g. when building an offline signing application.

    +

    When you try to use online functionality with such a signer, an +exception will be raised.

    +

    Parameters

    • signer: OfflineSigner
    • Optional options: SigningStargateClientOptions

    Returns Promise<SigningStargateClient>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/index.Status.html b/docs/enums/index.Status.html new file mode 100644 index 0000000..678e629 --- /dev/null +++ b/docs/enums/index.Status.html @@ -0,0 +1,6 @@ +Status | @sentinel-official/sentinel-js-sdk

Enumeration Status

Enumeration Members

STATUS_ACTIVE +STATUS_INACTIVE +STATUS_INACTIVE_PENDING +STATUS_UNSPECIFIED +UNRECOGNIZED +

Enumeration Members

STATUS_ACTIVE

STATUS_ACTIVE: 1

STATUS_INACTIVE

STATUS_INACTIVE: 3

STATUS_INACTIVE_PENDING

STATUS_INACTIVE_PENDING: 2

STATUS_UNSPECIFIED

STATUS_UNSPECIFIED: 0

UNRECOGNIZED

UNRECOGNIZED: -1

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_node.isMsgRegisterEncodeObject.html b/docs/functions/modules_node.isMsgRegisterEncodeObject.html new file mode 100644 index 0000000..dbf79f8 --- /dev/null +++ b/docs/functions/modules_node.isMsgRegisterEncodeObject.html @@ -0,0 +1 @@ +isMsgRegisterEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgRegisterEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_node.isMsgSubscribeEncodeObject.html b/docs/functions/modules_node.isMsgSubscribeEncodeObject.html new file mode 100644 index 0000000..33225cf --- /dev/null +++ b/docs/functions/modules_node.isMsgSubscribeEncodeObject.html @@ -0,0 +1 @@ +isMsgSubscribeEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgSubscribeEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_node.isMsgUpdateDetailsEncodeObject.html b/docs/functions/modules_node.isMsgUpdateDetailsEncodeObject.html new file mode 100644 index 0000000..b51a643 --- /dev/null +++ b/docs/functions/modules_node.isMsgUpdateDetailsEncodeObject.html @@ -0,0 +1 @@ +isMsgUpdateDetailsEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUpdateDetailsEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_node.isMsgUpdateStatusEncodeObject.html b/docs/functions/modules_node.isMsgUpdateStatusEncodeObject.html new file mode 100644 index 0000000..319377f --- /dev/null +++ b/docs/functions/modules_node.isMsgUpdateStatusEncodeObject.html @@ -0,0 +1 @@ +isMsgUpdateStatusEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUpdateStatusEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_node.setupNodeExtension.html b/docs/functions/modules_node.setupNodeExtension.html new file mode 100644 index 0000000..1585af7 --- /dev/null +++ b/docs/functions/modules_node.setupNodeExtension.html @@ -0,0 +1 @@ +setupNodeExtension | @sentinel-official/sentinel-js-sdk

Function setupNodeExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.isMsgCreateEncodeObject.html b/docs/functions/modules_plan.isMsgCreateEncodeObject.html new file mode 100644 index 0000000..d036f7f --- /dev/null +++ b/docs/functions/modules_plan.isMsgCreateEncodeObject.html @@ -0,0 +1 @@ +isMsgCreateEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgCreateEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.isMsgLinkNodeEncodeObject.html b/docs/functions/modules_plan.isMsgLinkNodeEncodeObject.html new file mode 100644 index 0000000..6486dd6 --- /dev/null +++ b/docs/functions/modules_plan.isMsgLinkNodeEncodeObject.html @@ -0,0 +1 @@ +isMsgLinkNodeEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgLinkNodeEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.isMsgSubscribeEncodeObject.html b/docs/functions/modules_plan.isMsgSubscribeEncodeObject.html new file mode 100644 index 0000000..c053d70 --- /dev/null +++ b/docs/functions/modules_plan.isMsgSubscribeEncodeObject.html @@ -0,0 +1 @@ +isMsgSubscribeEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgSubscribeEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.isMsgUnlinkNodeEncodeObject.html b/docs/functions/modules_plan.isMsgUnlinkNodeEncodeObject.html new file mode 100644 index 0000000..f76d850 --- /dev/null +++ b/docs/functions/modules_plan.isMsgUnlinkNodeEncodeObject.html @@ -0,0 +1 @@ +isMsgUnlinkNodeEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUnlinkNodeEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.isMsgUpdateStatusEncodeObject.html b/docs/functions/modules_plan.isMsgUpdateStatusEncodeObject.html new file mode 100644 index 0000000..6022c3c --- /dev/null +++ b/docs/functions/modules_plan.isMsgUpdateStatusEncodeObject.html @@ -0,0 +1 @@ +isMsgUpdateStatusEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUpdateStatusEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_plan.setupPlanExtension.html b/docs/functions/modules_plan.setupPlanExtension.html new file mode 100644 index 0000000..26c91e5 --- /dev/null +++ b/docs/functions/modules_plan.setupPlanExtension.html @@ -0,0 +1 @@ +setupPlanExtension | @sentinel-official/sentinel-js-sdk

Function setupPlanExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_provider.isMsgRegisterEncodeObject.html b/docs/functions/modules_provider.isMsgRegisterEncodeObject.html new file mode 100644 index 0000000..25abcee --- /dev/null +++ b/docs/functions/modules_provider.isMsgRegisterEncodeObject.html @@ -0,0 +1 @@ +isMsgRegisterEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgRegisterEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_provider.isMsgUpdateEncodeObject.html b/docs/functions/modules_provider.isMsgUpdateEncodeObject.html new file mode 100644 index 0000000..e773f7b --- /dev/null +++ b/docs/functions/modules_provider.isMsgUpdateEncodeObject.html @@ -0,0 +1 @@ +isMsgUpdateEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUpdateEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_provider.setupProviderExtension.html b/docs/functions/modules_provider.setupProviderExtension.html new file mode 100644 index 0000000..b73a05e --- /dev/null +++ b/docs/functions/modules_provider.setupProviderExtension.html @@ -0,0 +1 @@ +setupProviderExtension | @sentinel-official/sentinel-js-sdk

Function setupProviderExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_queries.buildSentinelQueryClient.html b/docs/functions/modules_queries.buildSentinelQueryClient.html new file mode 100644 index 0000000..ec628ae --- /dev/null +++ b/docs/functions/modules_queries.buildSentinelQueryClient.html @@ -0,0 +1 @@ +buildSentinelQueryClient | @sentinel-official/sentinel-js-sdk

Function buildSentinelQueryClient

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_session.isMsgEndEncodeObject.html b/docs/functions/modules_session.isMsgEndEncodeObject.html new file mode 100644 index 0000000..9de96de --- /dev/null +++ b/docs/functions/modules_session.isMsgEndEncodeObject.html @@ -0,0 +1 @@ +isMsgEndEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgEndEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_session.isMsgStartEncodeObject.html b/docs/functions/modules_session.isMsgStartEncodeObject.html new file mode 100644 index 0000000..e82fa1c --- /dev/null +++ b/docs/functions/modules_session.isMsgStartEncodeObject.html @@ -0,0 +1 @@ +isMsgStartEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgStartEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_session.isMsgUpdateDetailsEncodeObject.html b/docs/functions/modules_session.isMsgUpdateDetailsEncodeObject.html new file mode 100644 index 0000000..c7ed9ce --- /dev/null +++ b/docs/functions/modules_session.isMsgUpdateDetailsEncodeObject.html @@ -0,0 +1 @@ +isMsgUpdateDetailsEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgUpdateDetailsEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_session.setupSessionExtension.html b/docs/functions/modules_session.setupSessionExtension.html new file mode 100644 index 0000000..701080e --- /dev/null +++ b/docs/functions/modules_session.setupSessionExtension.html @@ -0,0 +1 @@ +setupSessionExtension | @sentinel-official/sentinel-js-sdk

Function setupSessionExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_subscription.isMsgAllocateEncodeObject.html b/docs/functions/modules_subscription.isMsgAllocateEncodeObject.html new file mode 100644 index 0000000..09e894c --- /dev/null +++ b/docs/functions/modules_subscription.isMsgAllocateEncodeObject.html @@ -0,0 +1 @@ +isMsgAllocateEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgAllocateEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_subscription.isMsgCancelEncodeObject.html b/docs/functions/modules_subscription.isMsgCancelEncodeObject.html new file mode 100644 index 0000000..aebcd61 --- /dev/null +++ b/docs/functions/modules_subscription.isMsgCancelEncodeObject.html @@ -0,0 +1 @@ +isMsgCancelEncodeObject | @sentinel-official/sentinel-js-sdk

Function isMsgCancelEncodeObject

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/modules_subscription.setupSubscriptionExtension.html b/docs/functions/modules_subscription.setupSubscriptionExtension.html new file mode 100644 index 0000000..76ae30e --- /dev/null +++ b/docs/functions/modules_subscription.setupSubscriptionExtension.html @@ -0,0 +1 @@ +setupSubscriptionExtension | @sentinel-official/sentinel-js-sdk

Function setupSubscriptionExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..0300613 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,26 @@ +@sentinel-official/sentinel-js-sdk

@sentinel-official/sentinel-js-sdk

sentinel-js-sdk

The Sentinel JS SDK relays on CosmJS and it was developed following the official tutorial, it take also inspiration from other open source Cosmos SDK.

+

The SDK exstends the followings:

+ +

clients

import { SentinelClient } from "@sentinel-official/sentinel-js-sdk";

const rpc = "https://rpc.sentinel.co:443"
const client = await SentinelClient.connect(rpc)
+
+

If you need to sign and broadcasting a tx you need to a SigningClient.

+
import { SigningSentinelClient } from "@sentinel-official/sentinel-js-sdk";
import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing"
import { GasPrice } from "@cosmjs/stargate"

const wallet = await DirectSecp256k1HdWallet.fromMnemonic(mnemonic, { prefix: "sent" });
const [account] = await wallet.getAccounts();

const rpc = "https://rpc.sentinel.co:443"

# With a default GasPrice:
const customDenom = "udvpn"
const gasPrice = GasPrice.fromString(`0.2${customDenom}`);
const client = await SigningSentinelClient.connectWithSigner(rpc, wallet, {
    gasPrice: gasPrice
})

# Without a default GasPrice
const client = await SigningSentinelClient.connectWithSigner(rpc, wallet)
+
+

You can also set other default parameters: https://cosmos.github.io/cosmjs/latest/stargate/interfaces/SigningStargateClientOptions.html.

+

protobuf

All the .proto files are compiled using protoc and ts-proto as plugin. The compile .ts proto files are under src/protobuf. If you want to compile again you can use scripts/generate-proto.sh. The script require git and protoc it will automatically download all the .proto definitions from sentinel-hub and relative third parties.

+

examples

The official cosmjs examples can be used as well. +Just remember to replace StargateClient with SentinelClient and SigningStargateClient with SigningSentinelClient.

+

The repository provide currently a nodejs script example and a keplr one (based on: https://tutorials.cosmos.network/tutorials/7-cosmjs/4-with-keplr.html).

+

If you want to use a local version of sdk (for testing purpose) you had to compile the src folder into dist and then link the package with npm.

+
npm run build
npm link
cd examples/<choose-an-example>
npm link @sentinel-official/sentinel-js-sdk
+
+

run keplr example

cd examples/keplr
npm i
npm i @sentinel-official/sentinel-js-sdk
npm run dev
+
+

Navigate to: http://127.0.0.1:3000/.

+

run nodejs example

cd examples/node
npm i
npm i @sentinel-official/sentinel-js-sdk
npm i ts-node
ts-node main.ts
+
+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Bandwidth.html b/docs/interfaces/index.Bandwidth.html new file mode 100644 index 0000000..7161512 --- /dev/null +++ b/docs/interfaces/index.Bandwidth.html @@ -0,0 +1,3 @@ +Bandwidth | @sentinel-official/sentinel-js-sdk

Interface Bandwidth

interface Bandwidth {
    download: string;
    upload: string;
}

Properties

download +upload +

Properties

download

download: string

upload

upload: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Coin.html b/docs/interfaces/index.Coin.html new file mode 100644 index 0000000..c27fea1 --- /dev/null +++ b/docs/interfaces/index.Coin.html @@ -0,0 +1,6 @@ +Coin | @sentinel-official/sentinel-js-sdk

Interface Coin

Coin defines a token with a denomination and an amount.

+

NOTE: The amount field is an Int which implements the custom method +signatures required by gogoproto.

+
interface Coin {
    amount: string;
    denom: string;
}

Properties

amount +denom +

Properties

amount

amount: string

denom

denom: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Node.html b/docs/interfaces/index.Node.html new file mode 100644 index 0000000..5db5c07 --- /dev/null +++ b/docs/interfaces/index.Node.html @@ -0,0 +1,8 @@ +Node | @sentinel-official/sentinel-js-sdk

Interface Node

interface Node {
    address: string;
    gigabytePrices: Coin[];
    hourlyPrices: Coin[];
    inactiveAt?: Date;
    remoteUrl: string;
    status: Status;
    statusAt?: Date;
}

Properties

address +gigabytePrices +hourlyPrices +inactiveAt? +remoteUrl +status +statusAt? +

Properties

address

address: string

gigabytePrices

gigabytePrices: Coin[]

hourlyPrices

hourlyPrices: Coin[]

Optional inactiveAt

inactiveAt?: Date

remoteUrl

remoteUrl: string

status

status: Status

Optional statusAt

statusAt?: Date

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.PageRequest.html b/docs/interfaces/index.PageRequest.html new file mode 100644 index 0000000..d841c5f --- /dev/null +++ b/docs/interfaces/index.PageRequest.html @@ -0,0 +1,26 @@ +PageRequest | @sentinel-official/sentinel-js-sdk

Interface PageRequest

PageRequest is to be embedded in gRPC request messages for efficient +pagination. Ex:

+

message SomeRequest { + Foo some_parameter = 1; + PageRequest pagination = 2; + }

+
interface PageRequest {
    countTotal: boolean;
    key: Uint8Array;
    limit: Long;
    offset: Long;
    reverse: boolean;
}

Properties

countTotal +key +limit +offset +reverse +

Properties

countTotal

countTotal: boolean

count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

+

key

key: Uint8Array

key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

+

limit

limit: Long

limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

+

offset

offset: Long

offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

+

reverse

reverse: boolean

reverse is set to true if results are to be returned in the descending order.

+

Since: cosmos-sdk 0.43

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Plan.html b/docs/interfaces/index.Plan.html new file mode 100644 index 0000000..ae96e20 --- /dev/null +++ b/docs/interfaces/index.Plan.html @@ -0,0 +1,8 @@ +Plan | @sentinel-official/sentinel-js-sdk

Interface Plan

interface Plan {
    duration?: Duration;
    gigabytes: Long;
    id: Long;
    prices: Coin[];
    providerAddress: string;
    status: Status;
    statusAt?: Date;
}

Properties

duration? +gigabytes +id +prices +providerAddress +status +statusAt? +

Properties

Optional duration

duration?: Duration

gigabytes

gigabytes: Long

id

id: Long

prices

prices: Coin[]

providerAddress

providerAddress: string

status

status: Status

Optional statusAt

statusAt?: Date

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Provider.html b/docs/interfaces/index.Provider.html new file mode 100644 index 0000000..b631f95 --- /dev/null +++ b/docs/interfaces/index.Provider.html @@ -0,0 +1,8 @@ +Provider | @sentinel-official/sentinel-js-sdk

Interface Provider

interface Provider {
    address: string;
    description: string;
    identity: string;
    name: string;
    status: Status;
    statusAt?: Date;
    website: string;
}

Properties

address +description +identity +name +status +statusAt? +website +

Properties

address

address: string

description

description: string

identity

identity: string

name

name: string

status

status: Status

Optional statusAt

statusAt?: Date

website

website: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Session.html b/docs/interfaces/index.Session.html new file mode 100644 index 0000000..673effa --- /dev/null +++ b/docs/interfaces/index.Session.html @@ -0,0 +1,10 @@ +Session | @sentinel-official/sentinel-js-sdk

Interface Session

interface Session {
    address: string;
    bandwidth?: Bandwidth;
    duration?: Duration;
    id: Long;
    inactiveAt?: Date;
    nodeAddress: string;
    status: Status;
    statusAt?: Date;
    subscriptionId: Long;
}

Properties

address +bandwidth? +duration? +id +inactiveAt? +nodeAddress +status +statusAt? +subscriptionId +

Properties

address

address: string

Optional bandwidth

bandwidth?: Bandwidth

Optional duration

duration?: Duration

id

id: Long

Optional inactiveAt

inactiveAt?: Date

nodeAddress

nodeAddress: string

status

status: Status

Optional statusAt

statusAt?: Date

subscriptionId

subscriptionId: Long

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/index.Subscription.html b/docs/interfaces/index.Subscription.html new file mode 100644 index 0000000..85ca94d --- /dev/null +++ b/docs/interfaces/index.Subscription.html @@ -0,0 +1,12 @@ +Subscription | @sentinel-official/sentinel-js-sdk

Interface Subscription

interface Subscription {
    denom: string;
    deposit?: Coin;
    expiry?: Date;
    free: string;
    id: Long;
    node: string;
    owner: string;
    plan: Long;
    price?: Coin;
    status: Status;
    statusAt?: Date;
}

Properties

denom +deposit? +expiry? +free +id +node +owner +plan +price? +status +statusAt? +

Properties

denom

denom: string

Optional deposit

deposit?: Coin

Optional expiry

expiry?: Date

free

free: string

id

id: Long

node

node: string

owner

owner: string

plan

plan: Long

Optional price

price?: Coin

status

status: Status

Optional statusAt

statusAt?: Date

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_node.MsgRegisterEncodeObject.html b/docs/interfaces/modules_node.MsgRegisterEncodeObject.html new file mode 100644 index 0000000..ae9d7bb --- /dev/null +++ b/docs/interfaces/modules_node.MsgRegisterEncodeObject.html @@ -0,0 +1,3 @@ +MsgRegisterEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgRegisterEncodeObject

interface MsgRegisterEncodeObject {
    typeUrl: "/sentinel.node.v2.MsgRegisterRequest";
    value: Partial<MsgRegisterRequest>;
}

Hierarchy

  • EncodeObject
    • MsgRegisterEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.node.v2.MsgRegisterRequest"

Readonly value

value: Partial<MsgRegisterRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_node.MsgSubscribeEncodeObject.html b/docs/interfaces/modules_node.MsgSubscribeEncodeObject.html new file mode 100644 index 0000000..f7bbbd1 --- /dev/null +++ b/docs/interfaces/modules_node.MsgSubscribeEncodeObject.html @@ -0,0 +1,3 @@ +MsgSubscribeEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgSubscribeEncodeObject

interface MsgSubscribeEncodeObject {
    typeUrl: "/sentinel.node.v2.MsgSubscribeRequest";
    value: Partial<MsgSubscribeRequest>;
}

Hierarchy

  • EncodeObject
    • MsgSubscribeEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.node.v2.MsgSubscribeRequest"

Readonly value

value: Partial<MsgSubscribeRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_node.MsgUpdateDetailsEncodeObject.html b/docs/interfaces/modules_node.MsgUpdateDetailsEncodeObject.html new file mode 100644 index 0000000..0203865 --- /dev/null +++ b/docs/interfaces/modules_node.MsgUpdateDetailsEncodeObject.html @@ -0,0 +1,3 @@ +MsgUpdateDetailsEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUpdateDetailsEncodeObject

interface MsgUpdateDetailsEncodeObject {
    typeUrl: "/sentinel.node.v2.MsgUpdateDetailsRequest";
    value: Partial<MsgUpdateDetailsRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUpdateDetailsEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.node.v2.MsgUpdateDetailsRequest"

Readonly value

value: Partial<MsgUpdateDetailsRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_node.MsgUpdateStatusEncodeObject.html b/docs/interfaces/modules_node.MsgUpdateStatusEncodeObject.html new file mode 100644 index 0000000..7bfb12d --- /dev/null +++ b/docs/interfaces/modules_node.MsgUpdateStatusEncodeObject.html @@ -0,0 +1,3 @@ +MsgUpdateStatusEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUpdateStatusEncodeObject

interface MsgUpdateStatusEncodeObject {
    typeUrl: "/sentinel.node.v2.MsgUpdateStatusRequest";
    value: Partial<MsgUpdateStatusRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUpdateStatusEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.node.v2.MsgUpdateStatusRequest"

Readonly value

value: Partial<MsgUpdateStatusRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_node.NodeExtension.html b/docs/interfaces/modules_node.NodeExtension.html new file mode 100644 index 0000000..9be1b59 --- /dev/null +++ b/docs/interfaces/modules_node.NodeExtension.html @@ -0,0 +1,2 @@ +NodeExtension | @sentinel-official/sentinel-js-sdk

Interface NodeExtension

interface NodeExtension {
    node: {
        node: ((address) => Promise<undefined | Node>);
        nodes: ((status, pagination?) => Promise<QueryNodesResponse>);
        nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>);
        params: (() => Promise<undefined | Params>);
    };
}

Properties

node +

Properties

Readonly node

node: {
    node: ((address) => Promise<undefined | Node>);
    nodes: ((status, pagination?) => Promise<QueryNodesResponse>);
    nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>);
    params: (() => Promise<undefined | Params>);
}

Type declaration

  • node: ((address) => Promise<undefined | Node>)
      • (address): Promise<undefined | Node>

      • Parameters

        • address: string

        Returns Promise<undefined | Node>

  • nodes: ((status, pagination?) => Promise<QueryNodesResponse>)
      • (status, pagination?): Promise<QueryNodesResponse>

      • Parameters

        Returns Promise<QueryNodesResponse>

  • nodesForPlan: ((id, status, pagination?) => Promise<QueryNodesForPlanResponse>)
      • (id, status, pagination?): Promise<QueryNodesForPlanResponse>

      • Parameters

        Returns Promise<QueryNodesForPlanResponse>

  • params: (() => Promise<undefined | Params>)
      • (): Promise<undefined | Params>

      • Returns Promise<undefined | Params>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.MsgCreateEncodeObject.html b/docs/interfaces/modules_plan.MsgCreateEncodeObject.html new file mode 100644 index 0000000..8e5eea1 --- /dev/null +++ b/docs/interfaces/modules_plan.MsgCreateEncodeObject.html @@ -0,0 +1,3 @@ +MsgCreateEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgCreateEncodeObject

interface MsgCreateEncodeObject {
    typeUrl: "/sentinel.plan.v2.MsgCreateRequest";
    value: Partial<MsgCreateRequest>;
}

Hierarchy

  • EncodeObject
    • MsgCreateEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.plan.v2.MsgCreateRequest"

Readonly value

value: Partial<MsgCreateRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.MsgLinkNodeEncodeObject.html b/docs/interfaces/modules_plan.MsgLinkNodeEncodeObject.html new file mode 100644 index 0000000..f375e39 --- /dev/null +++ b/docs/interfaces/modules_plan.MsgLinkNodeEncodeObject.html @@ -0,0 +1,3 @@ +MsgLinkNodeEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgLinkNodeEncodeObject

interface MsgLinkNodeEncodeObject {
    typeUrl: "/sentinel.plan.v2.MsgLinkNodeRequest";
    value: Partial<MsgLinkNodeRequest>;
}

Hierarchy

  • EncodeObject
    • MsgLinkNodeEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.plan.v2.MsgLinkNodeRequest"

Readonly value

value: Partial<MsgLinkNodeRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.MsgSubscribeEncodeObject.html b/docs/interfaces/modules_plan.MsgSubscribeEncodeObject.html new file mode 100644 index 0000000..d0c8601 --- /dev/null +++ b/docs/interfaces/modules_plan.MsgSubscribeEncodeObject.html @@ -0,0 +1,3 @@ +MsgSubscribeEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgSubscribeEncodeObject

interface MsgSubscribeEncodeObject {
    typeUrl: "/sentinel.plan.v2.MsgSubscribeRequest";
    value: Partial<MsgSubscribeRequest>;
}

Hierarchy

  • EncodeObject
    • MsgSubscribeEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.plan.v2.MsgSubscribeRequest"

Readonly value

value: Partial<MsgSubscribeRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.MsgUnlinkNodeEncodeObject.html b/docs/interfaces/modules_plan.MsgUnlinkNodeEncodeObject.html new file mode 100644 index 0000000..3cc54c6 --- /dev/null +++ b/docs/interfaces/modules_plan.MsgUnlinkNodeEncodeObject.html @@ -0,0 +1,3 @@ +MsgUnlinkNodeEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUnlinkNodeEncodeObject

interface MsgUnlinkNodeEncodeObject {
    typeUrl: "/sentinel.plan.v2.MsgUnlinkNodeRequest";
    value: Partial<MsgUnlinkNodeRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUnlinkNodeEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.plan.v2.MsgUnlinkNodeRequest"

Readonly value

value: Partial<MsgUnlinkNodeRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.MsgUpdateStatusEncodeObject.html b/docs/interfaces/modules_plan.MsgUpdateStatusEncodeObject.html new file mode 100644 index 0000000..b1c9003 --- /dev/null +++ b/docs/interfaces/modules_plan.MsgUpdateStatusEncodeObject.html @@ -0,0 +1,3 @@ +MsgUpdateStatusEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUpdateStatusEncodeObject

interface MsgUpdateStatusEncodeObject {
    typeUrl: "/sentinel.plan.v2.MsgUpdateStatusRequest";
    value: Partial<MsgUpdateStatusRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUpdateStatusEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.plan.v2.MsgUpdateStatusRequest"

Readonly value

value: Partial<MsgUpdateStatusRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_plan.PlanExtension.html b/docs/interfaces/modules_plan.PlanExtension.html new file mode 100644 index 0000000..7d00e76 --- /dev/null +++ b/docs/interfaces/modules_plan.PlanExtension.html @@ -0,0 +1,2 @@ +PlanExtension | @sentinel-official/sentinel-js-sdk

Interface PlanExtension

interface PlanExtension {
    plan: {
        plan: ((id) => Promise<undefined | Plan>);
        plans: ((status, pagination?) => Promise<QueryPlansResponse>);
        plansForProvide: ((address, pagination?) => Promise<QueryPlansForProviderResponse>);
    };
}

Properties

plan +

Properties

Readonly plan

plan: {
    plan: ((id) => Promise<undefined | Plan>);
    plans: ((status, pagination?) => Promise<QueryPlansResponse>);
    plansForProvide: ((address, pagination?) => Promise<QueryPlansForProviderResponse>);
}

Type declaration

  • plan: ((id) => Promise<undefined | Plan>)
      • (id): Promise<undefined | Plan>

      • Parameters

        • id: Long

        Returns Promise<undefined | Plan>

  • plans: ((status, pagination?) => Promise<QueryPlansResponse>)
      • (status, pagination?): Promise<QueryPlansResponse>

      • Parameters

        Returns Promise<QueryPlansResponse>

  • plansForProvide: ((address, pagination?) => Promise<QueryPlansForProviderResponse>)
      • (address, pagination?): Promise<QueryPlansForProviderResponse>

      • Parameters

        Returns Promise<QueryPlansForProviderResponse>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_provider.MsgRegisterEncodeObject.html b/docs/interfaces/modules_provider.MsgRegisterEncodeObject.html new file mode 100644 index 0000000..34125f3 --- /dev/null +++ b/docs/interfaces/modules_provider.MsgRegisterEncodeObject.html @@ -0,0 +1,3 @@ +MsgRegisterEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgRegisterEncodeObject

interface MsgRegisterEncodeObject {
    typeUrl: "/sentinel.provider.v2.MsgRegisterRequest";
    value: Partial<MsgRegisterRequest>;
}

Hierarchy

  • EncodeObject
    • MsgRegisterEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.provider.v2.MsgRegisterRequest"

Readonly value

value: Partial<MsgRegisterRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_provider.MsgUpdateEncodeObject.html b/docs/interfaces/modules_provider.MsgUpdateEncodeObject.html new file mode 100644 index 0000000..6fadd31 --- /dev/null +++ b/docs/interfaces/modules_provider.MsgUpdateEncodeObject.html @@ -0,0 +1,3 @@ +MsgUpdateEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUpdateEncodeObject

interface MsgUpdateEncodeObject {
    typeUrl: "/sentinel.provider.v2.MsgUpdateRequest";
    value: Partial<MsgUpdateRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUpdateEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.provider.v2.MsgUpdateRequest"

Readonly value

value: Partial<MsgUpdateRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_provider.ProviderExtension.html b/docs/interfaces/modules_provider.ProviderExtension.html new file mode 100644 index 0000000..45ec965 --- /dev/null +++ b/docs/interfaces/modules_provider.ProviderExtension.html @@ -0,0 +1,2 @@ +ProviderExtension | @sentinel-official/sentinel-js-sdk

Interface ProviderExtension

interface ProviderExtension {
    provider: {
        params: (() => Promise<undefined | Params>);
        provider: ((address) => Promise<undefined | Provider>);
        providers: ((status, pagination?) => Promise<QueryProvidersResponse>);
    };
}

Properties

provider +

Properties

Readonly provider

provider: {
    params: (() => Promise<undefined | Params>);
    provider: ((address) => Promise<undefined | Provider>);
    providers: ((status, pagination?) => Promise<QueryProvidersResponse>);
}

Type declaration

  • params: (() => Promise<undefined | Params>)
      • (): Promise<undefined | Params>

      • Returns Promise<undefined | Params>

  • provider: ((address) => Promise<undefined | Provider>)
      • (address): Promise<undefined | Provider>

      • Parameters

        • address: string

        Returns Promise<undefined | Provider>

  • providers: ((status, pagination?) => Promise<QueryProvidersResponse>)
      • (status, pagination?): Promise<QueryProvidersResponse>

      • Parameters

        Returns Promise<QueryProvidersResponse>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_session.MsgEndEncodeObject.html b/docs/interfaces/modules_session.MsgEndEncodeObject.html new file mode 100644 index 0000000..be1b21d --- /dev/null +++ b/docs/interfaces/modules_session.MsgEndEncodeObject.html @@ -0,0 +1,3 @@ +MsgEndEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgEndEncodeObject

interface MsgEndEncodeObject {
    typeUrl: "/sentinel.session.v2.MsgEndRequest";
    value: Partial<MsgEndRequest>;
}

Hierarchy

  • EncodeObject
    • MsgEndEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.session.v2.MsgEndRequest"

Readonly value

value: Partial<MsgEndRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_session.MsgStartEncodeObject.html b/docs/interfaces/modules_session.MsgStartEncodeObject.html new file mode 100644 index 0000000..749829e --- /dev/null +++ b/docs/interfaces/modules_session.MsgStartEncodeObject.html @@ -0,0 +1,3 @@ +MsgStartEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgStartEncodeObject

interface MsgStartEncodeObject {
    typeUrl: "/sentinel.session.v2.MsgStartRequest";
    value: Partial<MsgStartRequest>;
}

Hierarchy

  • EncodeObject
    • MsgStartEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.session.v2.MsgStartRequest"

Readonly value

value: Partial<MsgStartRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_session.MsgUpdateDetailsEncodeObject.html b/docs/interfaces/modules_session.MsgUpdateDetailsEncodeObject.html new file mode 100644 index 0000000..007fe4b --- /dev/null +++ b/docs/interfaces/modules_session.MsgUpdateDetailsEncodeObject.html @@ -0,0 +1,3 @@ +MsgUpdateDetailsEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgUpdateDetailsEncodeObject

interface MsgUpdateDetailsEncodeObject {
    typeUrl: "/sentinel.session.v2.MsgUpdateDetailsRequest";
    value: Partial<MsgUpdateDetailsRequest>;
}

Hierarchy

  • EncodeObject
    • MsgUpdateDetailsEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.session.v2.MsgUpdateDetailsRequest"

Readonly value

value: Partial<MsgUpdateDetailsRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_session.SessionExtension.html b/docs/interfaces/modules_session.SessionExtension.html new file mode 100644 index 0000000..e68b8b9 --- /dev/null +++ b/docs/interfaces/modules_session.SessionExtension.html @@ -0,0 +1,2 @@ +SessionExtension | @sentinel-official/sentinel-js-sdk

Interface SessionExtension

interface SessionExtension {
    session: {
        params: (() => Promise<undefined | Params>);
        session: ((id) => Promise<undefined | Session>);
        sessions: ((pagination?) => Promise<QuerySessionsResponse>);
        sessionsForAccount: ((address, pagination?) => Promise<QuerySessionsForAccountResponse>);
        sessionsForAllocation: ((id, address, pagination?) => Promise<QuerySessionsForAllocationResponse>);
        sessionsForNode: ((address, pagination?) => Promise<QuerySessionsForNodeResponse>);
        sessionsForSubscription: ((id, pagination?) => Promise<QuerySessionsForSubscriptionResponse>);
    };
}

Properties

session +

Properties

Readonly session

session: {
    params: (() => Promise<undefined | Params>);
    session: ((id) => Promise<undefined | Session>);
    sessions: ((pagination?) => Promise<QuerySessionsResponse>);
    sessionsForAccount: ((address, pagination?) => Promise<QuerySessionsForAccountResponse>);
    sessionsForAllocation: ((id, address, pagination?) => Promise<QuerySessionsForAllocationResponse>);
    sessionsForNode: ((address, pagination?) => Promise<QuerySessionsForNodeResponse>);
    sessionsForSubscription: ((id, pagination?) => Promise<QuerySessionsForSubscriptionResponse>);
}

Type declaration

  • params: (() => Promise<undefined | Params>)
      • (): Promise<undefined | Params>

      • Returns Promise<undefined | Params>

  • session: ((id) => Promise<undefined | Session>)
      • (id): Promise<undefined | Session>

      • Parameters

        • id: Long

        Returns Promise<undefined | Session>

  • sessions: ((pagination?) => Promise<QuerySessionsResponse>)
      • (pagination?): Promise<QuerySessionsResponse>

      • Parameters

        Returns Promise<QuerySessionsResponse>

  • sessionsForAccount: ((address, pagination?) => Promise<QuerySessionsForAccountResponse>)
      • (address, pagination?): Promise<QuerySessionsForAccountResponse>

      • Parameters

        Returns Promise<QuerySessionsForAccountResponse>

  • sessionsForAllocation: ((id, address, pagination?) => Promise<QuerySessionsForAllocationResponse>)
      • (id, address, pagination?): Promise<QuerySessionsForAllocationResponse>

      • Parameters

        • id: Long
        • address: string
        • Optional pagination: PageRequest

        Returns Promise<QuerySessionsForAllocationResponse>

  • sessionsForNode: ((address, pagination?) => Promise<QuerySessionsForNodeResponse>)
      • (address, pagination?): Promise<QuerySessionsForNodeResponse>

      • Parameters

        Returns Promise<QuerySessionsForNodeResponse>

  • sessionsForSubscription: ((id, pagination?) => Promise<QuerySessionsForSubscriptionResponse>)
      • (id, pagination?): Promise<QuerySessionsForSubscriptionResponse>

      • Parameters

        Returns Promise<QuerySessionsForSubscriptionResponse>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_subscription.MsgAllocateEncodeObject.html b/docs/interfaces/modules_subscription.MsgAllocateEncodeObject.html new file mode 100644 index 0000000..a51c83e --- /dev/null +++ b/docs/interfaces/modules_subscription.MsgAllocateEncodeObject.html @@ -0,0 +1,3 @@ +MsgAllocateEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgAllocateEncodeObject

interface MsgAllocateEncodeObject {
    typeUrl: "/sentinel.subscription.v2.MsgAllocateRequest";
    value: Partial<MsgAllocateRequest>;
}

Hierarchy

  • EncodeObject
    • MsgAllocateEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.subscription.v2.MsgAllocateRequest"

Readonly value

value: Partial<MsgAllocateRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_subscription.MsgCancelEncodeObject.html b/docs/interfaces/modules_subscription.MsgCancelEncodeObject.html new file mode 100644 index 0000000..74d94e9 --- /dev/null +++ b/docs/interfaces/modules_subscription.MsgCancelEncodeObject.html @@ -0,0 +1,3 @@ +MsgCancelEncodeObject | @sentinel-official/sentinel-js-sdk

Interface MsgCancelEncodeObject

interface MsgCancelEncodeObject {
    typeUrl: "/sentinel.subscription.v2.MsgCancelRequest";
    value: Partial<MsgCancelRequest>;
}

Hierarchy

  • EncodeObject
    • MsgCancelEncodeObject

Properties

typeUrl +value +

Properties

Readonly typeUrl

typeUrl: "/sentinel.subscription.v2.MsgCancelRequest"

Readonly value

value: Partial<MsgCancelRequest>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/modules_subscription.SubscriptionExtension.html b/docs/interfaces/modules_subscription.SubscriptionExtension.html new file mode 100644 index 0000000..5df9b6a --- /dev/null +++ b/docs/interfaces/modules_subscription.SubscriptionExtension.html @@ -0,0 +1,2 @@ +SubscriptionExtension | @sentinel-official/sentinel-js-sdk

Interface SubscriptionExtension

interface SubscriptionExtension {
    subscription: {
        allocation: ((id, address) => Promise<undefined | Allocation>);
        allocations: ((id, pagination?) => Promise<QueryAllocationsResponse>);
        params: (() => Promise<undefined | Params>);
        payout: ((id) => Promise<undefined | Payout>);
        payouts: ((pagination?) => Promise<QueryPayoutsResponse>);
        payoutsForAccount: ((address, pagination?) => Promise<QueryPayoutsForAccountResponse>);
        payoutsForNode: ((address, pagination?) => Promise<QueryPayoutsForNodeResponse>);
        subscription: ((id) => Promise<QuerySubscriptionResponse>);
        subscriptions: ((pagination?) => Promise<QuerySubscriptionsResponse>);
        subscriptionsForAccount: ((address, pagination?) => Promise<QuerySubscriptionsForAccountResponse>);
        subscriptionsForNode: ((address, pagination?) => Promise<QuerySubscriptionsForNodeResponse>);
        subscriptionsForPlan: ((id, pagination?) => Promise<QuerySubscriptionsForPlanResponse>);
    };
}

Properties

subscription +

Properties

Readonly subscription

subscription: {
    allocation: ((id, address) => Promise<undefined | Allocation>);
    allocations: ((id, pagination?) => Promise<QueryAllocationsResponse>);
    params: (() => Promise<undefined | Params>);
    payout: ((id) => Promise<undefined | Payout>);
    payouts: ((pagination?) => Promise<QueryPayoutsResponse>);
    payoutsForAccount: ((address, pagination?) => Promise<QueryPayoutsForAccountResponse>);
    payoutsForNode: ((address, pagination?) => Promise<QueryPayoutsForNodeResponse>);
    subscription: ((id) => Promise<QuerySubscriptionResponse>);
    subscriptions: ((pagination?) => Promise<QuerySubscriptionsResponse>);
    subscriptionsForAccount: ((address, pagination?) => Promise<QuerySubscriptionsForAccountResponse>);
    subscriptionsForNode: ((address, pagination?) => Promise<QuerySubscriptionsForNodeResponse>);
    subscriptionsForPlan: ((id, pagination?) => Promise<QuerySubscriptionsForPlanResponse>);
}

Type declaration

  • allocation: ((id, address) => Promise<undefined | Allocation>)
      • (id, address): Promise<undefined | Allocation>

      • Parameters

        • id: Long
        • address: string

        Returns Promise<undefined | Allocation>

  • allocations: ((id, pagination?) => Promise<QueryAllocationsResponse>)
      • (id, pagination?): Promise<QueryAllocationsResponse>

      • Parameters

        Returns Promise<QueryAllocationsResponse>

  • params: (() => Promise<undefined | Params>)
      • (): Promise<undefined | Params>

      • Returns Promise<undefined | Params>

  • payout: ((id) => Promise<undefined | Payout>)
      • (id): Promise<undefined | Payout>

      • Parameters

        • id: Long

        Returns Promise<undefined | Payout>

  • payouts: ((pagination?) => Promise<QueryPayoutsResponse>)
      • (pagination?): Promise<QueryPayoutsResponse>

      • Parameters

        Returns Promise<QueryPayoutsResponse>

  • payoutsForAccount: ((address, pagination?) => Promise<QueryPayoutsForAccountResponse>)
      • (address, pagination?): Promise<QueryPayoutsForAccountResponse>

      • Parameters

        Returns Promise<QueryPayoutsForAccountResponse>

  • payoutsForNode: ((address, pagination?) => Promise<QueryPayoutsForNodeResponse>)
      • (address, pagination?): Promise<QueryPayoutsForNodeResponse>

      • Parameters

        Returns Promise<QueryPayoutsForNodeResponse>

  • subscription: ((id) => Promise<QuerySubscriptionResponse>)
      • (id): Promise<QuerySubscriptionResponse>

      • Parameters

        • id: Long

        Returns Promise<QuerySubscriptionResponse>

  • subscriptions: ((pagination?) => Promise<QuerySubscriptionsResponse>)
      • (pagination?): Promise<QuerySubscriptionsResponse>

      • Parameters

        Returns Promise<QuerySubscriptionsResponse>

  • subscriptionsForAccount: ((address, pagination?) => Promise<QuerySubscriptionsForAccountResponse>)
      • (address, pagination?): Promise<QuerySubscriptionsForAccountResponse>

      • Parameters

        Returns Promise<QuerySubscriptionsForAccountResponse>

  • subscriptionsForNode: ((address, pagination?) => Promise<QuerySubscriptionsForNodeResponse>)
      • (address, pagination?): Promise<QuerySubscriptionsForNodeResponse>

      • Parameters

        Returns Promise<QuerySubscriptionsForNodeResponse>

  • subscriptionsForPlan: ((id, pagination?) => Promise<QuerySubscriptionsForPlanResponse>)
      • (id, pagination?): Promise<QuerySubscriptionsForPlanResponse>

      • Parameters

        Returns Promise<QuerySubscriptionsForPlanResponse>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/index.html b/docs/modules/index.html new file mode 100644 index 0000000..e1fc67d --- /dev/null +++ b/docs/modules/index.html @@ -0,0 +1,20 @@ +index | @sentinel-official/sentinel-js-sdk

Module index

Index

Enumerations

Status +

Classes

SentinelClient +SigningSentinelClient +

Interfaces

Bandwidth +Coin +Node +PageRequest +Plan +Provider +Session +Subscription +

Variables

Bandwidth +Coin +Node +PageRequest +Plan +Provider +Session +Subscription +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_node.html b/docs/modules/modules_node.html new file mode 100644 index 0000000..f4c3fa6 --- /dev/null +++ b/docs/modules/modules_node.html @@ -0,0 +1,17 @@ +modules/node | @sentinel-official/sentinel-js-sdk

Module modules/node

References

Node +

Interfaces

MsgRegisterEncodeObject +MsgSubscribeEncodeObject +MsgUpdateDetailsEncodeObject +MsgUpdateStatusEncodeObject +NodeExtension +

Variables

MsgRegisterTypeUrl +MsgSubscribeTypeUrl +MsgUpdateDetailsTypeUrl +MsgUpdateStatusTypeUrl +registry +

Functions

isMsgRegisterEncodeObject +isMsgSubscribeEncodeObject +isMsgUpdateDetailsEncodeObject +isMsgUpdateStatusEncodeObject +setupNodeExtension +

References

Node

Re-exports Node

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_plan.html b/docs/modules/modules_plan.html new file mode 100644 index 0000000..0d3fbee --- /dev/null +++ b/docs/modules/modules_plan.html @@ -0,0 +1,20 @@ +modules/plan | @sentinel-official/sentinel-js-sdk

Module modules/plan

References

Plan +

Interfaces

MsgCreateEncodeObject +MsgLinkNodeEncodeObject +MsgSubscribeEncodeObject +MsgUnlinkNodeEncodeObject +MsgUpdateStatusEncodeObject +PlanExtension +

Variables

MsgCreateTypeUrl +MsgLinkNodeTypeUrl +MsgSubscribeTypeUrl +MsgUnlinkNodeTypeUrl +MsgUpdateStatusTypeUrl +registry +

Functions

isMsgCreateEncodeObject +isMsgLinkNodeEncodeObject +isMsgSubscribeEncodeObject +isMsgUnlinkNodeEncodeObject +isMsgUpdateStatusEncodeObject +setupPlanExtension +

References

Plan

Re-exports Plan

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_provider.html b/docs/modules/modules_provider.html new file mode 100644 index 0000000..5ecf71f --- /dev/null +++ b/docs/modules/modules_provider.html @@ -0,0 +1,11 @@ +modules/provider | @sentinel-official/sentinel-js-sdk

Module modules/provider

References

Provider +

Interfaces

MsgRegisterEncodeObject +MsgUpdateEncodeObject +ProviderExtension +

Variables

MsgRegisterTypeUrl +MsgUpdateTypeUrl +registry +

Functions

isMsgRegisterEncodeObject +isMsgUpdateEncodeObject +setupProviderExtension +

References

Provider

Re-exports Provider

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_queries.html b/docs/modules/modules_queries.html new file mode 100644 index 0000000..977550e --- /dev/null +++ b/docs/modules/modules_queries.html @@ -0,0 +1,3 @@ +modules/queries | @sentinel-official/sentinel-js-sdk

Module modules/queries

Index

Type Aliases

SentinelQueryClient +

Functions

buildSentinelQueryClient +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_session.html b/docs/modules/modules_session.html new file mode 100644 index 0000000..17b584d --- /dev/null +++ b/docs/modules/modules_session.html @@ -0,0 +1,14 @@ +modules/session | @sentinel-official/sentinel-js-sdk

Module modules/session

References

Session +

Interfaces

MsgEndEncodeObject +MsgStartEncodeObject +MsgUpdateDetailsEncodeObject +SessionExtension +

Variables

MsgEndTypeUrl +MsgStartTypeUrl +MsgUpdateDetailsTypeUrl +registry +

Functions

isMsgEndEncodeObject +isMsgStartEncodeObject +isMsgUpdateDetailsEncodeObject +setupSessionExtension +

References

Session

Re-exports Session

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/modules_subscription.html b/docs/modules/modules_subscription.html new file mode 100644 index 0000000..f0a70d3 --- /dev/null +++ b/docs/modules/modules_subscription.html @@ -0,0 +1,11 @@ +modules/subscription | @sentinel-official/sentinel-js-sdk

Module modules/subscription

References

Subscription +

Interfaces

MsgAllocateEncodeObject +MsgCancelEncodeObject +SubscriptionExtension +

Variables

MsgAllocateTypeUrl +MsgCancelTypeUrl +registry +

Functions

isMsgAllocateEncodeObject +isMsgCancelEncodeObject +setupSubscriptionExtension +

References

Subscription

Re-exports Subscription

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/modules_queries.SentinelQueryClient.html b/docs/types/modules_queries.SentinelQueryClient.html new file mode 100644 index 0000000..1e0bb92 --- /dev/null +++ b/docs/types/modules_queries.SentinelQueryClient.html @@ -0,0 +1 @@ +SentinelQueryClient | @sentinel-official/sentinel-js-sdk

Type alias SentinelQueryClient

SentinelQueryClient: QueryClient & NodeExtension & PlanExtension & ProviderExtension & SessionExtension & SubscriptionExtension

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Bandwidth-1.html b/docs/variables/index.Bandwidth-1.html new file mode 100644 index 0000000..96ab290 --- /dev/null +++ b/docs/variables/index.Bandwidth-1.html @@ -0,0 +1 @@ +Bandwidth | @sentinel-official/sentinel-js-sdk

Variable Bandwidth

Bandwidth: {
    create(base?): Bandwidth;
    decode(input, length?): Bandwidth;
    encode(message, writer?): Writer;
    fromJSON(object): Bandwidth;
    fromPartial(object): Bandwidth;
    toJSON(message): unknown;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Coin-1.html b/docs/variables/index.Coin-1.html new file mode 100644 index 0000000..192dcd8 --- /dev/null +++ b/docs/variables/index.Coin-1.html @@ -0,0 +1 @@ +Coin | @sentinel-official/sentinel-js-sdk

Variable Coin

Coin: {
    create(base?): Coin;
    decode(input, length?): Coin;
    encode(message, writer?): Writer;
    fromJSON(object): Coin;
    fromPartial(object): Coin;
    toJSON(message): unknown;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Node-1.html b/docs/variables/index.Node-1.html new file mode 100644 index 0000000..fa3a94d --- /dev/null +++ b/docs/variables/index.Node-1.html @@ -0,0 +1 @@ +Node | @sentinel-official/sentinel-js-sdk

Variable Node

Node: {
    create(base?): Node;
    decode(input, length?): Node;
    encode(message, writer?): Writer;
    fromJSON(object): Node;
    fromPartial(object): Node;
    toJSON(message): unknown;
}

Type declaration

  • create:function
    • create(base?): Node

    • Parameters

      • Optional base: {
            address?: string;
            gigabytePrices?: {
                amount?: string;
                denom?: string;
            }[];
            hourlyPrices?: {
                amount?: string;
                denom?: string;
            }[];
            inactiveAt?: Date;
            remoteUrl?: string;
            status?: Status;
            statusAt?: Date;
        }
        • Optional address?: string
        • Optional gigabytePrices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional hourlyPrices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional inactiveAt?: Date
        • Optional remoteUrl?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Node

  • decode:function
  • encode:function
  • fromJSON:function
  • fromPartial:function
    • fromPartial(object): Node

    • Parameters

      • object: {
            address?: string;
            gigabytePrices?: {
                amount?: string;
                denom?: string;
            }[];
            hourlyPrices?: {
                amount?: string;
                denom?: string;
            }[];
            inactiveAt?: Date;
            remoteUrl?: string;
            status?: Status;
            statusAt?: Date;
        }
        • Optional address?: string
        • Optional gigabytePrices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional hourlyPrices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional inactiveAt?: Date
        • Optional remoteUrl?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Node

  • toJSON:function

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.PageRequest-1.html b/docs/variables/index.PageRequest-1.html new file mode 100644 index 0000000..d24e8e4 --- /dev/null +++ b/docs/variables/index.PageRequest-1.html @@ -0,0 +1,29 @@ +PageRequest | @sentinel-official/sentinel-js-sdk

Variable PageRequest

PageRequest: {
    create(base?): PageRequest;
    decode(input, length?): PageRequest;
    encode(message, writer?): Writer;
    fromJSON(object): PageRequest;
    fromPartial(object): PageRequest;
    toJSON(message): unknown;
}

Type declaration

  • create:function
    • create(base?): PageRequest

    • Parameters

      • Optional base: {
            countTotal?: boolean;
            key?: Uint8Array;
            limit?: string | number | Long;
            offset?: string | number | Long;
            reverse?: boolean;
        }
        • Optional countTotal?: boolean

          count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

          +
        • Optional key?: Uint8Array

          key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

          +
        • Optional limit?: string | number | Long

          limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

          +
        • Optional offset?: string | number | Long

          offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

          +
        • Optional reverse?: boolean

          reverse is set to true if results are to be returned in the descending order.

          +

          Since: cosmos-sdk 0.43

          +

      Returns PageRequest

  • decode:function
  • encode:function
  • fromJSON:function
  • fromPartial:function
    • fromPartial(object): PageRequest

    • Parameters

      • object: {
            countTotal?: boolean;
            key?: Uint8Array;
            limit?: string | number | Long;
            offset?: string | number | Long;
            reverse?: boolean;
        }
        • Optional countTotal?: boolean

          count_total is set to true to indicate that the result set should include +a count of the total number of items available for pagination in UIs. +count_total is only respected when offset is used. It is ignored when key +is set.

          +
        • Optional key?: Uint8Array

          key is a value returned in PageResponse.next_key to begin +querying the next page most efficiently. Only one of offset or key +should be set.

          +
        • Optional limit?: string | number | Long

          limit is the total number of results to be returned in the result page. +If left empty it will default to a value to be set by each app.

          +
        • Optional offset?: string | number | Long

          offset is a numeric offset that can be used when key is unavailable. +It is less efficient than using key. Only one of offset or key should +be set.

          +
        • Optional reverse?: boolean

          reverse is set to true if results are to be returned in the descending order.

          +

          Since: cosmos-sdk 0.43

          +

      Returns PageRequest

  • toJSON:function

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Plan-1.html b/docs/variables/index.Plan-1.html new file mode 100644 index 0000000..964c8c7 --- /dev/null +++ b/docs/variables/index.Plan-1.html @@ -0,0 +1,19 @@ +Plan | @sentinel-official/sentinel-js-sdk

Variable Plan

Plan: {
    create(base?): Plan;
    decode(input, length?): Plan;
    encode(message, writer?): Writer;
    fromJSON(object): Plan;
    fromPartial(object): Plan;
    toJSON(message): unknown;
}

Type declaration

  • create:function
    • create(base?): Plan

    • Parameters

      • Optional base: {
            duration?: {
                nanos?: number;
                seconds?: string | number | Long;
            };
            gigabytes?: string | number | Long;
            id?: string | number | Long;
            prices?: {
                amount?: string;
                denom?: string;
            }[];
            providerAddress?: string;
            status?: Status;
            statusAt?: Date;
        }
        • Optional duration?: {
              nanos?: number;
              seconds?: string | number | Long;
          }
          • Optional nanos?: number

            Signed fractions of a second at nanosecond resolution of the span +of time. Durations less than one second are represented with a 0 +seconds field and a positive or negative nanos field. For durations +of one second or more, a non-zero value for the nanos field must be +of the same sign as the seconds field. Must be from -999,999,999 +to +999,999,999 inclusive.

            +
          • Optional seconds?: string | number | Long

            Signed seconds of the span of time. Must be from -315,576,000,000 +to +315,576,000,000 inclusive. Note: these bounds are computed from: +60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

            +
        • Optional gigabytes?: string | number | Long
        • Optional id?: string | number | Long
        • Optional prices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional providerAddress?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Plan

  • decode:function
  • encode:function
  • fromJSON:function
  • fromPartial:function
    • fromPartial(object): Plan

    • Parameters

      • object: {
            duration?: {
                nanos?: number;
                seconds?: string | number | Long;
            };
            gigabytes?: string | number | Long;
            id?: string | number | Long;
            prices?: {
                amount?: string;
                denom?: string;
            }[];
            providerAddress?: string;
            status?: Status;
            statusAt?: Date;
        }
        • Optional duration?: {
              nanos?: number;
              seconds?: string | number | Long;
          }
          • Optional nanos?: number

            Signed fractions of a second at nanosecond resolution of the span +of time. Durations less than one second are represented with a 0 +seconds field and a positive or negative nanos field. For durations +of one second or more, a non-zero value for the nanos field must be +of the same sign as the seconds field. Must be from -999,999,999 +to +999,999,999 inclusive.

            +
          • Optional seconds?: string | number | Long

            Signed seconds of the span of time. Must be from -315,576,000,000 +to +315,576,000,000 inclusive. Note: these bounds are computed from: +60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

            +
        • Optional gigabytes?: string | number | Long
        • Optional id?: string | number | Long
        • Optional prices?: {
              amount?: string;
              denom?: string;
          }[]
        • Optional providerAddress?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Plan

  • toJSON:function

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Provider-1.html b/docs/variables/index.Provider-1.html new file mode 100644 index 0000000..a05c9cc --- /dev/null +++ b/docs/variables/index.Provider-1.html @@ -0,0 +1 @@ +Provider | @sentinel-official/sentinel-js-sdk

Variable Provider

Provider: {
    create(base?): Provider;
    decode(input, length?): Provider;
    encode(message, writer?): Writer;
    fromJSON(object): Provider;
    fromPartial(object): Provider;
    toJSON(message): unknown;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Session-1.html b/docs/variables/index.Session-1.html new file mode 100644 index 0000000..74ea7b3 --- /dev/null +++ b/docs/variables/index.Session-1.html @@ -0,0 +1,19 @@ +Session | @sentinel-official/sentinel-js-sdk

Variable Session

Session: {
    create(base?): Session;
    decode(input, length?): Session;
    encode(message, writer?): Writer;
    fromJSON(object): Session;
    fromPartial(object): Session;
    toJSON(message): unknown;
}

Type declaration

  • create:function
    • create(base?): Session

    • Parameters

      • Optional base: {
            address?: string;
            bandwidth?: {
                download?: string;
                upload?: string;
            };
            duration?: {
                nanos?: number;
                seconds?: string | number | Long;
            };
            id?: string | number | Long;
            inactiveAt?: Date;
            nodeAddress?: string;
            status?: Status;
            statusAt?: Date;
            subscriptionId?: string | number | Long;
        }
        • Optional address?: string
        • Optional bandwidth?: {
              download?: string;
              upload?: string;
          }
          • Optional download?: string
          • Optional upload?: string
        • Optional duration?: {
              nanos?: number;
              seconds?: string | number | Long;
          }
          • Optional nanos?: number

            Signed fractions of a second at nanosecond resolution of the span +of time. Durations less than one second are represented with a 0 +seconds field and a positive or negative nanos field. For durations +of one second or more, a non-zero value for the nanos field must be +of the same sign as the seconds field. Must be from -999,999,999 +to +999,999,999 inclusive.

            +
          • Optional seconds?: string | number | Long

            Signed seconds of the span of time. Must be from -315,576,000,000 +to +315,576,000,000 inclusive. Note: these bounds are computed from: +60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

            +
        • Optional id?: string | number | Long
        • Optional inactiveAt?: Date
        • Optional nodeAddress?: string
        • Optional status?: Status
        • Optional statusAt?: Date
        • Optional subscriptionId?: string | number | Long

      Returns Session

  • decode:function
  • encode:function
  • fromJSON:function
  • fromPartial:function
    • fromPartial(object): Session

    • Parameters

      • object: {
            address?: string;
            bandwidth?: {
                download?: string;
                upload?: string;
            };
            duration?: {
                nanos?: number;
                seconds?: string | number | Long;
            };
            id?: string | number | Long;
            inactiveAt?: Date;
            nodeAddress?: string;
            status?: Status;
            statusAt?: Date;
            subscriptionId?: string | number | Long;
        }
        • Optional address?: string
        • Optional bandwidth?: {
              download?: string;
              upload?: string;
          }
          • Optional download?: string
          • Optional upload?: string
        • Optional duration?: {
              nanos?: number;
              seconds?: string | number | Long;
          }
          • Optional nanos?: number

            Signed fractions of a second at nanosecond resolution of the span +of time. Durations less than one second are represented with a 0 +seconds field and a positive or negative nanos field. For durations +of one second or more, a non-zero value for the nanos field must be +of the same sign as the seconds field. Must be from -999,999,999 +to +999,999,999 inclusive.

            +
          • Optional seconds?: string | number | Long

            Signed seconds of the span of time. Must be from -315,576,000,000 +to +315,576,000,000 inclusive. Note: these bounds are computed from: +60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

            +
        • Optional id?: string | number | Long
        • Optional inactiveAt?: Date
        • Optional nodeAddress?: string
        • Optional status?: Status
        • Optional statusAt?: Date
        • Optional subscriptionId?: string | number | Long

      Returns Session

  • toJSON:function

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/index.Subscription-1.html b/docs/variables/index.Subscription-1.html new file mode 100644 index 0000000..d737087 --- /dev/null +++ b/docs/variables/index.Subscription-1.html @@ -0,0 +1 @@ +Subscription | @sentinel-official/sentinel-js-sdk

Variable Subscription

Subscription: {
    create(base?): Subscription;
    decode(input, length?): Subscription;
    encode(message, writer?): Writer;
    fromJSON(object): Subscription;
    fromPartial(object): Subscription;
    toJSON(message): unknown;
}

Type declaration

  • create:function
    • create(base?): Subscription

    • Parameters

      • Optional base: {
            denom?: string;
            deposit?: {
                amount?: string;
                denom?: string;
            };
            expiry?: Date;
            free?: string;
            id?: string | number | Long;
            node?: string;
            owner?: string;
            plan?: string | number | Long;
            price?: {
                amount?: string;
                denom?: string;
            };
            status?: Status;
            statusAt?: Date;
        }
        • Optional denom?: string
        • Optional deposit?: {
              amount?: string;
              denom?: string;
          }
          • Optional amount?: string
          • Optional denom?: string
        • Optional expiry?: Date
        • Optional free?: string
        • Optional id?: string | number | Long
        • Optional node?: string
        • Optional owner?: string
        • Optional plan?: string | number | Long
        • Optional price?: {
              amount?: string;
              denom?: string;
          }
          • Optional amount?: string
          • Optional denom?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Subscription

  • decode:function
  • encode:function
  • fromJSON:function
  • fromPartial:function
    • fromPartial(object): Subscription

    • Parameters

      • object: {
            denom?: string;
            deposit?: {
                amount?: string;
                denom?: string;
            };
            expiry?: Date;
            free?: string;
            id?: string | number | Long;
            node?: string;
            owner?: string;
            plan?: string | number | Long;
            price?: {
                amount?: string;
                denom?: string;
            };
            status?: Status;
            statusAt?: Date;
        }
        • Optional denom?: string
        • Optional deposit?: {
              amount?: string;
              denom?: string;
          }
          • Optional amount?: string
          • Optional denom?: string
        • Optional expiry?: Date
        • Optional free?: string
        • Optional id?: string | number | Long
        • Optional node?: string
        • Optional owner?: string
        • Optional plan?: string | number | Long
        • Optional price?: {
              amount?: string;
              denom?: string;
          }
          • Optional amount?: string
          • Optional denom?: string
        • Optional status?: Status
        • Optional statusAt?: Date

      Returns Subscription

  • toJSON:function

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_node.MsgRegisterTypeUrl.html b/docs/variables/modules_node.MsgRegisterTypeUrl.html new file mode 100644 index 0000000..2d66fdb --- /dev/null +++ b/docs/variables/modules_node.MsgRegisterTypeUrl.html @@ -0,0 +1 @@ +MsgRegisterTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgRegisterTypeUrlConst

MsgRegisterTypeUrl: "/sentinel.node.v2.MsgRegisterRequest" = "/sentinel.node.v2.MsgRegisterRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_node.MsgSubscribeTypeUrl.html b/docs/variables/modules_node.MsgSubscribeTypeUrl.html new file mode 100644 index 0000000..4ebb2bc --- /dev/null +++ b/docs/variables/modules_node.MsgSubscribeTypeUrl.html @@ -0,0 +1 @@ +MsgSubscribeTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgSubscribeTypeUrlConst

MsgSubscribeTypeUrl: "/sentinel.node.v2.MsgSubscribeRequest" = "/sentinel.node.v2.MsgSubscribeRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_node.MsgUpdateDetailsTypeUrl.html b/docs/variables/modules_node.MsgUpdateDetailsTypeUrl.html new file mode 100644 index 0000000..81e3cf2 --- /dev/null +++ b/docs/variables/modules_node.MsgUpdateDetailsTypeUrl.html @@ -0,0 +1 @@ +MsgUpdateDetailsTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUpdateDetailsTypeUrlConst

MsgUpdateDetailsTypeUrl: "/sentinel.node.v2.MsgUpdateDetailsRequest" = "/sentinel.node.v2.MsgUpdateDetailsRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_node.MsgUpdateStatusTypeUrl.html b/docs/variables/modules_node.MsgUpdateStatusTypeUrl.html new file mode 100644 index 0000000..43de0bf --- /dev/null +++ b/docs/variables/modules_node.MsgUpdateStatusTypeUrl.html @@ -0,0 +1 @@ +MsgUpdateStatusTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUpdateStatusTypeUrlConst

MsgUpdateStatusTypeUrl: "/sentinel.node.v2.MsgUpdateStatusRequest" = "/sentinel.node.v2.MsgUpdateStatusRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_node.registry.html b/docs/variables/modules_node.registry.html new file mode 100644 index 0000000..824a43f --- /dev/null +++ b/docs/variables/modules_node.registry.html @@ -0,0 +1 @@ +registry | @sentinel-official/sentinel-js-sdk

Variable registryConst

registry: ReadonlyArray<[string, GeneratedType]> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.MsgCreateTypeUrl.html b/docs/variables/modules_plan.MsgCreateTypeUrl.html new file mode 100644 index 0000000..810466c --- /dev/null +++ b/docs/variables/modules_plan.MsgCreateTypeUrl.html @@ -0,0 +1 @@ +MsgCreateTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgCreateTypeUrlConst

MsgCreateTypeUrl: "/sentinel.plan.v2.MsgCreateRequest" = "/sentinel.plan.v2.MsgCreateRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.MsgLinkNodeTypeUrl.html b/docs/variables/modules_plan.MsgLinkNodeTypeUrl.html new file mode 100644 index 0000000..8c05dff --- /dev/null +++ b/docs/variables/modules_plan.MsgLinkNodeTypeUrl.html @@ -0,0 +1 @@ +MsgLinkNodeTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgLinkNodeTypeUrlConst

MsgLinkNodeTypeUrl: "/sentinel.plan.v2.MsgLinkNodeRequest" = "/sentinel.plan.v2.MsgLinkNodeRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.MsgSubscribeTypeUrl.html b/docs/variables/modules_plan.MsgSubscribeTypeUrl.html new file mode 100644 index 0000000..3ade25d --- /dev/null +++ b/docs/variables/modules_plan.MsgSubscribeTypeUrl.html @@ -0,0 +1 @@ +MsgSubscribeTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgSubscribeTypeUrlConst

MsgSubscribeTypeUrl: "/sentinel.plan.v2.MsgSubscribeRequest" = "/sentinel.plan.v2.MsgSubscribeRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.MsgUnlinkNodeTypeUrl.html b/docs/variables/modules_plan.MsgUnlinkNodeTypeUrl.html new file mode 100644 index 0000000..84cd274 --- /dev/null +++ b/docs/variables/modules_plan.MsgUnlinkNodeTypeUrl.html @@ -0,0 +1 @@ +MsgUnlinkNodeTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUnlinkNodeTypeUrlConst

MsgUnlinkNodeTypeUrl: "/sentinel.plan.v2.MsgUnlinkNodeRequest" = "/sentinel.plan.v2.MsgUnlinkNodeRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.MsgUpdateStatusTypeUrl.html b/docs/variables/modules_plan.MsgUpdateStatusTypeUrl.html new file mode 100644 index 0000000..e110f0a --- /dev/null +++ b/docs/variables/modules_plan.MsgUpdateStatusTypeUrl.html @@ -0,0 +1 @@ +MsgUpdateStatusTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUpdateStatusTypeUrlConst

MsgUpdateStatusTypeUrl: "/sentinel.plan.v2.MsgUpdateStatusRequest" = "/sentinel.plan.v2.MsgUpdateStatusRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_plan.registry.html b/docs/variables/modules_plan.registry.html new file mode 100644 index 0000000..47f495f --- /dev/null +++ b/docs/variables/modules_plan.registry.html @@ -0,0 +1 @@ +registry | @sentinel-official/sentinel-js-sdk

Variable registryConst

registry: ReadonlyArray<[string, GeneratedType]> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_provider.MsgRegisterTypeUrl.html b/docs/variables/modules_provider.MsgRegisterTypeUrl.html new file mode 100644 index 0000000..dbcbb7c --- /dev/null +++ b/docs/variables/modules_provider.MsgRegisterTypeUrl.html @@ -0,0 +1 @@ +MsgRegisterTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgRegisterTypeUrlConst

MsgRegisterTypeUrl: "/sentinel.provider.v2.MsgRegisterRequest" = "/sentinel.provider.v2.MsgRegisterRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_provider.MsgUpdateTypeUrl.html b/docs/variables/modules_provider.MsgUpdateTypeUrl.html new file mode 100644 index 0000000..31591d1 --- /dev/null +++ b/docs/variables/modules_provider.MsgUpdateTypeUrl.html @@ -0,0 +1 @@ +MsgUpdateTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUpdateTypeUrlConst

MsgUpdateTypeUrl: "/sentinel.provider.v2.MsgUpdateRequest" = "/sentinel.provider.v2.MsgUpdateRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_provider.registry.html b/docs/variables/modules_provider.registry.html new file mode 100644 index 0000000..f57d440 --- /dev/null +++ b/docs/variables/modules_provider.registry.html @@ -0,0 +1 @@ +registry | @sentinel-official/sentinel-js-sdk

Variable registryConst

registry: ReadonlyArray<[string, GeneratedType]> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_session.MsgEndTypeUrl.html b/docs/variables/modules_session.MsgEndTypeUrl.html new file mode 100644 index 0000000..c837231 --- /dev/null +++ b/docs/variables/modules_session.MsgEndTypeUrl.html @@ -0,0 +1 @@ +MsgEndTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgEndTypeUrlConst

MsgEndTypeUrl: "/sentinel.session.v2.MsgEndRequest" = "/sentinel.session.v2.MsgEndRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_session.MsgStartTypeUrl.html b/docs/variables/modules_session.MsgStartTypeUrl.html new file mode 100644 index 0000000..58307fe --- /dev/null +++ b/docs/variables/modules_session.MsgStartTypeUrl.html @@ -0,0 +1 @@ +MsgStartTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgStartTypeUrlConst

MsgStartTypeUrl: "/sentinel.session.v2.MsgStartRequest" = "/sentinel.session.v2.MsgStartRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_session.MsgUpdateDetailsTypeUrl.html b/docs/variables/modules_session.MsgUpdateDetailsTypeUrl.html new file mode 100644 index 0000000..8c7791e --- /dev/null +++ b/docs/variables/modules_session.MsgUpdateDetailsTypeUrl.html @@ -0,0 +1 @@ +MsgUpdateDetailsTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgUpdateDetailsTypeUrlConst

MsgUpdateDetailsTypeUrl: "/sentinel.session.v2.MsgUpdateDetailsRequest" = "/sentinel.session.v2.MsgUpdateDetailsRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_session.registry.html b/docs/variables/modules_session.registry.html new file mode 100644 index 0000000..230621f --- /dev/null +++ b/docs/variables/modules_session.registry.html @@ -0,0 +1 @@ +registry | @sentinel-official/sentinel-js-sdk

Variable registryConst

registry: ReadonlyArray<[string, GeneratedType]> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_subscription.MsgAllocateTypeUrl.html b/docs/variables/modules_subscription.MsgAllocateTypeUrl.html new file mode 100644 index 0000000..7146374 --- /dev/null +++ b/docs/variables/modules_subscription.MsgAllocateTypeUrl.html @@ -0,0 +1 @@ +MsgAllocateTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgAllocateTypeUrlConst

MsgAllocateTypeUrl: "/sentinel.subscription.v2.MsgAllocateRequest" = "/sentinel.subscription.v2.MsgAllocateRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_subscription.MsgCancelTypeUrl.html b/docs/variables/modules_subscription.MsgCancelTypeUrl.html new file mode 100644 index 0000000..2aa3b23 --- /dev/null +++ b/docs/variables/modules_subscription.MsgCancelTypeUrl.html @@ -0,0 +1 @@ +MsgCancelTypeUrl | @sentinel-official/sentinel-js-sdk

Variable MsgCancelTypeUrlConst

MsgCancelTypeUrl: "/sentinel.subscription.v2.MsgCancelRequest" = "/sentinel.subscription.v2.MsgCancelRequest"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/modules_subscription.registry.html b/docs/variables/modules_subscription.registry.html new file mode 100644 index 0000000..098eba8 --- /dev/null +++ b/docs/variables/modules_subscription.registry.html @@ -0,0 +1 @@ +registry | @sentinel-official/sentinel-js-sdk

Variable registryConst

registry: ReadonlyArray<[string, GeneratedType]> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 2f78c39..93daa87 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "sentinel-js-sdk", + "name": "@sentinel-official/sentinel-js-sdk", "version": "1.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "sentinel-js-sdk", + "name": "@sentinel-official/sentinel-js-sdk", "version": "1.0.0", "license": "ISC", "dependencies": { @@ -15,6 +15,7 @@ }, "devDependencies": { "ts-proto": "^1.167.0", + "typedoc": "^0.25.8", "typescript": "^5.3.3" } }, @@ -258,6 +259,12 @@ "undici-types": "~5.26.4" } }, + "node_modules/ansi-sequence-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ansi-sequence-parser/-/ansi-sequence-parser-1.1.1.tgz", + "integrity": "sha512-vJXt3yiaUL4UU546s3rPXlsry/RnM730G1+HkpKE012AN0sx1eOrxSu95oKDIonskeLTijMgqWZ3uDEe3NFvyg==", + "dev": true + }, "node_modules/asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -273,6 +280,12 @@ "proxy-from-env": "^1.1.0" } }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true + }, "node_modules/base64-js": { "version": "1.5.1", "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz", @@ -302,6 +315,15 @@ "resolved": "https://registry.npmjs.org/bn.js/-/bn.js-5.2.1.tgz", "integrity": "sha512-eXRvHzWyYPBuB4NBy0cmYQjGitUrtqwbvlzP3G6VFnNRbsZQIxQ10PbKKHt8gZ/HW/D/747aDl+QkDqg3KQLMQ==" }, + "node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0" + } + }, "node_modules/brorand": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/brorand/-/brorand-1.1.0.tgz", @@ -567,6 +589,12 @@ "ws": "*" } }, + "node_modules/jsonc-parser": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.1.tgz", + "integrity": "sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==", + "dev": true + }, "node_modules/libsodium-sumo": { "version": "0.7.13", "resolved": "https://registry.npmjs.org/libsodium-sumo/-/libsodium-sumo-0.7.13.tgz", @@ -585,6 +613,24 @@ "resolved": "https://registry.npmjs.org/long/-/long-5.2.3.tgz", "integrity": "sha512-lcHwpNoggQTObv5apGNCTdJrO69eHOZMi4BNC+rTLER8iHAqGrUVeLh/irVIM7zTw2bOXA8T6uNPeujwOLg/2Q==" }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true + }, + "node_modules/marked": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", + "integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==", + "dev": true, + "bin": { + "marked": "bin/marked.js" + }, + "engines": { + "node": ">= 12" + } + }, "node_modules/mime-db": { "version": "1.52.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", @@ -614,6 +660,21 @@ "resolved": "https://registry.npmjs.org/minimalistic-crypto-utils/-/minimalistic-crypto-utils-1.0.1.tgz", "integrity": "sha512-JIYlbt6g8i5jKfJ3xz7rF0LXmv2TkDxBLUkiBeZ7bAx4GnnNMr8xFpGnOxn6GhTEHx3SjRrZEoU+j04prX1ktg==" }, + "node_modules/minimatch": { + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", + "dev": true, + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", @@ -656,6 +717,18 @@ "resolved": "https://registry.npmjs.org/readonly-date/-/readonly-date-1.0.0.tgz", "integrity": "sha512-tMKIV7hlk0h4mO3JTmmVuIlJVXjKk3Sep9Bf5OH0O+758ruuVkUy2J9SttDLm91IEX/WHlXPSpxMGjPj4beMIQ==" }, + "node_modules/shiki": { + "version": "0.14.7", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.7.tgz", + "integrity": "sha512-dNPAPrxSc87ua2sKJ3H5dQ/6ZaY8RNnaAqK+t0eG7p0Soi2ydiqbGOTaZCqaYvA/uZYfS1LJnemt3Q+mSfcPCg==", + "dev": true, + "dependencies": { + "ansi-sequence-parser": "^1.1.0", + "jsonc-parser": "^3.2.0", + "vscode-oniguruma": "^1.7.0", + "vscode-textmate": "^8.0.0" + } + }, "node_modules/symbol-observable": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/symbol-observable/-/symbol-observable-2.0.3.tgz", @@ -698,6 +771,27 @@ "protobufjs": "^7.2.4" } }, + "node_modules/typedoc": { + "version": "0.25.8", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.8.tgz", + "integrity": "sha512-mh8oLW66nwmeB9uTa0Bdcjfis+48bAjSH3uqdzSuSawfduROQLlXw//WSNZLYDdhmMVB7YcYZicq6e8T0d271A==", + "dev": true, + "dependencies": { + "lunr": "^2.3.9", + "marked": "^4.3.0", + "minimatch": "^9.0.3", + "shiki": "^0.14.7" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 16" + }, + "peerDependencies": { + "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x" + } + }, "node_modules/typescript": { "version": "5.3.3", "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", @@ -716,6 +810,18 @@ "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==" }, + "node_modules/vscode-oniguruma": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/vscode-oniguruma/-/vscode-oniguruma-1.7.0.tgz", + "integrity": "sha512-L9WMGRfrjOhgHSdOYgCt/yRMsXzLDJSL7BPrOZt73gU0iWO4mpqzqQzOz5srxqTvMBaR0XZTSrVWo4j55Rc6cA==", + "dev": true + }, + "node_modules/vscode-textmate": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-8.0.0.tgz", + "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", + "dev": true + }, "node_modules/ws": { "version": "7.5.9", "resolved": "https://registry.npmjs.org/ws/-/ws-7.5.9.tgz", diff --git a/package.json b/package.json index fd30cd6..e26e9ed 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "main": "dist/index.js", "types": "dist/index.d.ts", "scripts": { - "build": "rm -rf dist/* && touch dist/.gitkeep && tsc" + "build": "rm -rf dist/* && touch dist/.gitkeep && tsc", + "docs": "rm -rf docs/* && typedoc" }, "files": [ "dist", @@ -29,6 +30,7 @@ }, "devDependencies": { "ts-proto": "^1.167.0", + "typedoc": "^0.25.8", "typescript": "^5.3.3" } } diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 0000000..3db8013 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,4 @@ +{ + "entryPoints": ["src/index.ts", "src/modules/queries.ts", "src/modules/*/index.ts"], + "out": "docs", +} \ No newline at end of file