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..5020c85 --- /dev/null +++ b/docs/assets/highlight.css @@ -0,0 +1,92 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #001080; + --dark-hl-1: #9CDCFE; + --light-hl-2: #AF00DB; + --dark-hl-2: #C586C0; + --light-hl-3: #0000FF; + --dark-hl-3: #569CD6; + --light-hl-4: #A31515; + --dark-hl-4: #CE9178; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-hl-8: #000000; + --dark-hl-8: #C8C8C8; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/docs/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/docs/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js new file mode 100644 index 0000000..d6f1388 --- /dev/null +++ b/docs/assets/main.js @@ -0,0 +1,59 @@ +"use strict"; +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(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 Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..076e9a9 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAE6WWX2vCMBTFv0ufZWOyjeGrUxAmDO2b+BDaO5uZJqVNwTH23ZfamqTNv0of7b3nxz0nN8HDb8ThwqNFlGSIR7OoQDwTv3KW1gSqx+brQ8ZzIkpnTNNo8TwTrZikJdBocZDyLUuBKD3QOu/U10qf8fY3k8IdI2DVNQW3bEkwUG3ghKCqug3cFvvip3lP3nOLKYfyCyVSb7iev7wO1Pv9yg8QDX4Gwwn4EE3dR9hCVaGTB9E1+BhiyNAgsiXAeQfCkRdz7TApR42TDI5V7qHlRB2b6NyMFhHejVVZstJupNVeGwI+WF4Q4JhRixdZm3CzFCNwv5xxKMKY6+LeEY0TXJOlJRYHyxHSMGgh5DUimP+YQavapMXRMGOSguRsNadjmiZfTmuLKztq7fA4zCkDRATGyKj9PimfDuHKRp8C029I7LdClibNoihTjkqjhE5qYzqygjZ2e8NjKqEgQllgMyBZGhXQru3eAs9YOnw9FKrXdv8jokBT4tYoobi7eT83AZDs88fN2QUn1rfjVpm0jRIyJR0FCYUTG25smNjqzEimRLQiiIMlmltpVDYfiJ7q3t+UdgcV5dZx//opRjjg2DSkpyNJsd3dIOmuyXXvTZzj5h//AdHmH1uBCwAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js new file mode 100644 index 0000000..c0a4001 --- /dev/null +++ b/docs/assets/search.js @@ -0,0 +1 @@ +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE7VdXXPcNrL9L9Kr1jsNfvttoyQb3423Ukl2b91yuVzUiNbQmq9LzthxXP7vS4IA2cB0g8DQ+5CKR9ONA+I00I1DCPpy0xw+tTcv33y5ea73jzcv47ubfbmrbl7erLd1tT/d3N2cm233cXd4PG+r9q/Dj19sTrtt9916W7Zt1TVwc/P1TrchknRs5YemOTRjI/X+VDXvy/XUjvyeaO3u5lg2Pf7Ykal9WImpm5U3wK02dcEM9hhM5CPWvTkkqh2NdM+NjOtZEhDTiB/27ak5r0/ogXiMW9Pc+VD3ziHskTzwBrMJ59Q+/qVu/3Js6o/lqQpGLY/1P6rPPsCj5RJssYonIn8tP31/+HvlQ+Utsg0b40vEXw6tP6QyXor5228/BMFO9mHIaOHYlMSy0f3QuWhM3X59eKymgKz2551yl1/MzK8eGwXctBD9VDW7qhW/NIeft+WujPLv3BC3pAOPOrjS2P88nNuhOdmUgGgOnPa4Dn16kNd1t2CU28z/0bHHlc9enbsG7jurWVjL9Dq8/6uj+Lt7HII0GLa7Dun7qjq2VfV835k0afbdK7UczwA73AL6gWb5YVtRkP3Pr50sf2vbjvhyTz7L2PAtNnP0XfaQxPlXWzVuCGVxVeu/fW5P1c7d/mjjj4DLm9dV25ZP0/jj+kPSNnwfxgPOkg1m19X6rbJ0xZDqLAPV1RMnXN440SbjIEA8dvebQ73mH274+vqR635S/eHT+q22dDyJ6isDtZuJAgw22V4N102507n1QhtNQ8BMkko+Iu7ppO5L0ON8w7fSyNl5HuDw8KFae/T+djS8EmjdVF0V6vM4k+WVUDujOOKBtN21TyRjwhVj4xONlv5QOMC6evP7ansqWShtcH2gzS1sBoLfyjb2mn2omdVttPhvLXAmgM8aN3WaAXyc4wkDauMlgE/Vvmr6+fLuVP3h5A8jX3gt6cL28HRsDg/8TLDAkf0S2Pf1vm4377rVoj3sfbFtp8AO2Mt+Z+Oc/933/7XFX7fttf73Hb0+BYxQvlnAAeeTCEY871zgAHw9mw5GuNd+GcH1dB5JYXo637xgAXrIbdLTR2wz489barPaZ4U2JULV+03V1AOT1uM55RmjtGLB57eo8yh4JjuBBsOrsXhZzQYjRbWF4+mQ2Ej4C5nrW+CzchvZBUpsC+8FrnR2x211qlHOGAW48aslMtzUiI8YN/XmSkmOggsS5qwGrpbnyI4EiXRePfGQ6maGxEOw8xsTh2xHD4aXeOeFzUp4JLCHkOeF6ivnkZ0IF/X4PnlqJFMDXhsJci7i7M6W2CTQrbu2tn3C9zA06sw2xhfWoaDQuHM6ii8wv32ncWe28Q5YI4ou0wID7UoSQdHE1PcslLPQp7yuqPh58LnSP6QDrj0A34PZzUBQFxyFuqMLcxX7XBc8SnfUhE8BT8F4l/Ek1nXFvN0UW2xfTrSZ7hge8+N+ZflNY4cX4UE9oetgR1fCSuGgvrBluaM7wcW5o0dI2SnXp3O5rU/T0Qddok9feR+vud9U62dqnqO2pI17oqFOcRlzfWjIOoQEutXmc3CDT3B1QIO6iwNfUL42YB7VXRo4YDGRP16GBY38oytIgiilUzQP5UrRpFd4inaAz6TooA44UrSjB3MpOqwLfSzMRdlFD7TTlR2YT9A4Wj0SNBlkvgmaxroqQV80xSUDYprNdMfwmJ/i1yVoBjs4QYf1hMyIrq4EpcOwvnAJ2tWd0ATt6tE0MzdVuT1tLpLz8GNnYvaYX6oVn7ml+hE+ry4xrppTRjMcdz9JI7MKcfTDNHc997UziQANnkX+PSBDlutCUKz694GbOVw3QmcN1xNcpvWpmRKdx2+WF7RTUx717NQjJv3272jLh5qrtyiwW9NnBvjKwpYEdte1npB8WUtizlS1PCgm89VFYJCwrxxREkIqXdByOK5ylvAJL2ZZ4JlSNgDcUciy6HNlbAg8W8Ty6O4SdgZ8PsGiwPTIsVRI+aZZEumqTGu3xC33l9PJ3RdsPzuNr0u3NHBwxg3qB5ntHB0JynZBPeFSr6MzodnX0R90SLg6brtpd6wvEvD4jedL318H+9fVaXOYlpXhzdfUlmHlnmFT18iXbr+W+8eDfUTbBXQ7eszgmb40+o/ls3103omt7L8B8n23BD8dms8h6MjnG/Tgddk+h6Ar+2uRvWq8qRmPGo+MLJyd9tWnd13NtjuS2ZnCujVc5h71ugqPxHVXeJ6QfIVHYs5UeDwoplLR/csrN+xotpBSusLjcFwVHuETXuGxwDMVXgC4o8Jj0ecqvBB4tsLj0d0V3gz4fIWHAtOjwqNCyrfCI5GuqvDsltiq4mI6ufuC7Wen8XUVHgMcWuEF9YMsqhwdCaqognrCVXiOzoRWeI7+oMM5hz/qNfXOUH+xXGAZW/LIvWN3Qt8WEiAz7wpNj+B0SwG6s60fIJ9syUd051oWEhP3ux0CFObvfDgE0EenWRrElWQvPMJTLAM6k2C9gR3plUGeS67+0Gxq5ZDdidUJPJ9Wpxj0yKpEAPkmVQrnqpxqNcQt4xfTxtkRZD03Va9LpyRqcDYN6QWZv/huBOWukH5wqZTvSmgm5XuDEmlT7tvtcGeIlUn1N55Syc/l/umMf+t32ERPzWiDmak0dojcpv/tfVM/l/t96wdzi+1nAEdPBnm3KZt67Ys7Wi9EbcoHf1BtvBRzV+3rcu+NOpovxP2zah7K+oM/MnZYhv1d2f7/2TN2b0fjhZjVtmzOrf9IGw5LsfdP5bb2BtbWC1EPbUBgTdbLUO/LU7n1Rp2sF6J25cmm8kYdrRejNofnyjeSkflS3Hpftf6w2nohanMoT/4BhcwX4v7ZseULqmyXIX5f9r/L7Ak5Gi/EPJ+8n1LbLkP8Yf+09X/MyXohans6BCxLyHwZ7o/1B3/U0Xgp5rY+1vuDN+povhR3HxDAk/VC1M7eO4RH42WYf+8S5dqfV2S+ELc6NE8BuJP5UtxmF4CqjBdiNlVlv61jIZXtQsTzh7Lpkocv6GS+DPensg5IcJP1QtTqoak++YJq44WY3Q98h1fbLkQ8d1VtEzC6yH4Z8qt1V8l3j+C7scP2C5H3j4eu9PJ/aMNhIXbjnwG07ULErpQPeNTRehnq/5THMqAYRubLcP9R7vflY+kJO1kvRf2zfPaldTReiHloKm9aR+NlmD+Xp4/+sTRZL0StT5tzGVCdGg7LsF+X6+oxpDI2HJZib8vP4I2rjL8BpgjBFN8Gs/vPPvPlhFX2i5FP/ovUZL0UtSuLNr55frJehvrP6ugvdo3GCzEPzacqoCDH9suQf6magAQ/WS9EPQRs3UfjpZjN6fx09g9jw2EZ9q+HXci6jMwX4p7bAHYn62Wov5W7gzfoaLwQs2oe/J90sl6Iuj18LH03l6PxcsyQVy7Yfily+bHL2L4bEWS+EPcYImhO1gtRP5Wb2jsRTNZLUavHgGcdrZeh/l7uavu+Mg5T2y5ErLbd2uoLqY0XYm5KXzqV6UK8c/Psz+VkvQz1X89NWQesD9h+IXLz6MuoMl2G97/V1nt0te0yxH/X1an/p3cNYThcgW0cYlOGzO8ETu0gwyvOT/idRWTB5o4kUo4c/OnaJ741Pb9BV9jLxxydcF9AFgTvODLpYGLm5ORMB6jY8wyGa87teByiZHCcxygvfa44SMkBzx2l9Ad3Habk0GePU/rDP1Tt6V3wdFP9IJy/eYfeBUxAplvvQueju3MBayPuUOjyyHYCPZnnwlBdrI0hi4PREY8zsWMDXodiCRDvU7EU0nXHYq2W2HOxF6uhuy/Yfm64rz0bSwKHH44N6Qd9JJXvSNiB1JCesOdj+c4EH5C96M/bO/WrEy+/3HzshbFu5Xt5I15EL4rO8X1dbR+7Rt8MHb3rr7jb9X5v1Xf/rvrY7C0Gk7+ubu7erO4ieJGm8Pbt3RvtIb+QP5Bm0H2Cuzh9sQJhmIFhJjgzYZhFHGhkmMXdJ3EXic7MbC02zJLuU3SXwAsLMzGs0u5TTFilhlXWfUooyMwwy7tPKWWWG2YdJW8yyqwwB7cf6/wu7uzizBxdi4V+tIu7KH0RJ5ahyQNIIlYkYSYV0A850NSabEA/6t3qSFmahEA/8hCRliYp0I8+xKSlSQz0BEBCWprcQM9Bt32iLE16oKcBMiIowCRI9DRAThgKkyAh50lBGVoTpWdBkAQJkyARsY8jTIKEnC/09DMJEj0LgqRSmASJngUR3UXJi5VITEuTIJHxT2QSJHoWupqCatMkSBTcxBAmQVFPg+gmbvQiy2JzSTEZinoeREpamhRFkqKMtLSWs4iblpHJUCQZIh8oMhmKJENUIEUmQVHKkh6ZBEU9C9GKatLkJ8pZziOTn6hnIQKqSZOfuCchEoRhbNIT9xxE1Goem+zEPQURtaDHJjlxT0FELhyxlW5iNohik504YYMoNumJUzaIYpOeOOOCKDbpiXM2iGKTnrjg8mxs0pOsuEybmPQkwE3IxKQnEeyoJyY/ScSl3MSkJ4m5pJtY9UDCpd3EJCfpGYhS8nFMchKWnMQkJ8nZxJuY5CQFm3gTk510xSbe1KQnBTbxpiY/qWATb2ryk0Zs4k1NgtKYzSqpyVAqSzYq8aZW0cann9RkKM3YpJKaFKU5x2VqMpQWbHikJkMZn34yk6GMTz+ZyVDGp5/MZCiL2AUhMxnKYm5ByEyCsoRbEDKToIyfQplVWfOltclPxhbXmclPxpbXmUlPLrMPOUC5SU8u009xF69eQGQOem7Sk/ccxCuyTZOePGJjODfpyWM2hnOTnzzhn8gkKE/Z0MxNgvKMDc3c2v3kbGjmJkV5T0QM5HiaHBXsRrQwKSqAC83CZKgQ7BgVJkMFm4IKk6CCTUGFyU/BpqDCpKeQ21KqMCpMdoqMHR+TnCJnx8fanEpuqFKrsLenK258hq+wKXAjNHyFTQU3RsNX2LSnIY7pHbK1S13F7BQevsO2PRlxQm0AV9ZGdcVnouE7bMvnouE7bJs7Hs3arq4Kdi4P3yFbqRzQsxkuVAVg5zPYwoKUD+gZDba0AKzOA7a2AKzWA7a4ICUEZsRseUGKCHTk2vqCVBHoyLUFBikj0JFrKwxSSIjJ/AiWyABSS4hJOcKSGUCqCTElSICwlSBJGLWTBEtpAKknJNQOESypAaSgkFA7P7C0BpCKAjMhLbUBpKaQUMshWHIDDHoDPSEtwQEcigNYkgMIB2OW6gAO2QEs3QEcwgNYygM4pAeIbP0u4iekJT9AxNZ/YOkPELEVIFgKBEidgRkxS4OAiK0CwVIhIGLrQLBkCIjYShAsIQKk3pBEZGctLQJivhoES46AmK8HwVIkIOYrQoht0ZWvCcFSJUBqD9yzWaTFfF0IljIBMV8ZgiVOQMzXhmDJExDz1SFYCgUkbH0IlkYBCVshgqVSgNQimBGzdArghQqwlArgpQpIbKmcrRTBUitAahIJnfgsvQKkLJGQlY2lWIDUJZKUNLUIk8JEQmYoS7MAqUwkZIayRAuQ0kRCZihLtQCpTaRkhrJkC5DiREpmKEu3AKlOpGTWsYQLkPpEShXNkNqvNnpKUkqhBEu7AKlQpCRblngBUqNISbYs+QKkSJGSbFn6BUiVIiXZsgQMkDJFSrJlKRggdYqMZMuSMEAKFRnJlqVhgJQqMpItS8UAKVZkJFuWjgFSrchItjL7TVRPSUayZUkZIBWLjGTLEjNgUDNItiw5A6RokZFsWXoGSNUiI9myBA2QskVOsmUpGiB1i5xky5I0QAoXOcmWpWmAVC5yki1L1AApXeQkW5aqAVK7yEm2LFkDpHiRk2xZugZI9SIn2bKEDZD6RU6yZUkbIBWMnGTLEjdAShgFyZalboAUMQqSLUvfACljFCRblsIBUsgoSLYsjQOklFGQbFkqB0gxoyDZsnQOkHJGQbJlKR0gBY2CftFrv+ntKSnoV73Wu14paBTky15L6xCr4X08RZewxA4hBQ1YUXwJS+wQUtCAFUWYsMQOIRUNWFGMCUvtEFLRgBVFmbDUDiEVDVhRnAlL7RCr4fUIRZqw1A4hFQ1YUawJS+0QUtGAFUmbpXYIqWjAin5Jb/E2nKMAkjdL7RDqJAXJmyV3iOEsBZC8WXqHGE5TAMmbpXeI4TwFkLxZgocYTlQAyZuleIjhTAWQvFmShxhOVZDHKoR9rmI4WEGfrLCPVgxnK+jDFRenKyRvguTNPl8xHLAQJG/2CQsxnIEhebPPWEhtAwTJm33KQoobIEje7HMWUtwAQfJmn7SQ4gYIkjf7rIUUN6DbupFnUizipLpBb3eFpXwIqW5wDVvSh5DyBvl2TljKh5DqBnOOxFI+hJQ36L2TsKQPMUgf5NZYWNqHGI5fkFtjYWkfQgoc9NZYWOKHiAbiyIlhqR8iGogjJ4YlfwgpcQB5CkRY8oeIh7fJ5MSw5A8hJQ5yey4s9UMM6ge14xWW+CFiB2uW+CEG8YNu1iJN6hvk9lxY0oeQ8ga5PRdK+ZAHMj9Wzal6fDUczHzz5qacLvX8cvNOHdicfrPhy02/tX755evX6YRm/6lvv9T3ciLHDDsWnOOxfq4+Y794cks5J3UhJwLLEVi3Vef8durXO5FngT2B82zbuj2V/eHtyRXwE7IPiC7TnFzTFUYVjO+DuhAT+QH2izg/dKEl8hXYN2Z91Z2UyDHCjgnrOB3ZR2MUoSftJ6vD2fi9CNSEQOT264hfE/p3GHBDBW6IY+xB34+JRiDGI8CF5VpfcYkcE+yY8Y7qT+6guMQRIjim15vSCEk8DeRY392IYvh/wsV230bbGqxFqNtxpPy5KF3rOzbRY+NFI+UYWw9/IwDBIn5yGGD715/DP0Si/hHzTzJcXY4WEzRfcjUQ/Ru/4R9RpFvkYmE9XuSJHg5P+5T3VHdxIkfMTsZNhfXmUK8NP4Emrh4Edv4O7sYg4PkTqdGM8+H/GRtZ6ndVpmZQQKrQUsMXq4HNVNuF+rrI9IDrcdbovfo9BGfMRtX4Z+6NCEGBlaRqKDQ8Oy/x77egYUExrkJc9SpTg1yoGCxy/SC6/5GOxQT0g7ADedifrJEUgNdENZZs7/WvriF/FIGRCuZYjUamPudjn/VE0pague/rNw5T3+iKohcnyoydgsO1rJNbhtexjGP7UV1EgPxwpmOj9LGqjm1VPa+7tb5Js4daMW0s+3gNViHJps4uZZxKI+JQP9iU8Thc04p6j3Ntxs3VSt+0ihxxrs24XFs1jRnLeLAUuZzreM0qAsXpjZ1G6K+w4/FBi0uu5k+u5w/XiffyL9yhZRrHlmC91F2tqOMGtVw0vx9vW0WeOENlXIZ6X/dh+a6bga21DqERY5ew9/q6VQSLc0fGhdN7dWUq8sOpI+dSx9N46SnyxEObc9P2qdpXTb/MvDtVfxizJ8LLJAs83nqKShE88XNujJ7UzaXID8dyzs3Tp+H6UeSGZ1zOzbin8QJR5ImnXM5NuY2+AxQ54mmTc9NG/6F3FO2oq4Xb7aJEilFnCy5+NurqUNRVPFFybqJ0xc6uasWxOWy35a6M8gdjjTEqUpUxuZkzNbXrNk5Nuc3MtjBbKgOy27bNcC0peho8eXO2C9O9osgVT8CcG8B6uhgUueI5WHCdrc1MjcY9UqtjrJ4306ulytz9aTiVqVc6U6c6U3NhOeBgRBQgQrlHKuGn6nOu67GVhha6VGPLmBpdWIrGBK8uBbe6oL/cjiIZz57V2KOxbGGfuLHW1ALHJZtyan0LKXLEK03BPfiH8R5R5InDt+AWm2d9FShyxGtNwT3is7rOE/nhwWLXjGd1JSfyw/O+4Ob9Vt+mgvef2DPhPdV9nAgST86Cm5xbdJ8m8jUUFW52bg9P3bryYOxxIjSw7P5why7SRKBYXlhx83qnLsNEflhNWPGYw4WWeB3FksiKC9jddCUl9sVbhxUXszt9rST2xLvIFRezO301JPbES8qKC9qd/Mu9KIDw7BIsXtW2VuQJPDwqzwguAC9EHrwgqVJYb/NjtcglehMw7oM4Dvbqzko8GDEeDG4m7qtzl/N6ZcXKe3j+6608Fzr4zwSjccVrj2A7MF17iTuf4M5zY7o/nNshf8syQEBkPgMmVotD3FzV174getH6ECmGYjUUmfqcj8qBzoTaEjSJgt0wH/XNm/jBU/zg3KJ0PNjbsf5NLnLknvKI7r/EznhlAW5l6dey8qG2N1YxXoDZWdeov1OO/HCZIrjYaspPj4enyoysyVHPFEVvpj4XY5rWvICuICJNmfYRMd/nDvsob5RA8gLaRipwXSepz4UWX1Y6FvRuHnSBA9pHxFx0SPC2rWx8xLMWTHVQqs+F1nxWWkgBDRvpyk37iJibXOrvsO6Gv1yOecO5T3DBMv2hYeyKUy7ovoixnGTH4rA1A9aoq/U8Y513F/m7P6CAIp4NPn17Kl5U8KoP3ILcqitQsSPOiMD19uLFRIzw8lEZ0+km4sa/1deh4h7gzApcpmvHOz6xK16QgYuZVl2Hih1xTmZr5Xa60BT74hQGXHC0xwtNDnCACOCW0W52XYrY+D0Qqzt2nhcCHH5pw26D9P1tyA0/pN7/qPUiH1cSvYBoC9CbMxGxkaSvL8XjgrME+yqw1VeQYk+cIthZ335uT5VZCBoTjXE7DfePYjjsxvupS0Txft0oyrjpeSEeoXFhXxye5AWiGAvPaHb9mf5WNcpguLyKx130KNaz/Z5unUKN4T1XMu7ExwzDTXT2NSYOEr04i4glwbh7DJeQxtsD1l3fkYp7gBcqtiQ/T7ecYl+84AiOy7O8rBS74WnIVqv9VVQ4bNBLHs6jW4gNIGMTxzh9RFeM4j7iVU1wq9qn4VpU7IcXb3aH8rmO4gf7PS0YL5TV6kRG59u7m2N9rLb1vjN+8/br1/8AZYAZ+0y9AAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css new file mode 100644 index 0000000..778b949 --- /dev/null +++ b/docs/assets/style.css @@ -0,0 +1,1412 @@ +: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 */ +footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} +.tsd-generator { + margin: 0 1em; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h4, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through !important; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/docs/classes/chat.Client.html b/docs/classes/chat.Client.html new file mode 100644 index 0000000..16d0137 --- /dev/null +++ b/docs/classes/chat.Client.html @@ -0,0 +1,15 @@ +Client | predictionguard

