From 13102756b38e5aa131d8b8ebf33afb15fb899939 Mon Sep 17 00:00:00 2001 From: farfromrefug Date: Mon, 2 Dec 2024 15:47:51 +0000 Subject: [PATCH] chore: update doc --- docs/assets/hierarchy.js | 1 + docs/assets/icons.js | 31 +- docs/assets/icons.svg | 2 +- docs/assets/main.js | 9 +- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/assets/style.css | 2646 +++++++++-------- docs/classes/GPS.html | 30 +- docs/classes/GPSCommon.html | 6 +- docs/classes/LocationMonitor.html | 14 +- docs/enums/CLogTypes.html | 4 +- docs/functions/CLog.html | 2 +- docs/functions/isMockEnabled.html | 2 +- docs/functions/setGeoLocationKeys.html | 2 +- docs/functions/setMockEnabled.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 201 +- docs/interfaces/DefaultLatLonKeys.html | 6 +- docs/interfaces/Options.html | 56 +- docs/media/Basic.vue | 118 + docs/modules.html | 25 +- docs/types/AltitudeKeys.html | 2 +- docs/types/GenericGeoLocation.html | 24 +- docs/types/GeoLocation.html | 2 +- docs/types/LatitudeKeys.html | 2 +- docs/types/LongitudeKeys.html | 2 +- docs/types/deferredCallbackType.html | 2 +- docs/types/errorCallbackType.html | 2 +- docs/types/successCallbackType.html | 2 +- docs/variables/AltitudeKey.html | 2 +- docs/variables/GPSTraceCategory.html | 2 +- docs/variables/LatitudeKey.html | 2 +- docs/variables/LongitudeKey.html | 2 +- docs/variables/defaultGetLocationTimeout.html | 2 +- 34 files changed, 1765 insertions(+), 1446 deletions(-) create mode 100644 docs/assets/hierarchy.js create mode 100644 docs/media/Basic.vue diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js new file mode 100644 index 0000000..626f825 --- /dev/null +++ b/docs/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4WMvQqDMBRG3+WbY0sqkXLXDq6CozhIkmJofiA3nSTvXiRTJ5czHA7nQE6pMGiRSq0C2b691cWlyKAD/XAybsGCME4zBD4uGpB8PAW+2YOg/cZs+T5O820vwUM0BUJh051910QVkEr9H18phBQvvi26uAvo3XmTbQQt/bDWWn8Pmudp3gAAAA==" \ No newline at end of file diff --git a/docs/assets/icons.js b/docs/assets/icons.js index b79c9e8..58882d7 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,15 +1,18 @@ -(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(/.*#/, '#')); - } - }); - } +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 7dead61..50ad579 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index d6f1388..e0af265 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,9 @@ "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();})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +"use strict";(()=>{var De=Object.create;var ae=Object.defineProperty;var Ae=Object.getOwnPropertyDescriptor;var Fe=Object.getOwnPropertyNames;var Ne=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var Ve=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Fe(e))!Be.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Ae(e,i))||r.enumerable});return t};var qe=(t,e,n)=>(n=t!=null?De(Ne(t)):{},je(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var he=Ve((ue,de)=>{(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,c],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[c+1]*i[d+1],c+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),f;m in s.node.edges?f=s.node.edges[m]:(f=new t.TokenSet,s.node.edges[m]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ue=="object"?de.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var le=[];function J(t,e){le.push({selector:e,constructor:t})}var U=class{alwaysVisibleMember=null;constructor(){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){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!$e(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").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)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}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=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function $e(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ce=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ye=qe(he(),1);async function fe(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=ye.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function ge(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.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",()=>{fe(e,t)}),fe(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");i.addEventListener("mouseup",()=>{ne(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),ze(t,i,r,e)}function ze(t,e,n,r){n.addEventListener("input",ce(()=>{We(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Ue(e,t):i.key=="ArrowUp"?(pe(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(pe(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),ne(t))})}function ne(t){t.classList.remove("has-focus")}function We(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=me(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${me(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=c+d,m.append(f),f.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function pe(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Ue(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),ne(e)}}function me(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(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var Je={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>Je[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var H="mousedown",xe="mousemove",B="mouseup",G={x:0,y:0},ve=!1,re=!1,Ge=!1,D=!1,Ee=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Ee?"is-mobile":"not-mobile");Ee&&"ontouchstart"in document.documentElement&&(Ge=!0,H="touchstart",xe="touchmove",B="touchend");document.addEventListener(H,t=>{re=!0,D=!1;let e=H=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(xe,t=>{if(re&&!D){let e=H=="touchstart"?t.targetTouches[0]:t,n=G.x-(e.pageX||0),r=G.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{re=!1});document.addEventListener("click",t=>{ve&&(t.preventDefault(),t.stopImmediatePropagation(),ve=!1)});var X=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(H,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,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 ie;try{ie=localStorage}catch{ie={getItem(){return null},setItem(){}}}var C=ie;var we=document.head.appendChild(document.createElement("style"));we.dataset.for="filters";var Y=class extends I{key;value;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()),we.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.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 se=new Map,oe=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},Z=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(se.has(i))s=se.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new oe(i,a),se.set(i,s)}s.add(this.el)}};function be(t){let e=C.getItem("tsd-theme")||"os";t.value=e,Le(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),Le(t.value)})}function Le(t){document.documentElement.dataset.theme=t}var K;function ke(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Se),Se())}async function Se(){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();K=document.documentElement.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Ce(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ce(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-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',Te(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 c of t.children)Ce(c,l,i)}else Te(t,r,t.class)}function Te(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}var ee=document.documentElement.dataset.base;ee.endsWith("/")||(ee+="/");function Qe(){document.querySelector(".tsd-full-hierarchy")?Xe():document.querySelector(".tsd-hierarchy")&&Ye()}function Xe(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=et(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ye(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ie),Ie())}async function Ie(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let n=await(await fetch(window.hierarchyData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=+t.dataset.refl,s=await new Response(r).json(),o=t.querySelector("ul"),a=document.createElement("ul");if(a.classList.add("tsd-hierarchy"),Ze(a,s,i),o.querySelectorAll("li").length==a.querySelectorAll("li").length)return;let l=document.createElement("span");l.classList.add("tsd-hierarchy-toggle"),l.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",l),l.insertAdjacentText("beforebegin",", "),l.addEventListener("click",()=>{l.textContent===window.translations.hierarchy_expand?(o.insertAdjacentElement("afterend",a),o.remove(),l.textContent=window.translations.hierarchy_collapse):(a.insertAdjacentElement("afterend",o),a.remove(),l.textContent=window.translations.hierarchy_expand)})}function Ze(t,e,n){let r=e.roots.filter(i=>Ke(e,i,n));for(let i of r)t.appendChild(Pe(e,i,n))}function Pe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=ee+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=ee+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Pe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function Ke(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function et(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}J(X,"a[data-toggle]");J(Z,".tsd-accordion");J(Y,".tsd-filter-item input[type=checkbox]");var Oe=document.getElementById("tsd-theme");Oe&&be(Oe);var tt=new U;Object.defineProperty(window,"app",{value:tt});ge();ke();Qe();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 170f339..618adc9 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43UQU/CMBQH8O/SM3EyBZWbmWYHRySBm/FQuzdo6FrSvhmJ8bubgbB2K63n93+/dt1r374JwheSGckKtV7td2DIiOwobsiMgGxqk5wLVxusBRmRLZclmd3/jM69+WLZdTFBjQGT5Iul2zFOez2ZqmslvZ3HUqi/UIwiV3KuJEelh0ovELKeoKKNwIJioeQL7K0z4BJBV5SBSQYpl0wnU4t83bVr+6G/Wqj9USDHpgR3M9j+hsSu9Yzrh7vxJLVPGSRoznJQp+Poa8NE3Axg/1YKevkL7VrUUXJ9GbKLMamECrSGMqNCfFC2bYe+D/oyMRe0VjqEDgIx0TSMgTEh0xOJqdZcddon1Zx+CHfsXOkmda/1SlMGGUVYK+2V+pkAZ02CT7LKIcSaAq9i1QNMebz/OeBpxle8BtWgz7wYDizQvrSdVTWSHd6Jwwvstk1vrTZu5optn2W7cOnrdwIByABaF9i9T502TIXJyObcxIB6/wU39IAIogYAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42UQU/DMAyF/0vOE2WDDdgNFdQDnZi03RCHLHW3aG0yJS5iQvx31MHWJE0Tzu+9z1bs+O2LIHwimZM0l9v18QCajMiB4o7MCYim1slFuNphXZER2XNRkPn99+iSzZarLsUqqjXoJFuu7MR44mRSWddSeJO/UiifS0aRS7GQgqNUfYpjCLGeoKRNhTnFXIoXOBpvwAWCKikDnfRcNnIynRnI10Nb2w/600Lxxwo5NgXYzWA7hsTUHMb1w914OjE4BZSgFBQpraoNZft2kC7P54lxQSmpQtCeIUbMQIDiLAN5HpyL7DvizADs35ScDs/C1KIcKbbDIFOMkXTDGGgden+PJUY19qqjfVDF6aay184m3TgL136SDPD8vGteg2zQhxw0Bwpky9VaUQYpRdhK5W3V9QRwxgB9JEMOQYzheSmGHsC0l7aLl41gpztxusB2bHZrxLheSLZ/Fm2twpe3DAGQBjS+hb2lHa3vCiMjzdmOHur9BwUodjmiBgAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 3f54c16..73baac2 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbW2/juhGA/4vyqnVCUqScvKXZNihOFhucbNsHI1hwZcYRYkuuRCdnT7D/vaCuQ3lGsp2eJyPRXMj5hsOLqPegyN/K4GrxHryk2TK44lKFQaY3JrgKvm5tmmdlEAa7Yh1cBWlmTfGkE1OeN49mz3azDsIgWeuyNGVwFQS/wtYUu+BRZ2tpyrQwy+sk2RU6+Tll82xfHvgIg60uTGZBGwm3u+1SW/M5La3OEjPpdU/8JKebNEs3u82/KmPf0s20X0zjNNf6D2foenWATyh6kjObbky+s5OeGrlP7FRH5Uu6vTfFJi3LNM9unk3yMukU1znJ/TLP7NetyR6MtWm2mhwQZ4jCSY71ep2/lX/TycuqyHfZ8i5PtFOo82S6HdP6JzVrq3elKQfGrnc232ibJnq9nh7eB5k4LWaJTV9T+/Pbz+30GBgIn5Yd5skUhTkaDq13aDOUlKKv1t+/20O6TLiddeqj3mdUq6kSUehXszbLDzZrBuyc1L62ex+sZFOt7Mz8FY3Ms8+N3mQ7PdGTsjrP2sbdu6F6iMs9hb80j4f+muBNTzKzvZZSZa7IX9OlKaaLWS94UqyzjdHXa5va3XK63wPhQx3yi8uYSd5PqbskMWV5o9frHzp58aqli2N5jkiMLvdGKY6bPJsoPlhj6a6ZosiLkY7tPf9ot3CDU53abybdpbZgjPQKE/lox0ibU31D2wuyn887x7f3D53Xxtj57f3D4TuL1bb8Xlptd+V38+rcU9bOEMnevC2Xn9LyU5o9myK1Vf3quuPa2HuXrAeT5Flpi11i84L26wvhEfNdeB00mf4Bp9A9+73A0bbTvLx51tnK3OXJF53plRnpBy78IZ93aWlNdqhTIH2IV34RzeGE1mhfL5dj0dwX/ICv380mfz3MWy96tL9tYZzYP/Lid/PfnSlHxgAmerS/lbE3u8LJtTPpyKDDZI/2+KZt8jztbCh2tJ9kbXTxH2dlZDhDmaM9POtyrOSddc+Pz7qtyW7vH/Z2qfs5tyd4tK+65EyVpFMsp+Xfp+odFDna/nJ4FrRnfjl1/DM+Mu50aX/L8rfsoLGBSR/tVe/sc16kf450CoqcMukNGF235kYxeVKneIULhTZAX/IsxabbwfPRBcTxzDDrx/Ebtp9oTWl1YQeyabY6rEG08ofa5Pp5Yoso1Q/GKN+eHiJC90MtSgqjrUm/PnTyxGIKbdOI9rGtOnRxirfjgIUq7VqBA1tjv+TJy7CSP+2ypNqYnvsC4/sUsHIsx616zw81Whp7a/K2W7+ZnyXe3oHQRH3x9293ut6we9brPRZ8dJzNPFuRRuGzo6y2RwuIUfho3CZ4h/TZPOnd2t5pezcILjjg2BM6fPe31vS5CW72DKjgKb7fZsp5G+ZjvAOdD7rXI2dGhHc9dXI05nyYK7du25ImYGAMMmZf4KhcHDN8mEXhHaG4jt3289G3waHvqy5SVzmqcw9c9lBnt/cP3wqdmBttzSovfiI+hiKjpvuJ5uYuX7nTlH4cmWy3Kc+7/48PHQXi8WO3GjVy1orgmdK3BLW/zies1wIn2U6zp3zceCNxkvU3XWRwOYE66IVO8lEd/o17aEUOtw8mNfcYmcbcv8cTxD+Zu8k3G3wDUz/5/57SAZvjZ3WDDUPTypNO6KBPavkzsV/Zc3/43gx6x3doR/ma2pdBd+TubMqjQJc1SIUDTw+tm3DdglkEjw81CVYtiEXwFDP4GAZptjR/BFfvwasp3E2C4CrgMzG7DMLgKTXrpbs8U/sKgyTfbFzgHptn/zYul5xELXJ+EYSLizC6mDERPT6Gi1ajelD9oxJjQbhgmBjzxHgQLjgmxj0xEYQLgYkJTywKwkWEiUWemAzChQyFnF1w6YlJT0wF4UJh1pQnFgfhIsbEYk9sHoSLOSY298Qug3BxiYld+uF10WYoBzYAUZHAUfgsmIs54yGPZyxivqSPg7mwMxQI84mwiIo185kwF3uGwmM+FubCzyQq6ZNhMd0hHw5zEBgKm/l8mOPAUN7MR8QrRChy7iPijGwnHwyXChGaH9xHxAVt00fEHQiOphL3GXFJ2/QZcQeCo0nHfUbcgeAcyxDuM+IOBBehYDOlBt59RtyB4GgucZ+RcCA4mkvCZyQcCI5miPAZiaqmoRkiBlXNgeBohgifkagYodyFz0g4EAKlKXxGwoEQKCPhMxIOhEDLtPAZCQdC4JXaZyQcCIEyEj6jyIEQKKPIZxQ5EAJlFPmMIgdCoIwin1FUTT1zLD+jweTjQIhLVNJnFDkQ0QUq6TOKHIgIZRT5jKKYbqfPKHIgIpRm5DOKHIgIpRn5jKQDEaE0pc9IOhARSlP6jCQnx7v0GUkHIkK5S5+RrFYIKHc5WCNUjNCxKX1GsmKEjk3pM5IOhETHpvQZSQdCotylz0g6EBKlKX1GyoGQKE3lM1IOhERpKp+RciAkSlP5jJQDIfHllM9IVUsGlJHyGalqIYcyUoOlnAMhUUbKZ6QcCIUyUj4j5UAolJHyGSkHQqGMlM8odiAUyij2GcUOhEIZxT6j2IFQKKPYZxQ7EAplFPuMYgdC4aten1Esyfk99hnFihzv8WDFHZOVNvYZxXOy0sY+o7hihOZS7DOaV4zQXJr7jOYORIzm0rxmVG3OXk1hzfKf9SZtsejuMb0H35udW38W8B4wHly9/woDFte/nDW/ovmV7vdXv5NzfznX7UXhPeMXwPgFpVxdw/7RXcNeN4eKu/bGb29v3pubk9baI9xeTcpeT/EJxRe3E+51Y9CFOZvW9dorWa8syRb3Jxu9prjsNaOoDn8cExaqKxdv9ZULYAKQFbSqOwnrlZTqlWIxomTrU1agCQKlSHfwDKnX5aLX5fO6t7JJxlhRturXgnnZJsymfS3YG44AeUnRaw5yQVcANkVha07BV8a2/rv7zSABQMYqavQ0ltbarvNsL4UARXlJW6guFCbNhcLhOOSADY8mjIyMPwYCw+hwVt8m6e7bJKAP1Cnt7noJyOQYDAZq/LqvStzVnbK7twMGMUhqQr29kgO8gtyJqOLVXS4EwY5AsClizfE1yDngLab6WGlRkBkoGZyysKrfOa1Mvu7eHYFkA6NfUaOf0gVBVlSOrYxN6utumAkB0lRQo8UNOF3aF3erBDUChlzUTFwRRR2M3g247QAKCKhMEQVztfWyjYM051T12j/BBwbAmOfNXByT8diWSfMeAmQTzHgSxra07h1b0r2GAzRBMimqD8+6HHRdgHAJqnLWb59AY4FSTA20NC+T6qLrOk/W3UVXEDOQuoIqLtAIMltwMAYF2ZBSgzcDIFNA8kaygUaGoEQKhwBdiMgulJs8eUG0I4BcUsj7l/sANQi/onrdKg5WRwoMtpgaHkDXS5YI5JikcmwwPD19MM4iWt+f2sHQUmSD+0sIIEygrCuKTqc5jBPo6pyMMVD21wAgtSRVypoPVvXKazVoNJUTzde19XRvq69rQU6CEUHou09usFU3AwnJqFDn2bL7FAuogmYzqvDlWVsHdH0THQxk4FpQU2GvX7R3y4EFkNiC6nneTUDb5qMu0AVQSxiVnG69stqW2JJFgBAIMnrtJ+i9HkgVKs/qr0sHyzztf13aGwSZSzWjuTX/lBdFe2seRBIYEFQO9t+IgQiCcsioQloaC9YjexUGUJRUHpXGUiUVtEBSSeC+pN52X1In9ZfUYOSDqkFZcNdSJ5YhoGxFZCxsvp0wA5JKUunRfE5GLjNBTDllA9sKAdf17MiobOg/ZwVuQSViFIs6l7EtBFxREcrdnRUAD8Qrpmp+tfFGV6JgfhIo/Mcw2KZbs04zE1wtHn/9+h9EJ5kUcUIAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WcW3ObShLHvwt+5dieu+w3r7Pr2jpOJXWc3X1QuVIEjWXKCLSAnJPjynffGi6ih2lghLNPdonuf8/l180wGvQWFPn3MrhevwUvSbYJrqmQYZBFOx1cB5/2VZJnZRAGhyINroMkq3TxFMW6vGgvnT9XuzQIgziNylKXwXUQ/Aw7KXJJ+VFro8uk0JubOD4UUfxjTvOstY96exAjDPZRobMKtHEk7GG/iSr9ISmrKIv1bNTGfNObLwq6S7Jkd9j9qxb7kuzm47YeTfiq8VgWOvrTCN1sPWI2ptF2cTDT0PxQzUbq7RaFKV+S/Wdd7JKyTPLs9lnHL7Mhjc/+6BO3PovCb/Ks+rTX2YOuqiTbzqbDmXHI9zore4dFgaM0zb+Xf4vil22RH7LNfR5HxqHhar4djf+3o3/a+h+O/ouatY8OpS4Hjbk5VPkuqpI4StP55G4kBu2JBhLLxiyuktek+vHlx34+AzrjqjFeRod+0kWhT56czm/5pEghWF+rv36tfLo8EvboPRn8fKyzY/WhiF51qjfvaxVQWdS687Zz7yxi0230q3ALm5hnH1q/2Vbm2aY3XQR0nnWN+2yy1CdkNyT7zuH/ivAwnie7Tr/GyluRvyYbXcwXsd5w0UBnOx3dpFVSHTbznTbGUW/sG5BeXikiaH8rPcSxLsvbKE3NfcGqkmYUywvEYnKRNzmF05JnMzOHNXa8a7oo8mKiY87193YLF5zrlNvM8S51qTzRK8zkvR0b1ZzrG9peQD9dHQPffX44Rm3FLu4+P/g/T2z35deyiqpD+VW/mvBjameIZS9flZvfkvK3JHvWRVLVxevYHdPGProg/cTEeVZWxSGu8mI8rm2Ej5gdwuqgzqJv8N7p6PcGJ2sneXn7HGVbfZ/HH6Ms2uqJfiR5GdfGaR7vjsbvinmflJXOfIOmvbVPVHrJV/Bu1nrfbDZTo5lnXZioNXxHrD/0Ln/1i1YcTU+Oty+0MftHXvyh/3vQ5UQOtKZPeVEcTU+Ot9XV7aEwdt2ddCLpdBU3tmlve3LE71EVP88Hq83eEydOdVT8x6hMpLOx+d7anBzhOSqnSt7Zc1Ru9+Or/ynq9jq7+/zgPJ26zO11tt2Xs0+lE7GakjNXkpYoJ+Xf5+pdUp5W8Sz9zXAHyJGf3fSZzoz7qKx+z/LvmVdupFFZvRjr91AbHarnvEj+mugUNFly0xvM0U0nNzlNEbRaEhUuFLrh/JhnCXa7HVyfXECcPmeY+mnzN2z/SGvKKiqqgW2Sbf0aVDt3LdlB53e1yYzQwhaZIfrl7SmrfL98iPL9r29RXOio0smnh6P9yGIKbVPrnR83wuZWV+Ot8l2c4u3wWKiOh5Zgo1ZXH/P4ZVjJnw5ZXD+YXtgG088pYOVYTqta131FS13d6bzr1u/6R4m3d2A0U1/s57f7qHlgt9SbZyx46TTNPNuOisJrJ6l2+xCIKLw0rQm+Ofqgn6JDWt1H1f1gcMEGh2Pk//SXRuP7JrjsGXDBEXfbPBa8G+ZTogOfd4aPJvaMRqLP7hxNBR+ycmceW5IYJMaAGNfgJBanhP0UmbWFYjp219/Kvgz2e1+jIjGVo973wG19g919fvhSRLG+jSq9zYsfSIyhyaR0f6O5vc+3ZjelzyOdHXblxfHz6dSRYDy+HbaTImedCU5K3xJUP81n1BuDRdpJ9pRPi7cWi9S/R0UGlxNogN5oUYx68286Qmfirw9uauYychszH08DYu/M3ea7Hf4A01z5tbt0QHN6r27wwNC2ctEOHYzpuU/nhPN/FoPR8Ceyk2LNPYfBcKNPY3MRGbqMQSoauOpbJ+E6BVMEl30lwSoFUQRXMcHHMEiyjf4zuH4LXnVhTgwE1wE9Z+dXQRg8JTrdmCMyTawwiPPdrmFzk8eH+t/H1uzf2mBkjBvri8sgXF+G/PKcMP74GK475/pC/UGn0X9SO5IgXBPMkTiOxHKkQbimmCN1HKnlyIJwzTBH5jgyy5EH4Zpjjtxx5JajCMK1CJk4v6TCchSOo7AcZRCuJRZROo7SclRBuFaYo3IcleW4CsL1CnNcOY4ry/EqCNdXmOOV43hlA2B4ICg7xIWHDOip8cH5QQCyCSKGC0JDqs4JJ7azCxGxKSKGDYJyRFyQiE0S4WNEEJclYsNEDCIE5ZC4PBEbKGIwIQJ1dpkiNlREjY+XyxWxwSIGF4LCTFy2iA0XMcgQFGji8kVswGgNGAo1dQGjNmCUjPaZuoDRQYmqAUOzgiJVygaMsvHILmDUBowaZiiaVNQljNqEUTEe2SWM2oRRwwxFM5K6hFGbMGqYoRRLDOoSRm3CqGGGspCRcykHzXYJozZh1DBD0ayiLmHUJowZZiiaVcwljNmEMcMMRRODuYQxmzBW3wXRxGAuYWxwIzTMUDQxGHIvtAljNWEo28wljNmEMcMMQ/FkLmHMJowZZhhKGHMJYzZhzDDD0HUDcwljNmHMMMPwtYNLGLMJY4YZhhLGXMKYTRg3zDCUMO4Sxm3CuGGGoYRxlzBuE8YNMwwljLuEcZswXq+1Vlg+c5cwPlhuGWbYFeqMrLhswrhhhl+izi5h3CaMG2Y4Shh3CeM2YVyN99kljNuEccMMR/HkLmHcJowbZjiKJ3cJ4zZhwjDDUTyFS5iwCROGGY7iKVzChE2YoKN1W7iECZswYZjhKNvCJUzYhIl6RY+yLVzCxGBRXxOGVk+BrOttwkRNGFo9hUuYsAkThhmBVk/hEiZswoRhRqBsC5cwYRMmDDMCxVO4hAmbMGmYESie0iVM2oRJw4xA8ZQuYdImTBpmBIqndAmTNmHSMCPwpzCXMGkTJuuFPkqYdAmTNmGyfm5ECZMuYXLw6GiYEShhEnl6tAmThhmJEiZdwqRNmDTMSJQw6RImbcKkYUaihEmXMGkTpgwzEiVMuYQpmzBlmJEoYcolTNmEKcOMRAlTLmHKJkwZZiRKmHIJUzZhyjAj8Wd9lzBlE6bE6HpbuYQpmzAlR+u2cglTgw0KNXpzV8gehU2YWo3e3JVLmLIJUzVhaFYplzBlE7aqCUOzauUStrIJWxlmFJpVK5ew9qN6z+5VF5Xe/LPZu1uvj8dZ34Kv7YZevyX8FhAaXL/9DAOimr+UtH9Z+1eYvz/7Db760+Men7lmWmK/NQJCXYJQl35Sc2/o9OqrXnzlqd1959eLCNGrSHqSzIvZWO2VFOjsipyqZPVMkF5KePat30TvddhVr8N546mUlx482wcEATvMV8h8AdNLSNlLKOYtUTVf9QEdMNzSsynwa41eibJeia4aX9EmhpJ+yqPnVvowHJAm/Phov3cEnQZgSD8w2q9wwfGj45s5ADiQS9Iv51vdNKrSPHMABpyIK1+9+qR83J6UH9YSCuab8pMkJ2oIAQNKfCdl8BouUANiflrHE5YgxxRIWr+K5L5eCcoSSDcvse7EKmgRIJf7lfHjuVQwgRxMoB8T7Te/gH/QEuU3NrXGGFQEFEjqp7dtjnJsdd4fdATgg+om/arbmBKYOOnHO3bCHMwiSCDml+P4sU4gCcoGb5cM3I+ykeOQoFyCqsz9cKmPiwPgQDpSvzruftkO5EBNo+16SXmO476M2wMEgGWYmZ4TvC8rc1QmPp6mAbwAlKVfb7sT9mBCwaAzv/tLc8AEdAtIKL9igb/ZAkYeJBXzK6zoGzpAEdQR5tlI69gA4BSkFRctFp5DVyJlkoHOcs/Olrs8fkG0OEBM+CHWnwkEaIEplX6j1ckM1sgSFAzll9RAyUKVA96FH++DgmOpgVrBfdXspRkoD9Kza/0JSDDY4DYp/eb/qDMcbTBEK895A1L2ig5gLvxKPPw1DTDSYKD9ZNwfAgHZAvLYS81+axisBECqEL/pgy+WAyHQQeJ3e3BetAOFCjSL+S1QkBfpgB5IQOY3Yu7L7KCzoI4Sv7Rx3rkCkwmGjnnOQfd7PL0KANWPeZ+f3ujlQU75NRF50RDMB5BjfvnQv2QP5gHcNIjfzafUFVh5OtUVcCL8KC51NXYbAq0TftChP1YDKhuokX56Y+8DgVaCAs49x3DkFRogCpAWfji27/iPPrKAmaF+itgDP2hW40X86Ot/egQ0CVRh4je/w1+VAhkBuucldTyADPAAo6787qGDF2ZBUQIrA+YB22MY7JO9TpNMB9frx58//wcXxhZqUEwAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 778b949..499bc28 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,87 +1,247 @@ -: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) { +@layer typedoc { :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --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: #4d7fff; + --light-color-ts-property: #ff984d; + --light-color-ts-method: #ff4db8; + --light-color-ts-reference: #ff4d82; + --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: #ff4d4d; + --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-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --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-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --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: #4d7fff; + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --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: #ff4d4d; + --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-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --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-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-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --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-reference: var(--light-color-ts-reference); + --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); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --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-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-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --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-reference: var(--dark-color-ts-reference); + --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); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --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); @@ -91,9 +251,16 @@ --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-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); --color-ts-enum: var(--light-color-ts-enum); @@ -105,6 +272,7 @@ --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-reference: var(--light-color-ts-reference); --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( @@ -116,14 +284,19 @@ --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); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } -} -@media (prefers-color-scheme: dark) { - :root { + :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); @@ -133,9 +306,16 @@ --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-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); --color-ts-enum: var(--dark-color-ts-enum); @@ -147,6 +327,7 @@ --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-reference: var(--dark-color-ts-reference); --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( @@ -158,1255 +339,1272 @@ --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); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); --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); -} + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } -: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; + } -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } -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); -} + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} + dl, + menu, + ol, + ul { + margin: 1em 0; + } -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} + dd { + margin: 0 0 0 34px; + } -.uppercase { - text-transform: uppercase; -} + .container { + max-width: 1700px; + padding: 0 2rem; + } -dl, -menu, -ol, -ul { - margin: 1em 0; -} + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } -dd { - margin: 0 0 0 40px; -} + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } -.container { - max-width: 1700px; - padding: 0 2rem; -} + @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); + } -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -.tsd-generator { - margin: 0 1em; -} + 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; + } + a.tsd-anchor-link { + color: var(--color-text); + } -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } -@keyframes fade-in { - from { + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + 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; } - to { + pre:hover > button, + pre > button.visible { opacity: 1; } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } - to { - opacity: 0; + + .tsd-typography { + line-height: 1.333em; } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; } - 33% { - opacity: 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; } - 100% { - opacity: 1; + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; } - 66% { - opacity: 0; + .tsd-typography table { + border-collapse: collapse; + border: none; } - 100% { - opacity: 0; + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } - to { - transform: translate(0, 0); + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; } - to { - transform: translate(100%, 0); + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; } -} -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; -} + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } -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; -} + .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: " / "; + } -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} + .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; + } -.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); -} + 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-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-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-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; -} + .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: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + 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-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .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); + } -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; -} + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } -.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 .settings-label { + margin: 0.75rem 0 0.5rem 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 .settings-label { + margin: 0.75rem 0.75rem 0 0; + } -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } -.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-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-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } -.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); + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; } -} -@media (max-width: 768px) { .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); + 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-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-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-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} + .tsd-anchor { + position: relative; + top: -100px; + } -.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-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } -.tsd-page-navigation ul { - padding-left: 1.75rem; -} + .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-navigation .tsd-nav-link { + display: none; + } + .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-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-navigation-section { + margin-left: 10px; + } + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 20px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } -.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-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 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; -} + 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 { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + 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-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + We need to be careful to target the arrow indicating whether the accordion + is open, but not any other SVGs included in the details element. +*/ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } -.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; -} + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } -img { - max-width: 100%; -} + .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-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} + #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-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} + #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; + } -.deprecated { - text-decoration: line-through !important; -} + .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; + } -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } -.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); -} + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} + .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-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } -*::-webkit-scrollbar { - width: 0.75rem; -} + 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; + } -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} + .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; + } -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} + .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; + } -/* mobile */ -@media (max-width: 769px) { .tsd-widget.options, .tsd-widget.menu { - display: inline-block; + display: none; } - - .container-main { - display: flex; + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; } - html .col-content { - float: none; + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; + } + + img { 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); + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - html .col-sidebar > *:last-child { - padding-bottom: 20px; + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); } - 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); + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; visibility: hidden; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + .deprecated { + text-decoration: line-through !important; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-kind-project { + color: var(--color-ts-project); } - - .has-menu body { - overflow: hidden; + .tsd-kind-module { + color: var(--color-ts-module); } - .has-menu .overlay { - visibility: visible; + .tsd-kind-namespace { + color: var(--color-ts-namespace); } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + .tsd-kind-enum { + color: var(--color-ts-enum); } - .has-menu .tsd-navigation { - max-height: 100%; + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); } -} - -/* 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; + .tsd-kind-variable { + color: var(--color-ts-variable); } - - .col-sidebar { - grid-area: sidebar; + .tsd-kind-function { + color: var(--color-ts-function); } - .col-content { - grid-area: content; - padding: 0 1rem; + .tsd-kind-class { + color: var(--color-ts-class); } -} -@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; + .tsd-kind-interface { + color: var(--color-ts-interface); } - .site-menu { - margin-top: 1rem; + .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-reference { + color: var(--color-ts-reference); + } + .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-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); } -} -/* 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"; + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); } - .col-sidebar { - display: contents; + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } - .page-menu { - grid-area: toc; - padding-left: 1rem; + *::-webkit-scrollbar { + width: 0.75rem; } - .site-menu { - grid-area: sidebar; + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); } - .site-menu { - margin-top: 1rem 0; + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; + /* 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%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* 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; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } } diff --git a/docs/classes/GPS.html b/docs/classes/GPS.html index b64b516..d88ce4f 100644 --- a/docs/classes/GPS.html +++ b/docs/classes/GPS.html @@ -1,20 +1,20 @@ -GPS | Track GPS location updates

Class GPS

Hierarchy (view full)

Constructors

constructor +GPS | Track GPS location updates

Class GPS

Hierarchy (View Summary)

Constructors

constructor

Properties

enabled -iosChangeLocListener -iosChangeLocManager +iosChangeLocListener +iosChangeLocManager gps_status_event

Methods

authorize -clearWatch +clearWatch distance enable -getCurrentLocation -getLastKnownLocation -hasGPS -isAuthorized -isEnabled -onListenerAdded -onListenerRemoved -openGPSSettings -prepareForRequest -watchLocation -

Constructors

constructor

Properties

enabled

enabled: boolean

iosChangeLocListener

iosChangeLocListener: LocationChangeListenerImpl

iosChangeLocManager

iosChangeLocManager: CLLocationManager

Static gps_status_event

gps_status_event: string

Methods

authorize

  • authorize(always?): Promise<boolean>

  • Parameters

    • Optional always: boolean

    Returns Promise<boolean>

clearWatch

  • clearWatch(watchId): void

  • Parameters

    • watchId: number

    Returns void

distance

enable

  • enable(): Promise<boolean>

  • Returns Promise<boolean>

getCurrentLocation

getLastKnownLocation

hasGPS

  • hasGPS(): boolean

  • Returns boolean

isAuthorized

  • isAuthorized(always?): Promise<boolean>

  • Parameters

    • Optional always: boolean

    Returns Promise<boolean>

isEnabled

  • isEnabled(): boolean

  • Returns boolean

onListenerAdded

  • onListenerAdded(eventName, count): void

  • Parameters

    • eventName: string
    • count: number

    Returns void

onListenerRemoved

  • onListenerRemoved(eventName, count): void

  • Parameters

    • eventName: string
    • count: number

    Returns void

openGPSSettings

  • openGPSSettings(): Promise<boolean>

  • Returns Promise<boolean>

prepareForRequest

  • prepareForRequest(options): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

watchLocation

Settings

Member Visibility

Theme

On This Page

constructorenablediosChangeLocListeneriosChangeLocManagergps_status_eventauthorizeclearWatchdistanceenablegetCurrentLocationgetLastKnownLocationhasGPSisAuthorizedisEnabledonListenerAddedonListenerRemovedopenGPSSettingsprepareForRequestwatchLocation
\ No newline at end of file +getCurrentLocation +getLastKnownLocation +hasGPS +isAuthorized +isEnabled +onListenerAdded +onListenerRemoved +openGPSSettings +prepareForRequest +watchLocation +

Constructors

constructor

Properties

enabled

enabled: boolean

iosChangeLocListener

iosChangeLocListener: LocationChangeListenerImpl

iosChangeLocManager

iosChangeLocManager: CLLocationManager

Staticgps_status_event

gps_status_event: string

Methods

authorize

  • authorize(always?: boolean): Promise<boolean>

  • Parameters

    • Optionalalways: boolean

    Returns Promise<boolean>

clearWatch

  • clearWatch(watchId: number): void

  • Parameters

    • watchId: number

    Returns void

distance

enable

  • enable(): Promise<boolean>

  • Returns Promise<boolean>

getCurrentLocation

getLastKnownLocation

hasGPS

  • hasGPS(): boolean

  • Returns boolean

isAuthorized

  • isAuthorized(always?: boolean): Promise<boolean>

  • Parameters

    • Optionalalways: boolean

    Returns Promise<boolean>

isEnabled

  • isEnabled(): boolean

  • Returns boolean

onListenerAdded

  • onListenerAdded(eventName: string, count: number): void

  • Parameters

    • eventName: string
    • count: number

    Returns void

onListenerRemoved

  • onListenerRemoved(eventName: string, count: number): void

  • Parameters

    • eventName: string
    • count: number

    Returns void

openGPSSettings

  • openGPSSettings(): Promise<boolean>

  • Returns Promise<boolean>

prepareForRequest

  • prepareForRequest(options: Options): Promise<boolean>

  • Parameters

    Returns Promise<boolean>

watchLocation

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/GPSCommon.html b/docs/classes/GPSCommon.html index e373c59..5da8222 100644 --- a/docs/classes/GPSCommon.html +++ b/docs/classes/GPSCommon.html @@ -1,5 +1,5 @@ -GPSCommon | Track GPS location updates

Class GPSCommonAbstract

Hierarchy (view full)

  • default

Constructors

constructor +GPSCommon | Track GPS location updates

Class GPSCommonAbstract

Hierarchy (View Summary)

  • default

Constructors

constructor

Properties

gps_status_event

Methods

authorize -isAuthorized -

Constructors

constructor

Properties

Static gps_status_event

gps_status_event: string

Methods

authorize

  • authorize(always?): Promise<boolean>

  • Parameters

    • Optional always: boolean

    Returns Promise<boolean>

isAuthorized

  • isAuthorized(always?): Promise<boolean>

  • Parameters

    • Optional always: boolean

    Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

constructorgps_status_eventauthorizeisAuthorized
\ No newline at end of file +isAuthorized +

Constructors

constructor

Properties

Staticgps_status_event

gps_status_event: string

Methods

authorize

  • authorize(always?: boolean): Promise<boolean>

  • Parameters

    • Optionalalways: boolean

    Returns Promise<boolean>

isAuthorized

  • isAuthorized(always?: boolean): Promise<boolean>

  • Parameters

    • Optionalalways: boolean

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/LocationMonitor.html b/docs/classes/LocationMonitor.html index 7201da3..0493552 100644 --- a/docs/classes/LocationMonitor.html +++ b/docs/classes/LocationMonitor.html @@ -1,7 +1,7 @@ -LocationMonitor | Track GPS location updates

Class LocationMonitor

Implements

  • LocationMonitor

Constructors

constructor -

Methods

createiOSLocationManager -getLastKnownLocation -getLocationMonitoring -startLocationMonitoring -stopLocationMonitoring -

Constructors

constructor

Methods

Static createiOSLocationManager

  • createiOSLocationManager<T>(locListener, options): CLLocationManager

  • Type Parameters

    Parameters

    • locListener: LocationListenerImpl<T>
    • options: Options

    Returns CLLocationManager

Static getLastKnownLocation

Static getLocationMonitoring

  • getLocationMonitoring(iosLocManagerId): CLLocationManager

  • Parameters

    • iosLocManagerId: number

    Returns CLLocationManager

Static startLocationMonitoring

  • startLocationMonitoring<T>(options, locListener): void

  • Type Parameters

    Parameters

    • options: Options
    • locListener: LocationListenerImpl<T>

    Returns void

Static stopLocationMonitoring

  • stopLocationMonitoring(iosLocManagerId): void

  • Parameters

    • iosLocManagerId: number

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcreateiOSLocationManagergetLastKnownLocationgetLocationMonitoringstartLocationMonitoringstopLocationMonitoring
\ No newline at end of file +LocationMonitor | Track GPS location updates

Class LocationMonitor

Implements

  • LocationMonitor

Constructors

constructor +

Methods

createiOSLocationManager +getLastKnownLocation +getLocationMonitoring +startLocationMonitoring +stopLocationMonitoring +

Constructors

constructor

Methods

StaticcreateiOSLocationManager

  • createiOSLocationManager<T = DefaultLatLonKeys>(
        locListener: LocationListenerImpl<T>,
        options: Options,
    ): CLLocationManager

  • Type Parameters

    Parameters

    • locListener: LocationListenerImpl<T>
    • options: Options

    Returns CLLocationManager

StaticgetLastKnownLocation

StaticgetLocationMonitoring

  • getLocationMonitoring(iosLocManagerId: number): CLLocationManager

  • Parameters

    • iosLocManagerId: number

    Returns CLLocationManager

StaticstartLocationMonitoring

  • startLocationMonitoring<T = DefaultLatLonKeys>(
        options: Options,
        locListener: LocationListenerImpl<T>,
    ): void

  • Type Parameters

    Parameters

    • options: Options
    • locListener: LocationListenerImpl<T>

    Returns void

StaticstopLocationMonitoring

  • stopLocationMonitoring(iosLocManagerId: number): void

  • Parameters

    • iosLocManagerId: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/enums/CLogTypes.html b/docs/enums/CLogTypes.html index f3cb074..3ca37e2 100644 --- a/docs/enums/CLogTypes.html +++ b/docs/enums/CLogTypes.html @@ -1,6 +1,6 @@ -CLogTypes | Track GPS location updates

Enumeration CLogTypes

Enumeration Members

debug +CLogTypes | Track GPS location updates

Enumeration CLogTypes

Enumeration Members

debug error info log warning -

Enumeration Members

debug

debug: 0

error

error: 3

info

info: 1

log

log: 0

warning

warning: 2

Settings

Member Visibility

Theme

On This Page

debugerrorinfologwarning
\ No newline at end of file +

Enumeration Members

debug

debug: 0

error

error: 3

info

info: 1

log

log: 0

warning

warning: 2

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/docs/functions/CLog.html b/docs/functions/CLog.html index c390cb4..cff2320 100644 --- a/docs/functions/CLog.html +++ b/docs/functions/CLog.html @@ -1 +1 @@ -CLog | Track GPS location updates

Function CLog

  • CLog(type, ...args): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +CLog | Track GPS location updates

Function CLog

  • CLog(type: CLogTypes, ...args: any[]): void

  • Parameters

    Returns void

Settings

Member Visibility
diff --git a/docs/functions/isMockEnabled.html b/docs/functions/isMockEnabled.html index 883b430..cba06c1 100644 --- a/docs/functions/isMockEnabled.html +++ b/docs/functions/isMockEnabled.html @@ -1 +1 @@ -isMockEnabled | Track GPS location updates

Function isMockEnabled

  • isMockEnabled(): boolean

  • Returns boolean

Settings

Member Visibility

Theme

\ No newline at end of file +isMockEnabled | Track GPS location updates

Function isMockEnabled

  • isMockEnabled(): boolean

  • Returns boolean

Settings

Member Visibility
diff --git a/docs/functions/setGeoLocationKeys.html b/docs/functions/setGeoLocationKeys.html index 113b332..c7a60b6 100644 --- a/docs/functions/setGeoLocationKeys.html +++ b/docs/functions/setGeoLocationKeys.html @@ -1 +1 @@ -setGeoLocationKeys | Track GPS location updates

Function setGeoLocationKeys

  • setGeoLocationKeys(latitude, longitude, altitude?): void

  • Parameters

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +setGeoLocationKeys | Track GPS location updates

Function setGeoLocationKeys

Settings

Member Visibility
diff --git a/docs/functions/setMockEnabled.html b/docs/functions/setMockEnabled.html index 567ab28..dbb0c9a 100644 --- a/docs/functions/setMockEnabled.html +++ b/docs/functions/setMockEnabled.html @@ -1 +1 @@ -setMockEnabled | Track GPS location updates

Function setMockEnabled

  • setMockEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +setMockEnabled | Track GPS location updates

Function setMockEnabled

  • setMockEnabled(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

Settings

Member Visibility
diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 11e2ebe..c1de732 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -Track GPS location updates

Track GPS location updates

Class Hierarchy

Settings

Member Visibility

Theme

\ No newline at end of file +Track GPS location updates

Track GPS location updates

Hierarchy Summary

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index 1f1f440..7b732d4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Track GPS location updates

Track GPS location updates

+Track GPS location updates

Track GPS location updates

@nativescript-community/gps

- Downloads per month + Downloads per month NPM Version -

- +

Tracks GPS location updates regardless of the app state. Does not depend on Google Play Services.

-
- - @@ -39,135 +35,160 @@

@nativescript-community/gps

- + + -
iOS Demo Android Demo
-

-

-

Table of Contents

    -
  • Installation
    • -
  • Usage
      -
    • Examples:
      • + + +

      +

      +

      Table of Contents

        +
      • Installation
        • +
      • Usage +
        • -
      • Demos and Development
          -
        • Repo Setup
          • -
        • Build
          • -
        • Demos
          • +
        • Demos and Development +
          • -
        • Contributing -

          -

          -

          Installation

          Run the following command from the root of your project:

          +

          +

          +

          Installation

          Run the following command from the root of your project:

          ns plugin add @nativescript-community/gps

          -

          -

          -

          Usage

          Here is a simple example. You can find more in the doc here

          -
          import { GPS } from '@nativescript-community/gps';

          const gps = new GPS();
          const location = await gps.getCurrentLocation<LatLonKeys>({
              minimumUpdateTime,
              desiredAccuracy,
              timeout,
              skipPermissionCheck: true
          });
-
          -

          Examples:

            -
          • Basic
              +

              +

              +

              Usage

              Here is a simple example. You can find more in the doc here

              +
              import { GPS } from '@nativescript-community/gps';

              const gps = new GPS();
              const location = await gps.getCurrentLocation<LatLonKeys>({
                  minimumUpdateTime,
                  desiredAccuracy,
                  timeout,
                  skipPermissionCheck: true
              });
+
              + +

              Examples:

                +
              • Basic +
                • A basic sliding drawer.
              -

              -

              -

              Demos and Development

              Repo Setup

              The repo uses submodules. If you did not clone with --recursive then you need to call

              +

              +

              +

              Demos and Development

              Repo Setup

              The repo uses submodules. If you did not clone with --recursive then you need to call

              git submodule update --init
              +

              The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.

              To develop and test: if you use yarn then run yarn if you use pnpm then run pnpm i

              Interactive Menu:

              To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.

              -

              Build

              npm run build.all
-
              +

              Build

              npm run build.all
+
              +

              WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run

              -

              Demos

              npm run demo.[ng|react|svelte|vue].[ios|android]

              npm run demo.svelte.ios # Example
-
              +

              Demos

              npm run demo.[ng|react|svelte|vue].[ios|android]

              npm run demo.svelte.ios # Example
+
              +

              Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue] Instead you work in demo-snippets/[ng|react|svelte|vue] -You can start from the install.ts of each flavor to see how to register new demos

              -

              -

              -

              Contributing

              Update repo

              You can update the repo files quite easily

              +You can start from the install.ts of each flavor to see how to register new demos

              +

              +

              +

              Contributing

              Update repo

              You can update the repo files quite easily

              First update the submodules

              -
              npm run update
-
              +
              npm run update
+
              +

              Then commit the changes Then update common files

              -
              npm run sync
-
              +
              npm run sync
+
              +

              Then you can run yarn|pnpm, commit changed files if any

              -

              Update readme

              npm run readme
-
              -

              Update doc

              npm run doc
-
              -

              Publish

              The publishing is completely handled by lerna (you can add -- --bump major to force a major release) -Simply run

              -
              npm run publish
-
              -

              modifying submodules

              The repo uses https:// for submodules which means you won't be able to push directly into the submodules. +

              Update readme

              npm run readme
+
              + +

              Update doc

              npm run doc
+
              + +

              Publish

              The publishing is completely handled by lerna (you can add -- --bump major to force a major release) +Simply run

              +
              npm run publish
+
              + +

              modifying submodules

              The repo uses https:// for submodules which means you won't be able to push directly into the submodules. One easy solution is t modify ~/.gitconfig and add

              -
              [url "ssh://git@github.com/"]
                  pushInsteadOf = https://github.com/
+
              [url "ssh://git@github.com/"]
              	pushInsteadOf = https://github.com/
 
              
-
              
-
              
-
              Questions
              If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
              
-
              
-
              Demos and Development
              Repo Setup
              The repo uses submodules. If you did not clone with  --recursive then you need to call
              
+
+
              
+
              
+
              Questions
              If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
              
+
              
+
              Demos and Development
              Repo Setup
              The repo uses submodules. If you did not clone with  --recursive then you need to call
              
 
              git submodule update --init
 
              
+
 
              The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.
              
 
              To develop and test:
 if you use yarn then run yarn
 if you use pnpm then run pnpm i
              
 
              Interactive Menu:
              
 
              To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.
              
-
              Build
              npm run build.all
-
              
+
              Build
              npm run build.all
+
              
+
 
              WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run
              
-
              Demos
              npm run demo.[ng|react|svelte|vue].[ios|android]

              npm run demo.svelte.ios # Example
-
              
+
              Demos
              npm run demo.[ng|react|svelte|vue].[ios|android]

              npm run demo.svelte.ios # Example
+
              
+
 
              Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue]
 Instead you work in demo-snippets/[ng|react|svelte|vue]
-You can start from the install.ts of each flavor to see how to register new demos 
              
-
              
-
              Contributing
              Update repo
              You can update the repo files quite easily
              
+You can start from the install.ts of each flavor to see how to register new demos
              
+
              
+
              Contributing
              Update repo
              You can update the repo files quite easily
              
 
              First update the submodules
              
-
              npm run update
-
              
+
              npm run update
+
              
+
 
              Then commit the changes
 Then update common files
              
-
              npm run sync
-
              
+
              npm run sync
+
              
+
 
              Then you can run yarn|pnpm, commit changed files if any
              
-
              Update readme
              npm run readme
-
              
-
              Update doc
              npm run doc
-
              
-
              Publish
              The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
-Simply run 
              
-
              npm run publish
-
              
-
              modifying submodules
              The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+
              Update readme
              npm run readme
+
              
+
+
              Update doc
              npm run doc
+
              
+
+
              Publish
              The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
+Simply run
              
+
              npm run publish
+
              
+
+
              modifying submodules
              The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
 One easy solution is t modify ~/.gitconfig and add
              
-
              [url "ssh://git@github.com/"]
                  pushInsteadOf = https://github.com/
+
              [url "ssh://git@github.com/"]
              	pushInsteadOf = https://github.com/
 
              
-
              
-
              Questions
              If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
              
-

Settings

Member Visibility

Theme

On This Page

Table of ContentsInstallationUsageDemos and DevelopmentContributingQuestionsDemos and DevelopmentContributingQuestions
\ No newline at end of file + +

+

Questions

If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.

+

Settings

Member Visibility

On This Page

Table of ContentsInstallationUsageDemos and DevelopmentContributingQuestionsDemos and DevelopmentContributingQuestions
diff --git a/docs/interfaces/DefaultLatLonKeys.html b/docs/interfaces/DefaultLatLonKeys.html index fd1f45b..c3b6324 100644 --- a/docs/interfaces/DefaultLatLonKeys.html +++ b/docs/interfaces/DefaultLatLonKeys.html @@ -1,5 +1,5 @@ -DefaultLatLonKeys | Track GPS location updates

Interface DefaultLatLonKeys

A data class that encapsulates common properties for a geolocation.

-
interface DefaultLatLonKeys {
    altitude?: number;
    latitude: number;
    longitude: number;
}

Properties

altitude? +DefaultLatLonKeys | Track GPS location updates

Interface DefaultLatLonKeys

A data class that encapsulates common properties for a geolocation.

+
interface DefaultLatLonKeys {
    altitude?: number;
    latitude: number;
    longitude: number;
}

Properties

altitude? latitude longitude -

Properties

Optional altitude

altitude?: number

latitude

latitude: number

longitude

longitude: number

Settings

Member Visibility

Theme

On This Page

altitudelatitudelongitude
\ No newline at end of file +

Properties

Optionalaltitude

altitude?: number

latitude

latitude: number

longitude

longitude: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Options.html b/docs/interfaces/Options.html index 3267b91..fdc2131 100644 --- a/docs/interfaces/Options.html +++ b/docs/interfaces/Options.html @@ -1,29 +1,29 @@ -Options | Track GPS location updates

Interface Options

Provides options for location monitoring.

-
interface Options {
    activityType?: any;
    allowsBackgroundLocationUpdates?: boolean;
    deferredLocationUpdates?: {
        timeout: number;
        traveled: number;
    };
    desiredAccuracy?: number;
    dontOpenSettings?: boolean;
    maximumAge?: number;
    minimumUpdateTime?: number;
    nmeaAltitude?: boolean;
    onDeferred?: deferredCallbackType;
    onLocationPaused?: (() => void);
    pausesLocationUpdatesAutomatically?: boolean;
    provider?: "gps" | "network" | "passive";
    skipPermissionCheck?: boolean;
    timeout?: number;
    updateDistance?: number;
}

Properties

activityType? -allowsBackgroundLocationUpdates? -deferredLocationUpdates? -desiredAccuracy? -dontOpenSettings? -maximumAge? -minimumUpdateTime? -nmeaAltitude? -onDeferred? -onLocationPaused? -pausesLocationUpdatesAutomatically? +Options | Track GPS location updates

Interface Options

Provides options for location monitoring.

+
interface Options {
    activityType?: any;
    allowsBackgroundLocationUpdates?: boolean;
    deferredLocationUpdates?: { timeout: number; traveled: number };
    desiredAccuracy?: number;
    dontOpenSettings?: boolean;
    maximumAge?: number;
    minimumUpdateTime?: number;
    nmeaAltitude?: boolean;
    onDeferred?: deferredCallbackType;
    onLocationPaused?: () => void;
    pausesLocationUpdatesAutomatically?: boolean;
    provider?: "gps" | "network" | "passive";
    skipPermissionCheck?: boolean;
    timeout?: number;
    updateDistance?: number;
}

Properties

activityType? +allowsBackgroundLocationUpdates? +deferredLocationUpdates? +desiredAccuracy? +dontOpenSettings? +maximumAge? +minimumUpdateTime? +nmeaAltitude? +onDeferred? +onLocationPaused? +pausesLocationUpdatesAutomatically? provider? -skipPermissionCheck? -timeout? -updateDistance? -

Properties

Optional activityType

activityType?: any

iOS only

-

Optional allowsBackgroundLocationUpdates

allowsBackgroundLocationUpdates?: boolean

iOS only

-

Optional deferredLocationUpdates

deferredLocationUpdates?: {
    timeout: number;
    traveled: number;
}

iOS only

-

Type declaration

  • timeout: number
  • traveled: number

Optional desiredAccuracy

desiredAccuracy?: number

Specifies desired accuracy in meters. Defaults to DesiredAccuracy.HIGH

-

Optional dontOpenSettings

dontOpenSettings?: boolean

monitor the location in the background.

-

Optional maximumAge

maximumAge?: number

how old locations to receive in ms.

-

Optional minimumUpdateTime

minimumUpdateTime?: number

Minimum time interval between location updates, in milliseconds.

-

Optional nmeaAltitude

nmeaAltitude?: boolean

Optional onDeferred

onDeferred?: deferredCallbackType

Optional onLocationPaused

onLocationPaused?: (() => void)

Type declaration

    • (): void

    • Returns void

Optional pausesLocationUpdatesAutomatically

pausesLocationUpdatesAutomatically?: boolean

iOS only

-

Optional provider

provider?: "gps" | "network" | "passive"

android only

-

Optional skipPermissionCheck

skipPermissionCheck?: boolean

monitor the location in the background.

-

Optional timeout

timeout?: number

how long to wait for a location in ms.

-

Optional updateDistance

updateDistance?: number

Update distance filter in meters. Specifies how often to update. Default on iOS is no filter, on Android it is 0 meters

-

Settings

Member Visibility

Theme

On This Page

activityTypeallowsBackgroundLocationUpdatesdeferredLocationUpdatesdesiredAccuracydontOpenSettingsmaximumAgeminimumUpdateTimenmeaAltitudeonDeferredonLocationPausedpausesLocationUpdatesAutomaticallyproviderskipPermissionChecktimeoutupdateDistance
\ No newline at end of file +skipPermissionCheck? +timeout? +updateDistance? +

Properties

OptionalactivityType

activityType?: any

iOS only

+

OptionalallowsBackgroundLocationUpdates

allowsBackgroundLocationUpdates?: boolean

iOS only

+

OptionaldeferredLocationUpdates

deferredLocationUpdates?: { timeout: number; traveled: number }

iOS only

+

OptionaldesiredAccuracy

desiredAccuracy?: number

Specifies desired accuracy in meters. Defaults to DesiredAccuracy.HIGH

+

OptionaldontOpenSettings

dontOpenSettings?: boolean

monitor the location in the background.

+

OptionalmaximumAge

maximumAge?: number

how old locations to receive in ms.

+

OptionalminimumUpdateTime

minimumUpdateTime?: number

Minimum time interval between location updates, in milliseconds.

+

OptionalnmeaAltitude

nmeaAltitude?: boolean

OptionalonDeferred

onDeferred?: deferredCallbackType

OptionalonLocationPaused

onLocationPaused?: () => void

OptionalpausesLocationUpdatesAutomatically

pausesLocationUpdatesAutomatically?: boolean

iOS only

+

Optionalprovider

provider?: "gps" | "network" | "passive"

android only

+

OptionalskipPermissionCheck

skipPermissionCheck?: boolean

monitor the location in the background.

+

Optionaltimeout

timeout?: number

how long to wait for a location in ms.

+

OptionalupdateDistance

updateDistance?: number

Update distance filter in meters. Specifies how often to update. Default on iOS is no filter, on Android it is 0 meters

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/media/Basic.vue b/docs/media/Basic.vue new file mode 100644 index 0000000..582743b --- /dev/null +++ b/docs/media/Basic.vue @@ -0,0 +1,118 @@ + + + + + diff --git a/docs/modules.html b/docs/modules.html index 854e90c..a3670ff 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,24 +1 @@ -Track GPS location updates

Track GPS location updates

Index

Enumerations

CLogTypes -

Classes

GPS -GPSCommon -LocationMonitor -

Interfaces

DefaultLatLonKeys -Options -

Type Aliases

AltitudeKeys -GenericGeoLocation -GeoLocation -LatitudeKeys -LongitudeKeys -deferredCallbackType -errorCallbackType -successCallbackType -

Variables

AltitudeKey -GPSTraceCategory -LatitudeKey -LongitudeKey -defaultGetLocationTimeout -

Functions

CLog -isMockEnabled -setGeoLocationKeys -setMockEnabled -

Settings

Member Visibility

Theme

\ No newline at end of file +Track GPS location updates

Track GPS location updates

Enumerations

CLogTypes

Classes

GPS
GPSCommon
LocationMonitor

Interfaces

DefaultLatLonKeys
Options

Type Aliases

AltitudeKeys
deferredCallbackType
errorCallbackType
GenericGeoLocation
GeoLocation
LatitudeKeys
LongitudeKeys
successCallbackType

Variables

AltitudeKey
defaultGetLocationTimeout
GPSTraceCategory
LatitudeKey
LongitudeKey

Functions

CLog
isMockEnabled
setGeoLocationKeys
setMockEnabled

Settings

Member Visibility

On This Page

Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
diff --git a/docs/types/AltitudeKeys.html b/docs/types/AltitudeKeys.html index 2e7b4b6..8832ba5 100644 --- a/docs/types/AltitudeKeys.html +++ b/docs/types/AltitudeKeys.html @@ -1 +1 @@ -AltitudeKeys | Track GPS location updates

Type alias AltitudeKeys

AltitudeKeys: "altitude" | "alt" | "ele"

Settings

Member Visibility

Theme

\ No newline at end of file +AltitudeKeys | Track GPS location updates

Type Alias AltitudeKeys

AltitudeKeys: "altitude" | "alt" | "ele"

Settings

Member Visibility
diff --git a/docs/types/GenericGeoLocation.html b/docs/types/GenericGeoLocation.html index 0368678..8e8a91f 100644 --- a/docs/types/GenericGeoLocation.html +++ b/docs/types/GenericGeoLocation.html @@ -1,12 +1,12 @@ -GenericGeoLocation | Track GPS location updates

Type alias GenericGeoLocation<T>

GenericGeoLocation<T>: {
    [P in keyof T]: number
} & {
    age?: number;
    android?: any;
    bearing: number;
    elapsedBoot?: number;
    horizontalAccuracy: number;
    ios?: any;
    mslAltitude?: number;
    provider?: string;
    speed: number;
    timestamp: number;
    verticalAccuracy: number;
}

Type Parameters

Type declaration

  • Optional age?: number

    the location age from the moment it was received

    -
  • Optional android?: any

    The android-specific location object.

    -
  • bearing: number

    The bearing (course), in degrees.

    -
  • Optional elapsedBoot?: number

    the location time in elapsed ms since boot (lot more accurate)

    -
  • horizontalAccuracy: number

    The horizontal accuracy, in meters.

    -
  • Optional ios?: any

    The ios-specific CLLocation object.

    -
  • Optional mslAltitude?: number

    [android only]: nmea altitude

    -
  • Optional provider?: string

    [android only]: the provider of the location

    -
  • speed: number

    The speed, in meters/second over ground.

    -
  • timestamp: number

    The time at which this location was determined in ms since epoch

    -
  • verticalAccuracy: number

    The vertical accuracy, in meters.

    -

Settings

Member Visibility

Theme

\ No newline at end of file +GenericGeoLocation | Track GPS location updates

Type Alias GenericGeoLocation<T>

GenericGeoLocation: { [P in keyof T]: number } & {
    age?: number;
    android?: any;
    bearing: number;
    elapsedBoot?: number;
    horizontalAccuracy: number;
    ios?: any;
    mslAltitude?: number;
    provider?: string;
    speed: number;
    timestamp: number;
    verticalAccuracy: number;
}

Type Parameters

Type declaration

  • Optionalage?: number

    the location age from the moment it was received

    +
  • Optionalandroid?: any

    The android-specific location object.

    +
  • bearing: number

    The bearing (course), in degrees.

    +
  • OptionalelapsedBoot?: number

    the location time in elapsed ms since boot (lot more accurate)

    +
  • horizontalAccuracy: number

    The horizontal accuracy, in meters.

    +
  • Optionalios?: any

    The ios-specific CLLocation object.

    +
  • OptionalmslAltitude?: number

    [android only]: nmea altitude

    +
  • Optionalprovider?: string

    [android only]: the provider of the location

    +
  • speed: number

    The speed, in meters/second over ground.

    +
  • timestamp: number

    The time at which this location was determined in ms since epoch

    +
  • verticalAccuracy: number

    The vertical accuracy, in meters.

    +

Settings

Member Visibility
diff --git a/docs/types/GeoLocation.html b/docs/types/GeoLocation.html index 71adb1d..37a29e3 100644 --- a/docs/types/GeoLocation.html +++ b/docs/types/GeoLocation.html @@ -1 +1 @@ -GeoLocation | Track GPS location updates

Type alias GeoLocation

GeoLocation: GenericGeoLocation<DefaultLatLonKeys>

Settings

Member Visibility

Theme

\ No newline at end of file +GeoLocation | Track GPS location updates

Type Alias GeoLocation

GeoLocation: GenericGeoLocation<DefaultLatLonKeys>

Settings

Member Visibility
diff --git a/docs/types/LatitudeKeys.html b/docs/types/LatitudeKeys.html index e6df2a2..b1e4ccb 100644 --- a/docs/types/LatitudeKeys.html +++ b/docs/types/LatitudeKeys.html @@ -1 +1 @@ -LatitudeKeys | Track GPS location updates

Type alias LatitudeKeys

LatitudeKeys: "latitude" | "lat"

Settings

Member Visibility

Theme

\ No newline at end of file +LatitudeKeys | Track GPS location updates

Type Alias LatitudeKeys

LatitudeKeys: "latitude" | "lat"

Settings

Member Visibility
diff --git a/docs/types/LongitudeKeys.html b/docs/types/LongitudeKeys.html index 2cc584b..cad23ca 100644 --- a/docs/types/LongitudeKeys.html +++ b/docs/types/LongitudeKeys.html @@ -1 +1 @@ -LongitudeKeys | Track GPS location updates

Type alias LongitudeKeys

LongitudeKeys: "longitude" | "lon" | "lng"

Settings

Member Visibility

Theme

\ No newline at end of file +LongitudeKeys | Track GPS location updates

Type Alias LongitudeKeys

LongitudeKeys: "longitude" | "lon" | "lng"

Settings

Member Visibility
diff --git a/docs/types/deferredCallbackType.html b/docs/types/deferredCallbackType.html index bedc50d..5be4431 100644 --- a/docs/types/deferredCallbackType.html +++ b/docs/types/deferredCallbackType.html @@ -1 +1 @@ -deferredCallbackType | Track GPS location updates

Type alias deferredCallbackType

deferredCallbackType: ((error?) => void)

Type declaration

    • (error?): void

    • Parameters

      • Optional error: Error

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +deferredCallbackType | Track GPS location updates

Type Alias deferredCallbackType

deferredCallbackType: (error?: Error) => void

Settings

Member Visibility
diff --git a/docs/types/errorCallbackType.html b/docs/types/errorCallbackType.html index 948ef04..c9629a3 100644 --- a/docs/types/errorCallbackType.html +++ b/docs/types/errorCallbackType.html @@ -1 +1 @@ -errorCallbackType | Track GPS location updates

Type alias errorCallbackType

errorCallbackType: ((error) => void)

Type declaration

    • (error): void

    • Parameters

      • error: Error

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +errorCallbackType | Track GPS location updates

Type Alias errorCallbackType

errorCallbackType: (error: Error) => void

Settings

Member Visibility
diff --git a/docs/types/successCallbackType.html b/docs/types/successCallbackType.html index 8175d97..52b68d5 100644 --- a/docs/types/successCallbackType.html +++ b/docs/types/successCallbackType.html @@ -1 +1 @@ -successCallbackType | Track GPS location updates

Type alias successCallbackType<T>

successCallbackType<T>: ((location, manager?) => void)

Type Parameters

  • T

Type declaration

    • (location, manager?): void

    • Parameters

      Returns void

Settings

Member Visibility

Theme

\ No newline at end of file +successCallbackType | Track GPS location updates

Type Alias successCallbackType<T>

successCallbackType: (location: GenericGeoLocation<T>, manager?: any) => void

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/variables/AltitudeKey.html b/docs/variables/AltitudeKey.html index 032317a..80fff92 100644 --- a/docs/variables/AltitudeKey.html +++ b/docs/variables/AltitudeKey.html @@ -1 +1 @@ -AltitudeKey | Track GPS location updates

Variable AltitudeKey

AltitudeKey: AltitudeKeys

Settings

Member Visibility

Theme

\ No newline at end of file +AltitudeKey | Track GPS location updates

Variable AltitudeKey

AltitudeKey: AltitudeKeys

Settings

Member Visibility
diff --git a/docs/variables/GPSTraceCategory.html b/docs/variables/GPSTraceCategory.html index 80cb7e4..86e5e15 100644 --- a/docs/variables/GPSTraceCategory.html +++ b/docs/variables/GPSTraceCategory.html @@ -1 +1 @@ -GPSTraceCategory | Track GPS location updates

Variable GPSTraceCategoryConst

GPSTraceCategory: "N-GPS" = "N-GPS"

Settings

Member Visibility

Theme

\ No newline at end of file +GPSTraceCategory | Track GPS location updates

Variable GPSTraceCategoryConst

GPSTraceCategory: "N-GPS"

Settings

Member Visibility
diff --git a/docs/variables/LatitudeKey.html b/docs/variables/LatitudeKey.html index d589f94..96a7a6c 100644 --- a/docs/variables/LatitudeKey.html +++ b/docs/variables/LatitudeKey.html @@ -1 +1 @@ -LatitudeKey | Track GPS location updates

Variable LatitudeKey

LatitudeKey: LatitudeKeys

Settings

Member Visibility

Theme

\ No newline at end of file +LatitudeKey | Track GPS location updates

Variable LatitudeKey

LatitudeKey: LatitudeKeys

Settings

Member Visibility
diff --git a/docs/variables/LongitudeKey.html b/docs/variables/LongitudeKey.html index f943fe5..a84b6aa 100644 --- a/docs/variables/LongitudeKey.html +++ b/docs/variables/LongitudeKey.html @@ -1 +1 @@ -LongitudeKey | Track GPS location updates

Variable LongitudeKey

LongitudeKey: LongitudeKeys

Settings

Member Visibility

Theme

\ No newline at end of file +LongitudeKey | Track GPS location updates

Variable LongitudeKey

LongitudeKey: LongitudeKeys

Settings

Member Visibility
diff --git a/docs/variables/defaultGetLocationTimeout.html b/docs/variables/defaultGetLocationTimeout.html index be461f5..042db1e 100644 --- a/docs/variables/defaultGetLocationTimeout.html +++ b/docs/variables/defaultGetLocationTimeout.html @@ -1 +1 @@ -defaultGetLocationTimeout | Track GPS location updates

Variable defaultGetLocationTimeoutConst

defaultGetLocationTimeout: number

Settings

Member Visibility

Theme

\ No newline at end of file +defaultGetLocationTimeout | Track GPS location updates

Variable defaultGetLocationTimeoutConst

defaultGetLocationTimeout: number

Settings

Member Visibility