Class Client

Client provides access to the chat apis.

+

Hierarchy (view full)

Constructors

constructor +

Methods

Chat +ChatSSE +RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Methods

Chat

  • Chat(model, input, maxTokens, temperature): Promise<[Chat, null | Error]>

  • Chat generates chat completions based on a conversation history.

    +

    Parameters

    • model: chat.Model

      The title of the book.

      +
    • input: Message[]

      The author of the book.

      +
    • maxTokens: number
    • temperature: number

    Returns Promise<[Chat, null | Error]>

ChatSSE

  • ChatSSE(model, input, maxTokens, temperature, onMessage): Promise<null | Error>

  • ChatSSE generates chat completions based on a conversation history.

    +

    Parameters

    • model: chat.Model
    • input: Message[]
    • maxTokens: number
    • temperature: number
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          Returns void

    Returns Promise<null | Error>

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorChatChatSSERawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/client.Client.html b/docs/classes/client.Client.html new file mode 100644 index 0000000..bf872a7 --- /dev/null +++ b/docs/classes/client.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to make raw http request calls.

+

Hierarchy (view full)

Constructors

constructor +

Properties

apiKey +url +

Methods

RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Properties

Private apiKey

apiKey: string

Private url

url: string

Methods

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorapiKeyurlRawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/completion.Client.html b/docs/classes/completion.Client.html new file mode 100644 index 0000000..fa9203e --- /dev/null +++ b/docs/classes/completion.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the completion api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

Completion +RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Methods

Completion

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorCompletionRawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/factuality.Client.html b/docs/classes/factuality.Client.html new file mode 100644 index 0000000..5e799ab --- /dev/null +++ b/docs/classes/factuality.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the factuality api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

Factuality +RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Methods

Factuality

  • Factuality(reference, text): Promise<[Factuality, null | Error]>

  • Factuality checks the factuality of a given text compared to a reference.

    +

    Parameters

    • reference: string
    • text: string

    Returns Promise<[Factuality, null | Error]>

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorFactualityRawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/health.Client.html b/docs/classes/health.Client.html new file mode 100644 index 0000000..2049e55 --- /dev/null +++ b/docs/classes/health.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the health apis.

+

Hierarchy (view full)

Constructors

constructor +

Methods

HealthCheck +RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Methods

HealthCheck

  • HealthCheck(): Promise<[string, null | Error]>

  • HealthCheck validates the PG API Service is available.

    +

    Returns Promise<[string, null | Error]>

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorHealthCheckRawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/injection.Client.html b/docs/classes/injection.Client.html new file mode 100644 index 0000000..aea39af --- /dev/null +++ b/docs/classes/injection.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the injection api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

Injection +RawDoGet +RawDoPost +RawDoSSEPost +

Constructors

constructor

Methods

Injection

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Settings

Member Visibility

Theme

On This Page

constructorInjectionRawDoGetRawDoPostRawDoSSEPost
\ No newline at end of file diff --git a/docs/classes/replacepi.Client.html b/docs/classes/replacepi.Client.html new file mode 100644 index 0000000..af70477 --- /dev/null +++ b/docs/classes/replacepi.Client.html @@ -0,0 +1,12 @@ +Client | predictionguard

Class Client

Client provides access to the replacepi api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

RawDoGet +RawDoPost +RawDoSSEPost +ReplacePI +

Constructors

constructor

Methods

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

ReplacePI

Settings

Member Visibility

Theme

On This Page

constructorRawDoGetRawDoPostRawDoSSEPostReplacePI
\ No newline at end of file diff --git a/docs/classes/toxicity.Client.html b/docs/classes/toxicity.Client.html new file mode 100644 index 0000000..d796634 --- /dev/null +++ b/docs/classes/toxicity.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the toxicity api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

RawDoGet +RawDoPost +RawDoSSEPost +Toxicity +

Constructors

constructor

Methods

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Toxicity

Settings

Member Visibility

Theme

On This Page

constructorRawDoGetRawDoPostRawDoSSEPostToxicity
\ No newline at end of file diff --git a/docs/classes/translate.Client.html b/docs/classes/translate.Client.html new file mode 100644 index 0000000..4dc1cc1 --- /dev/null +++ b/docs/classes/translate.Client.html @@ -0,0 +1,11 @@ +Client | predictionguard

Class Client

Client provides access to the translate api.

+

Hierarchy (view full)

Constructors

constructor +

Methods

RawDoGet +RawDoPost +RawDoSSEPost +Translate +

Constructors

constructor

Methods

RawDoGet

  • RawDoGet(endpoint): Promise<[any, null | Error]>

  • RawDoGet performs a raw GET call.

    +

    Parameters

    • endpoint: string

    Returns Promise<[any, null | Error]>

RawDoPost

  • RawDoPost(endpoint, body): Promise<[any, null | Error]>

  • RawDoPost performs a raw POST call.

    +

    Parameters

    • endpoint: string
    • body: any

    Returns Promise<[any, null | Error]>

RawDoSSEPost

  • RawDoSSEPost(endpoint, body, onMessage): Promise<null | Error>

  • RawDoSSEPost performs a raw SSE POST call.

    +

    Parameters

    • endpoint: string
    • body: any
    • onMessage: ((event, err) => void)
        • (event, err): void

        • Parameters

          • event: null | ServerSentEvent
          • err: null | Error

          Returns void

    Returns Promise<null | Error>

Translate

Settings

Member Visibility

Theme

On This Page

constructorRawDoGetRawDoPostRawDoSSEPostTranslate
\ No newline at end of file diff --git a/docs/enums/chat.Model.html b/docs/enums/chat.Model.html new file mode 100644 index 0000000..3253ad5 --- /dev/null +++ b/docs/enums/chat.Model.html @@ -0,0 +1,8 @@ +Model | predictionguard

Enumeration Model

Models represents the set of models that can be used.

+

Enumeration Members

DeepseekCoder67BInstruct +Hermes2ProLlama38B +Hermes2ProMistral7B +NeuralChat7B +NousHermesLlama213B +Yi34BChat +

Enumeration Members

DeepseekCoder67BInstruct

DeepseekCoder67BInstruct: "deepseek-coder-6.7b-instruct"

Hermes2ProLlama38B

Hermes2ProLlama38B: "Hermes-2-Pro-Llama-3-8B"

Hermes2ProMistral7B

Hermes2ProMistral7B: "Hermes-2-Pro-Mistral-7B"

NeuralChat7B

NeuralChat7B: "Neural-Chat-7B"

NousHermesLlama213B

NousHermesLlama213B: "Nous-Hermes-Llama-213B"

Yi34BChat

Yi34BChat: "Yi-34B-Chat"

Settings

Member Visibility

Theme

On This Page

DeepseekCoder67BInstructHermes2ProLlama38BHermes2ProMistral7BNeuralChat7BNousHermesLlama213BYi34BChat
\ No newline at end of file diff --git a/docs/enums/chat.Role.html b/docs/enums/chat.Role.html new file mode 100644 index 0000000..414a0aa --- /dev/null +++ b/docs/enums/chat.Role.html @@ -0,0 +1,5 @@ +Role | predictionguard

Enumeration Role

Role represents the set of roles that can be used.

+

Enumeration Members

Assistant +System +User +

Enumeration Members

Assistant

Assistant: "assistant"

System

System: "system"

User

User: "user"

Settings

Member Visibility

Theme

On This Page

AssistantSystemUser
\ No newline at end of file diff --git a/docs/enums/completion.Model.html b/docs/enums/completion.Model.html new file mode 100644 index 0000000..ac7ad9a --- /dev/null +++ b/docs/enums/completion.Model.html @@ -0,0 +1,8 @@ +Model | predictionguard

Enumeration Model

Models represents the set of models that can be used.

+

Enumeration Members

DeepseekCoder67BInstruct +Hermes2ProLlama38B +Hermes2ProMistral7B +NeuralChat7B +NousHermesLlama213B +Yi34BChat +

Enumeration Members

DeepseekCoder67BInstruct

DeepseekCoder67BInstruct: "deepseek-coder-6.7b-instruct"

Hermes2ProLlama38B

Hermes2ProLlama38B: "Hermes-2-Pro-Llama-3-8B"

Hermes2ProMistral7B

Hermes2ProMistral7B: "Hermes-2-Pro-Mistral-7B"

NeuralChat7B

NeuralChat7B: "Neural-Chat-7B"

NousHermesLlama213B

NousHermesLlama213B: "Nous-Hermes-Llama-213B"

Yi34BChat

Yi34BChat: "Yi-34B-Chat"

Settings

Member Visibility

Theme

On This Page

DeepseekCoder67BInstructHermes2ProLlama38BHermes2ProMistral7BNeuralChat7BNousHermesLlama213BYi34BChat
\ No newline at end of file diff --git a/docs/enums/replacepi.ReplaceMethod.html b/docs/enums/replacepi.ReplaceMethod.html new file mode 100644 index 0000000..1e6c3f9 --- /dev/null +++ b/docs/enums/replacepi.ReplaceMethod.html @@ -0,0 +1,6 @@ +ReplaceMethod | predictionguard

Enumeration ReplaceMethod

ReplaceMethod represents the set of replace methods that can be used.

+

Enumeration Members

Category +Fake +Mask +Random +

Enumeration Members

Category

Category: "category"

Fake

Fake: "fake"

Mask

Mask: "mask"

Random

Random: "random"

Settings

Member Visibility

Theme

On This Page

CategoryFakeMaskRandom
\ No newline at end of file diff --git a/docs/enums/translate.Language.html b/docs/enums/translate.Language.html new file mode 100644 index 0000000..af54021 --- /dev/null +++ b/docs/enums/translate.Language.html @@ -0,0 +1,73 @@ +Language | predictionguard

Enumeration Language

Languages represents the set of languages that can be used.

+

Enumeration Members

Afrikanns +Amharic +Arabic +Armenian +Azerbaijan +Basque +Belarusian +Bengali +Bosnian +Catalan +Chechen +Cherokee +Chinese +Croatian +Czech +Danish +Dutch +English +Estonian +Fijian +Filipino +Finnish +French +Galician +Georgian +German +Greek +Gujarati +Haitian +Hebrew +Hindi +Hungarian +Icelandic +Indonesian +Irish +Italian +Japanese +Kannada +Kazakh +Korean +Latvian +Lithuanian +Macedonian +Malay1 +Malay2 +Malayalam +Maltese +Marathi +Nepali +Norwegian +Persian +Polish +Portuguese +Romanian +Russian +Samoan +Serbian +Slavonic +Slovak +Slovenian +Spanish +Swahili +Swedish +Tamil +Telugu +Thai +Turkish +Ukrainian +Urdu +Vietnamese +Welsh +

Enumeration Members

Afrikanns

Afrikanns: "afr"

Amharic

Amharic: "amh"

Arabic

Arabic: "ara"

Armenian

Armenian: "hye"

Azerbaijan

Azerbaijan: "aze"

Basque

Basque: "eus"

Belarusian

Belarusian: "bel"

Bengali

Bengali: "ben"

Bosnian

Bosnian: "bos"

Catalan

Catalan: "cat"

Chechen

Chechen: "che"

Cherokee

Cherokee: "chr"

Chinese

Chinese: "zho"

Croatian

Croatian: "hrv"

Czech

Czech: "ces"

Danish

Danish: "dan"

Dutch

Dutch: "nld"

English

English: "eng"

Estonian

Estonian: "est"

Fijian

Fijian: "fij"

Filipino

Filipino: "fil"

Finnish

Finnish: "fin"

French

French: "fra"

Galician

Galician: "glg"

Georgian

Georgian: "kat"

German

German: "deu"

Greek

Greek: "ell"

Gujarati

Gujarati: "guj"

Haitian

Haitian: "hat"

Hebrew

Hebrew: "heb"

Hindi

Hindi: "hin"

Hungarian

Hungarian: "hun"

Icelandic

Icelandic: "isl"

Indonesian

Indonesian: "ind"

Irish

Irish: "gle"

Italian

Italian: "ita"

Japanese

Japanese: "jpn"

Kannada

Kannada: "kan"

Kazakh

Kazakh: "kaz"

Korean

Korean: "kor"

Latvian

Latvian: "lav"

Lithuanian

Lithuanian: "lit"

Macedonian

Macedonian: "mkd"

Malay1

Malay1: "msa"

Malay2

Malay2: "zlm"

Malayalam

Malayalam: "mal"

Maltese

Maltese: "mlt"

Marathi

Marathi: "mar"

Nepali

Nepali: "nep"

Norwegian

Norwegian: "nor"

Persian

Persian: "fas"

Polish

Polish: "pol"

Portuguese

Portuguese: "por"

Romanian

Romanian: "ron"

Russian

Russian: "rus"

Samoan

Samoan: "smo"

Serbian

Serbian: "srp"

Slavonic

Slavonic: "chu"

Slovak

Slovak: "slk"

Slovenian

Slovenian: "slv"

Spanish

Spanish: "spa"

Swahili

Swahili: "swh"

Swedish

Swedish: "swe"

Tamil

Tamil: "tam"

Telugu

Telugu: "tel"

Thai

Thai: "tha"

Turkish

Turkish: "tur"

Ukrainian

Ukrainian: "ukr"

Urdu

Urdu: "urd"

Vietnamese

Vietnamese: "vie"

Welsh

Welsh: "cym"

Settings

Member Visibility

Theme

On This Page

AfrikannsAmharicArabicArmenianAzerbaijanBasqueBelarusianBengaliBosnianCatalanChechenCherokeeChineseCroatianCzechDanishDutchEnglishEstonianFijianFilipinoFinnishFrenchGalicianGeorgianGermanGreekGujaratiHaitianHebrewHindiHungarianIcelandicIndonesianIrishItalianJapaneseKannadaKazakhKoreanLatvianLithuanianMacedonianMalay1Malay2MalayalamMalteseMarathiNepaliNorwegianPersianPolishPortugueseRomanianRussianSamoanSerbianSlavonicSlovakSlovenianSpanishSwahiliSwedishTamilTeluguThaiTurkishUkrainianUrduVietnameseWelsh
\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 0000000..2fa5dd7 --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1 @@ +predictionguard

predictionguard

Class Hierarchy

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..36de4fb --- /dev/null +++ b/docs/index.html @@ -0,0 +1,32 @@ +predictionguard

predictionguard

Prediction Guard JS Client

CircleCI +npm version

+

Copyright 2024 Prediction Guard +bill@predictionguard.com

+

Description

This package provides functionality developed to simplify interfacing with Prediction Guard API in JavaScript.

+

Requirements

To access the API, contact us here to get an enterprise access token. You will need this access token to continue.

+

Usage

Install Package

+
    $ npm i predictionguard
+
+

Code Example

+
import * as pg from 'predictionguard';

const client = new pg.chat.Client('https://api.predictionguard.com', process.env.PGKEY);

async function Chat() {
    const input = [
        {
            role: pg.chat.Role.User,
            content: 'How do you feel about the world in general',
        },
    ];

    var [result, err] = await client.Chat(pg.chat.Model.NeuralChat7B, input, 1000, 1.1);
    if (err != null) {
        console.log('ERROR:' + err.error);
        return;
    }

    console.log('RESULT:' + result.model + ': ' + result.choices[0].message.content);
}

Chat();
+
+

Take a look at the examples directory for more examples.

+

Docs

You can find the Prediction Guard API docs on the Prediction Guard website.

+

API Docs

+

API Reference

+

Getting started

Once you have your api key you can use the makefile to run curl commands for the different api endpoints. For example, make curl-injection will connect to the injection endpoint and return the injection response. The makefile also allows you to run the different examples such as make js-injection to run the Go injection example.

+

** Running The Project**

+

You will need to node before you can run the project. You can follow this link or use brew which is what I do.

+

After you clone the repo and install node, run the install command inside the root of the project folder.

+
$ make install
+
+

Then run the test command to make sure everything is working.

+
$ make test
+
+

Finally you can try running one of the JS examples.

+
$ make js-chat
+
+

Licensing

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+
+

Copyright 2024 Prediction Guard

+

Settings

Member Visibility

Theme

On This Page

Prediction Guard JS Client
\ No newline at end of file diff --git a/docs/interfaces/chat.Chat.html b/docs/interfaces/chat.Chat.html new file mode 100644 index 0000000..0eba2d1 --- /dev/null +++ b/docs/interfaces/chat.Chat.html @@ -0,0 +1,7 @@ +Chat | predictionguard

Interface Chat

Chat represents the result for the chat call.

+
interface Chat {
    choices: chat.Choice[];
    created: number;
    id: string;
    model: chat.Model;
    object: string;
}

Properties

choices +created +id +model +object +

Properties

choices

choices: chat.Choice[]

created

created: number

id

id: string

model

model: chat.Model

object

object: string

Settings

Member Visibility

Theme

On This Page

choicescreatedidmodelobject
\ No newline at end of file diff --git a/docs/interfaces/chat.ChatSSE.html b/docs/interfaces/chat.ChatSSE.html new file mode 100644 index 0000000..b8030c6 --- /dev/null +++ b/docs/interfaces/chat.ChatSSE.html @@ -0,0 +1,7 @@ +ChatSSE | predictionguard

Interface ChatSSE

ChatSSE represents the result for the sse call.

+
interface ChatSSE {
    Model: chat.Model;
    choices: SSEChoice[];
    created: number;
    id: string;
    object: string;
}

Properties

Model +choices +created +id +object +

Properties

Model

Model: chat.Model

choices

choices: SSEChoice[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

Modelchoicescreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/chat.Choice.html b/docs/interfaces/chat.Choice.html new file mode 100644 index 0000000..407ed9a --- /dev/null +++ b/docs/interfaces/chat.Choice.html @@ -0,0 +1,5 @@ +Choice | predictionguard

Interface Choice

Choice represents a choice for the chat call.

+
interface Choice {
    index: number;
    message: Message;
    status: string;
}

Properties

index +message +status +

Properties

index

index: number

message

message: Message

status

status: string

Settings

Member Visibility

Theme

On This Page

indexmessagestatus
\ No newline at end of file diff --git a/docs/interfaces/chat.Message.html b/docs/interfaces/chat.Message.html new file mode 100644 index 0000000..f540278 --- /dev/null +++ b/docs/interfaces/chat.Message.html @@ -0,0 +1,4 @@ +Message | predictionguard

Interface Message

Message represents the role of the sender and the content to process.

+
interface Message {
    content: string;
    role: Role;
}

Properties

content +role +

Properties

content

content: string

role

role: Role

Settings

Member Visibility

Theme

On This Page

contentrole
\ No newline at end of file diff --git a/docs/interfaces/chat.SSEChoice.html b/docs/interfaces/chat.SSEChoice.html new file mode 100644 index 0000000..f831eda --- /dev/null +++ b/docs/interfaces/chat.SSEChoice.html @@ -0,0 +1,7 @@ +SSEChoice | predictionguard

Interface SSEChoice

SSEChoice represents a choice for the sse call.

+
interface SSEChoice {
    delta: SSEDelta;
    finish_reason: string;
    generated_text: string;
    index: number;
    logprobs: number;
}

Properties

delta +finish_reason +generated_text +index +logprobs +

Properties

delta

delta: SSEDelta

finish_reason

finish_reason: string

generated_text

generated_text: string

index

index: number

logprobs

logprobs: number

Settings

Member Visibility

Theme

On This Page

deltafinish_reasongenerated_textindexlogprobs
\ No newline at end of file diff --git a/docs/interfaces/chat.SSEDelta.html b/docs/interfaces/chat.SSEDelta.html new file mode 100644 index 0000000..da189a9 --- /dev/null +++ b/docs/interfaces/chat.SSEDelta.html @@ -0,0 +1,3 @@ +SSEDelta | predictionguard

Interface SSEDelta

SSEDelta represents content for the sse call.

+
interface SSEDelta {
    content: string;
}

Properties

content +

Properties

content

content: string

Settings

Member Visibility

Theme

On This Page

content
\ No newline at end of file diff --git a/docs/interfaces/client.Error.html b/docs/interfaces/client.Error.html new file mode 100644 index 0000000..9552602 --- /dev/null +++ b/docs/interfaces/client.Error.html @@ -0,0 +1,2 @@ +Error | predictionguard

Interface Error

interface Error {
    error: string;
}

Properties

error +

Properties

error

error: string

Settings

Member Visibility

Theme

On This Page

error
\ No newline at end of file diff --git a/docs/interfaces/completion.Choice.html b/docs/interfaces/completion.Choice.html new file mode 100644 index 0000000..e8255de --- /dev/null +++ b/docs/interfaces/completion.Choice.html @@ -0,0 +1,6 @@ +Choice | predictionguard

Interface Choice

Choice represents a choice for the completion call.

+
interface Choice {
    index: number;
    model: completion.Model;
    status: string;
    text: string;
}

Properties

index +model +status +text +

Properties

index

index: number

model

model: completion.Model

status

status: string

text

text: string

Settings

Member Visibility

Theme

On This Page

indexmodelstatustext
\ No newline at end of file diff --git a/docs/interfaces/completion.Completion.html b/docs/interfaces/completion.Completion.html new file mode 100644 index 0000000..a46f7e0 --- /dev/null +++ b/docs/interfaces/completion.Completion.html @@ -0,0 +1,6 @@ +Completion | predictionguard

Interface Completion

Completion represents the result for the completion call.

+
interface Completion {
    choices: completion.Choice[];
    created: number;
    id: string;
    object: string;
}

Properties

choices +created +id +object +

Properties

choices

choices: completion.Choice[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

choicescreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/factuality.Check.html b/docs/interfaces/factuality.Check.html new file mode 100644 index 0000000..177631f --- /dev/null +++ b/docs/interfaces/factuality.Check.html @@ -0,0 +1,5 @@ +Check | predictionguard

Interface Check

Check represents the result for the factuality call.

+
interface Check {
    index: number;
    score: number;
    status: string;
}

Properties

index +score +status +

Properties

index

index: number

score

score: number

status

status: string

Settings

Member Visibility

Theme

On This Page

indexscorestatus
\ No newline at end of file diff --git a/docs/interfaces/factuality.Factuality.html b/docs/interfaces/factuality.Factuality.html new file mode 100644 index 0000000..8045921 --- /dev/null +++ b/docs/interfaces/factuality.Factuality.html @@ -0,0 +1,6 @@ +Factuality | predictionguard

Interface Factuality

Factuality represents the result for the factuality call.

+
interface Factuality {
    checks: factuality.Check[];
    created: number;
    id: string;
    object: string;
}

Properties

checks +created +id +object +

Properties

checks

checks: factuality.Check[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

checkscreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/injection.Check.html b/docs/interfaces/injection.Check.html new file mode 100644 index 0000000..46e76c6 --- /dev/null +++ b/docs/interfaces/injection.Check.html @@ -0,0 +1,5 @@ +Check | predictionguard

Interface Check

Check represents the result for the injection call.

+
interface Check {
    index: number;
    probability: number;
    status: string;
}

Properties

index +probability +status +

Properties

index

index: number

probability

probability: number

status

status: string

Settings

Member Visibility

Theme

On This Page

indexprobabilitystatus
\ No newline at end of file diff --git a/docs/interfaces/injection.Injection.html b/docs/interfaces/injection.Injection.html new file mode 100644 index 0000000..6a4e115 --- /dev/null +++ b/docs/interfaces/injection.Injection.html @@ -0,0 +1,6 @@ +Injection | predictionguard

Interface Injection

Injection represents the result for the injection call.

+
interface Injection {
    checks: injection.Check[];
    created: number;
    id: string;
    object: string;
}

Properties

checks +created +id +object +

Properties

checks

checks: injection.Check[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

checkscreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/replacepi.Check.html b/docs/interfaces/replacepi.Check.html new file mode 100644 index 0000000..be41895 --- /dev/null +++ b/docs/interfaces/replacepi.Check.html @@ -0,0 +1,5 @@ +Check | predictionguard

Interface Check

Check represents the result for the pii call.

+
interface Check {
    index: number;
    new_prompt: string;
    status: string;
}

Properties

index +new_prompt +status +

Properties

index

index: number

new_prompt

new_prompt: string

status

status: string

Settings

Member Visibility

Theme

On This Page

indexnew_promptstatus
\ No newline at end of file diff --git a/docs/interfaces/replacepi.ReplacePI.html b/docs/interfaces/replacepi.ReplacePI.html new file mode 100644 index 0000000..6e9469d --- /dev/null +++ b/docs/interfaces/replacepi.ReplacePI.html @@ -0,0 +1,6 @@ +ReplacePI | predictionguard

Interface ReplacePI

ReplacePI represents the result for the pii call.

+
interface ReplacePI {
    checks: replacepi.Check[];
    created: number;
    id: string;
    object: string;
}

Properties

checks +created +id +object +

Properties

checks

checks: replacepi.Check[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

checkscreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/toxicity.Check.html b/docs/interfaces/toxicity.Check.html new file mode 100644 index 0000000..6d6ce3b --- /dev/null +++ b/docs/interfaces/toxicity.Check.html @@ -0,0 +1,5 @@ +Check | predictionguard

Interface Check

Check represents the result for the toxicity call.

+
interface Check {
    index: number;
    score: number;
    status: string;
}

Properties

index +score +status +

Properties

index

index: number

score

score: number

status

status: string

Settings

Member Visibility

Theme

On This Page

indexscorestatus
\ No newline at end of file diff --git a/docs/interfaces/toxicity.Toxicity.html b/docs/interfaces/toxicity.Toxicity.html new file mode 100644 index 0000000..f33aa5d --- /dev/null +++ b/docs/interfaces/toxicity.Toxicity.html @@ -0,0 +1,6 @@ +Toxicity | predictionguard

Interface Toxicity

Toxicity represents the result for the toxicity call.

+
interface Toxicity {
    checks: toxicity.Check[];
    created: number;
    id: string;
    object: string;
}

Properties

checks +created +id +object +

Properties

checks

checks: toxicity.Check[]

created

created: number

id

id: string

object

object: string

Settings

Member Visibility

Theme

On This Page

checkscreatedidobject
\ No newline at end of file diff --git a/docs/interfaces/translate.Translate.html b/docs/interfaces/translate.Translate.html new file mode 100644 index 0000000..aa31e73 --- /dev/null +++ b/docs/interfaces/translate.Translate.html @@ -0,0 +1,9 @@ +Translate | predictionguard

Interface Translate

Translate represents the result for the translate call.

+
interface Translate {
    best_score: number;
    best_translation: string;
    best_translation_model: string;
    created: number;
    id: string;
    object: string;
    translations: Translation[];
}

Properties

best_score +best_translation +best_translation_model +created +id +object +translations +

Properties

best_score

best_score: number

best_translation

best_translation: string

best_translation_model

best_translation_model: string

created

created: number

id

id: string

object

object: string

translations

translations: Translation[]

Settings

Member Visibility

Theme

On This Page

best_scorebest_translationbest_translation_modelcreatedidobjecttranslations
\ No newline at end of file diff --git a/docs/interfaces/translate.Translation.html b/docs/interfaces/translate.Translation.html new file mode 100644 index 0000000..859308a --- /dev/null +++ b/docs/interfaces/translate.Translation.html @@ -0,0 +1,6 @@ +Translation | predictionguard

Interface Translation

Translation represents the result for the translate call.

+
interface Translation {
    model: string;
    score: number;
    status: string;
    translation: string;
}

Properties

model +score +status +translation +

Properties

model

model: string

score

score: number

status

status: string

translation

translation: string

Settings

Member Visibility

Theme

On This Page

modelscorestatustranslation
\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html new file mode 100644 index 0000000..96b2366 --- /dev/null +++ b/docs/modules.html @@ -0,0 +1,10 @@ +predictionguard

predictionguard

Index

Namespaces

chat +client +completion +factuality +health +injection +replacepi +toxicity +translate +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/chat.html b/docs/modules/chat.html new file mode 100644 index 0000000..b2fe06c --- /dev/null +++ b/docs/modules/chat.html @@ -0,0 +1,10 @@ +chat | predictionguard

Namespace chat

Index

Enumerations

Model +Role +

Classes

Client +

Interfaces

Chat +ChatSSE +Choice +Message +SSEChoice +SSEDelta +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/client.html b/docs/modules/client.html new file mode 100644 index 0000000..17a1504 --- /dev/null +++ b/docs/modules/client.html @@ -0,0 +1,3 @@ +client | predictionguard

Namespace client

Index

Classes

Client +

Interfaces

Error +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/completion.html b/docs/modules/completion.html new file mode 100644 index 0000000..23be12b --- /dev/null +++ b/docs/modules/completion.html @@ -0,0 +1,5 @@ +completion | predictionguard

Namespace completion

Index

Enumerations

Model +

Classes

Client +

Interfaces

Choice +Completion +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/factuality.html b/docs/modules/factuality.html new file mode 100644 index 0000000..7f3654f --- /dev/null +++ b/docs/modules/factuality.html @@ -0,0 +1,4 @@ +factuality | predictionguard

Namespace factuality

Index

Classes

Client +

Interfaces

Check +Factuality +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/health.html b/docs/modules/health.html new file mode 100644 index 0000000..7993279 --- /dev/null +++ b/docs/modules/health.html @@ -0,0 +1,2 @@ +health | predictionguard

Namespace health

Index

Classes

Client +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/injection.html b/docs/modules/injection.html new file mode 100644 index 0000000..f2e48f4 --- /dev/null +++ b/docs/modules/injection.html @@ -0,0 +1,4 @@ +injection | predictionguard

Namespace injection

Index

Classes

Client +

Interfaces

Check +Injection +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/replacepi.html b/docs/modules/replacepi.html new file mode 100644 index 0000000..fd76c4e --- /dev/null +++ b/docs/modules/replacepi.html @@ -0,0 +1,5 @@ +replacepi | predictionguard

Namespace replacepi

Index

Enumerations

ReplaceMethod +

Classes

Client +

Interfaces

Check +ReplacePI +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/toxicity.html b/docs/modules/toxicity.html new file mode 100644 index 0000000..fad6367 --- /dev/null +++ b/docs/modules/toxicity.html @@ -0,0 +1,4 @@ +toxicity | predictionguard

Namespace toxicity

Index

Classes

Client +

Interfaces

Check +Toxicity +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/modules/translate.html b/docs/modules/translate.html new file mode 100644 index 0000000..809ef72 --- /dev/null +++ b/docs/modules/translate.html @@ -0,0 +1,5 @@ +translate | predictionguard

Namespace translate

Index

Enumerations

Language +

Classes

Client +

Interfaces

Translate +Translation +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/eslint.config.js b/eslint.config.js index 658d0e3..1914a90 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -3,7 +3,7 @@ import tseslint from 'typescript-eslint'; export default tseslint.config( ...tseslint.configs.strict, { - ignores: ['dist/*'], + ignores: ['dist/*', 'docs/*'], }, { rules: { diff --git a/makefile b/makefile index c29a293..e512584 100644 --- a/makefile +++ b/makefile @@ -2,7 +2,7 @@ SHELL_PATH = /bin/ash SHELL = $(if $(wildcard $(SHELL_PATH)),/bin/ash,/bin/bash) install: - npm i -g typescript eslint mocha + npm i -g typescript eslint mocha typedoc npm i node-fetch@3 fetch-sse npm i --save-dev typescript-eslint mockttp @@ -13,6 +13,9 @@ publish: npm login npm publish +docs: + typedoc src/index.ts + outdated: npm outdated diff --git a/package-lock.json b/package-lock.json index 204eea5..c99cd2b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "predictionguard", - "version": "0.6.0", + "version": "0.7.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "predictionguard", - "version": "0.6.0", + "version": "0.7.0", "license": "Apache 2.0", "dependencies": { "fetch-sse": "^1.0.23", diff --git a/package.json b/package.json index d5e010c..49ca76c 100644 --- a/package.json +++ b/package.json @@ -2,19 +2,21 @@ "type": "module", "name": "predictionguard", "author": "Prediction Guard", - "version": "0.7.0", + "version": "0.8.0", "license": "Apache 2.0", "main": "./dist/index.js", "types": "./dist/index.d.ts", "scripts": { "prepublish": "tsc", "lint": "eslint .", - "test": "mocha test --no-deprecation" + "test": "mocha test --no-deprecation", + "docs": "typedoc src/index.ts" }, "files": [ "dist/*", - "src/*", - "examples/*" + "docs/*", + "examples/*", + "src/*" ], "dependencies": { "fetch-sse": "^1.0.23", diff --git a/src/api_chat.ts b/src/api_chat.ts index 98e5c60..d8b3286 100644 --- a/src/api_chat.ts +++ b/src/api_chat.ts @@ -72,7 +72,11 @@ export module chat { /** Client provides access to the chat apis. */ export class Client extends client.Client { - /** chat generates chat completions based on a conversation history. */ + /** + * Chat generates chat completions based on a conversation history. + * @param {Model} model - The title of the book. + * @param {Message[]} input - The author of the book. + * */ async Chat(model: Model, input: Message[], maxTokens: number, temperature: number): Promise<[Chat, client.Error | null]> { const zero: Chat = { id: '', diff --git a/src/index.ts b/src/index.ts index b40a16e..77d2803 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,19 +1,9 @@ -import client from './api_client.js'; -import chat from './api_chat.js'; -import completion from './api_completion.js'; -import factuality from './api_factuality.js'; -import health from './api_health.js'; -import injection from './api_injection.js'; -import replacepi from './api_replacepi.js'; -import toxicity from './api_toxicity.js'; -import translate from './api_translate.js'; - -export {client}; -export {chat}; -export {completion}; -export {factuality}; -export {health}; -export {injection}; -export {replacepi}; -export {toxicity}; -export {translate}; +export * from './api_client.js'; +export * from './api_chat.js'; +export * from './api_completion.js'; +export * from './api_factuality.js'; +export * from './api_health.js'; +export * from './api_injection.js'; +export * from './api_replacepi.js'; +export * from './api_toxicity.js'; +export * from './api_translate.js';