From f2f37617c8312ffb329596a35abf821129c81d81 Mon Sep 17 00:00:00 2001 From: johnlettman Date: Mon, 24 Jun 2024 14:34:41 +0000 Subject: [PATCH] deploy: 04794c7393de9a6d196708464a142d16c5ee6d1b --- assets/icons.js | 31 ++++--- assets/icons.svg | 2 +- assets/main.js | 9 +- assets/search.js | 2 +- assets/style.css | 88 ++++++++++++------- functions/loader.api.html | 4 +- functions/loader.loader.html | 8 +- .../properties.defaultPropertiesFilter.html | 6 +- functions/properties.hasProperties.html | 6 +- functions/properties.isTraversible.html | 6 +- functions/properties.processProperties.html | 6 +- functions/syntax.stripComments.html | 4 +- functions/syntax.stripWhitespace.html | 4 +- index.html | 60 +++++++------ modules/loader.html | 4 +- modules/properties.html | 4 +- modules/syntax.html | 4 +- types/loader.Options.html | 28 +++--- types/loader.PropertiesFilter.html | 2 +- variables/syntax.maxContentSize.html | 4 +- 20 files changed, 158 insertions(+), 124 deletions(-) diff --git a/assets/icons.js b/assets/icons.js index b79c9e8..e88e8ca 100644 --- a/assets/icons.js +++ b/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 = `""`; + 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/assets/icons.svg b/assets/icons.svg index 7dead61..e371b8b 100644 --- a/assets/icons.svg +++ b/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js index d6f1388..7d7f77a 100644 --- a/assets/main.js +++ b/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."}; +"use strict";(()=>{var Ce=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Ce(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(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),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=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 ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.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){se.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.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)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)})})}};var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(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=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){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",()=>{ce(e,t)}),ce(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",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),Ve(t,i,r,e)}function Ve(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?He(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(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(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(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 He(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),te(e)}}function he(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(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",H="mouseup",J={x:0,y:0},me=!1,ne=!1,je=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(je=!0,F="touchstart",ye="touchmove",H="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!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,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!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 re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.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()),ge.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 Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){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=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(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='',be(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)Se(u,l,i)}else be(t,r,t.class)}function be(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.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-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var qe=new U;Object.defineProperty(window,"app",{value:qe});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/search.js b/assets/search.js index 00b5c5c..8208899 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VX227bMAz9F+3VSCM5di6vBTZswNYBLbaHIChcR1m12pZhOW23IP8++RZRMRU4bfbSQhEPecRDifSOFPJFkcVyR55EtiYL5pEsSjlZkERGa14Qj2yLRC9Tud4mXF01P48eyzTRe3ESKcW1A0L2XucjnBycRLk4eNhss7gUMjv40JuIH4/kUcGz0lAwntl4PqWB4fi9kDkvSsHVR5GUgG35Jzdcj63ODBoGgR8eQt7fV77PCPThgDgVr4c9ceqbvE4jzqHd/G9nhP4HHq3ja8LRMTM1wtXXurYGxxsBxJDAo5amI74qC5FfyzTV2AFJ7Ugcwy7F5OejKLnKo/iMhPSBF2ATR/Ej/8Tll9ubb8OpHKEukRWR5onYiDiqrO9kwosoOys7TgcXYPfEeW7u7nBSPdwFuOSDnkOMDYK8AB+p0lL+4vK3ktngR6ujhIMvweqZF7n2cj6jHvBtbEB/PGqyvRbp7LYnuyRSEL0+braG9nKh7opIp0CJB/BYG8rAo2V6mj2giEZ9jBRyvdColun7our9mKvBkXvm74u+5ptom5TO6Qbl4AC9gYmpH/UnK6PXXu00Pw+tG1dXM6do/R0ZnmbeUnNH7HV0PF5ndmY03yQpjV6vZVZqw1vx1xzvOSpE9ADSZdsNi7fyiA7HX8liR+r7JDO9y0b+aK7NN4In62p6b6hoZ81hyKrd+8HjUhaVRWNyNSbecuwxfzShs9XKW3aIeqP+oTajekU9NhsFLLTMqGXG9Iph3phl5uuVj5n5ltlEryZY0IllFri8BZZZqFcB5i20zKZ6FWLeppbZTK+mmNnMMtOiLGdY0Lmd3irbczS/RzrUQoxRS1sK6tSC2mLQKukUF9fWg1Z5pwy1tCWhgausqC0KrZJPfdSlrQut8k/RcqC2NLSSgKJSU1sdWqlAQ9TSFohVMtApZslshVitEKo5O7oszFVDzFaI+a6aZLZArBYIrSPWCFQ/H/rdKPn6c/OM6Ieg+2jbkfv2bfG7t2xHfP1n75Gg+rc3D0q1qvzX3/MGSA2QOhD190A7xkHozEDnDmjb0UyP2rRtEBCYGjdaGdwPV2n7uWiAgcGFDpgeJ+D8BIICsC4xHC10dwHTEkBPAHrqQFdfB47gYwB3Jb0bKw0MoMaNxNSlse5TcdOnVN3PQOw5yPbEAZfddGxw4MROFJj2EQ8UVprv8tHO5xieAbyLQzvFOfIeAg+uinVAwf2irmo7VeWAPGvFYw439rduab51jTcgInVdmXo0ig8TlAGDLEwbKswlR+3jBcx9xgu4tbPWi/NA7QgK0gmeDobeAP3s5SLnici00XK13/8D2rviQ+cUAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VYwY7bNhD9F/YqOB7Kkuy9BkjRAm0KJGgPhrFQZLrLRhIFUU42NfzvpSjJJM2RQSfuZdcU+d48Uo+coU6kFV8ledqeyGde78kTjUidV4w8kVLke9aSiBzbUjUrsT+WTL4ZHi9euqpUfUWZS8kUASHnaOJIVxeSvOEXhsOxLjou6guH6kR4ItLkLas7I8Ew0+Umg8Ro/KMVDWs7zuQ7XnaW2u5bY7Rej7ozaJokcXoJ+fzcc98R6KcL4lY8D3tj1u8bvYy4hrHzf5ujzR84tUmvCQdLajzC5G/aW8HxFhYiJPBilDkTX3Ytb96KqlLYgEWdRFzDHqXkrxfeMdnkxR0L4gMfoKbIixf2MxO/fnj/e7iUK9QjVoVXTckPvMj70R9Fydq8vmt1ZgkeoO4zY43Zu+GiPNwDtDRBxyGmBkE+QI+QVSf+ZuIfKergQ2uShIMfoeoLaxvFcr8iD/h9aqz8eJVkvRQ5m21vZknEEF4eN12huZzLj22ulkDyT9ZhbSRbjM7Q2+otiWjUl1wi2wuN6gz9saiqv2AyOLI3/Mei79khP5bdbHWDapgBfYcS4x/5re7yV887w+NQ38xlNTOLke9q4G3lo7T5iF5Gx+NNw+6MFptFqvLXt6Lu1MAP/F8zvS95y/NP1nK548Li7SKiwrFX8nQiej+JWvXSRbzYqOEHzsp9X70PUhTZMBn1ay+Ko/65G4f9yYpOtP3gYfSbJYm2y4jGixWsd7toO4F1h34wcZgnGgiqBRFdLxKaOkDwgOAAqWpRLCL1gNQBxqoVY8DYA8YOcKVaK0zqygOuHGAyFzHxgIkDTFUrwSKmHjB1gJlqpVjEzANmDnCtWhkGXHvAtQNUDtquMakbD7hxDdD7YYM6wPcOXJlHu2eJghH/uAaCWQeBbyFwPQS9MwD3rW8jcH0EvTuAomDfSuB6CZK5nQa+m8C1E/QmgRgN7DsKXEtBbxRA/Q++q8C1FfRmAdTK4DsLXGtBbxhIUbDvLnDtRXvHQIaBqe8v6vqLan+htqa+v+jVAUXn9hJFjijXXzSe28DUtxd17UW1vdAdRX17jY90alA5oWP7X4YUoU726UJ+Is9j3oinPHUisfpzjkjS/zubZKEfXvJF39eH019uDA0YGgjC63vgWL7bRGtDtAkiGusaU6kcxmLIEpcZUuWHEFYmq/ETgqFJDEsaRKIKTrvCtgRZVGprhHBxVY1Y1bXFtbK4siCu/m45I2xpkYW9yOmKYkgsjuUAgjBPqQqoGCogqSslS9fGeoOrIDIx3cIMi7VSgRzWHRPhA9v1cRjjeEfE2KjFFqZvvFfMvMvU4gvbSzNE1hkBYc6/tRutadLRHjSI1P1O05nvNIbbsgmEbXRd5BeXu4ChslYvG7A07BVrxq/WfcZwWufQeuQMnPp40bJeinVQ0oCdqtJBwxtW8lpBtrvz+T/cQoqL2xcAAA=="; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 778b949..d0c980d 100644 --- a/assets/style.css +++ b/assets/style.css @@ -10,6 +10,7 @@ --light-color-text: #222; --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; @@ -35,6 +36,7 @@ --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-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; @@ -50,6 +52,7 @@ --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; @@ -75,6 +78,7 @@ --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-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; @@ -92,6 +96,7 @@ --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -116,6 +121,7 @@ --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); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -134,6 +140,7 @@ --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -158,6 +165,7 @@ --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); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); @@ -183,6 +191,7 @@ body { --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -207,6 +216,7 @@ body { --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); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -223,6 +233,7 @@ body { --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -247,11 +258,17 @@ body { --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); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + .always-visible, .always-visible .tsd-signatures { display: inherit !important; @@ -266,16 +283,6 @@ h6 { line-height: 1.2; } -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -306,10 +313,6 @@ h6 { margin: 2.33rem 0; } -.uppercase { - text-transform: uppercase; -} - dl, menu, ol, @@ -333,7 +336,7 @@ footer { padding-bottom: 1rem; max-height: 3.5rem; } -.tsd-generator { +footer > p { margin: 0 1em; } @@ -421,6 +424,9 @@ a.external[target="_blank"] { background-repeat: no-repeat; padding-right: 13px; } +a.tsd-anchor-link { + color: var(--color-text); +} code, pre { @@ -580,13 +586,13 @@ dl.tsd-comment-tag-group p { } .tsd-filter-input { display: flex; - width: fit-content; width: -moz-fit-content; + width: fit-content; align-items: center; - user-select: none; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } .tsd-filter-input input[type="checkbox"] { @@ -609,11 +615,8 @@ dl.tsd-comment-tag-group p { 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-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); } .tsd-checkbox-background { fill: var(--color-accent); @@ -630,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { stroke: var(--color-accent); } -.tsd-theme-toggle { - padding-top: 0.75rem; +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; } -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; } .tsd-hierarchy { @@ -769,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding: 0; max-width: 100%; } +.tsd-navigation .tsd-nav-link { + display: none; +} .tsd-nested-navigation { margin-left: 3rem; } @@ -812,10 +823,10 @@ a.tsd-index-link { } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } @@ -828,7 +839,7 @@ a.tsd-index-link { padding-top: 0; padding-bottom: 0; } -.tsd-index-accordion .tsd-accordion-summary > svg { +.tsd-accordion .tsd-accordion-summary > svg { margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { @@ -877,7 +888,7 @@ a.tsd-index-link { } .tsd-panel-group { - margin: 4rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group { margin: 2rem 0; @@ -885,6 +896,9 @@ a.tsd-index-link { .tsd-panel-group.tsd-index-group details { margin: 2rem 0; } +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} #tsd-search { transition: background-color 0.2s; @@ -1034,6 +1048,12 @@ a.tsd-index-link { 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; } @@ -1347,6 +1367,12 @@ img { .has-menu .tsd-navigation { max-height: 100%; } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } } /* one sidebar */ diff --git a/functions/loader.api.html b/functions/loader.api.html index 507f62e..29ad6c0 100644 --- a/functions/loader.api.html +++ b/functions/loader.api.html @@ -1,3 +1,3 @@ -api | OverpassQL Loader

Function api

  • api(query, opts?): Promise<OverpassJson>

  • API function for Overpass JSON responses. +api | OverpassQL Loader

    Function api

    API function for Overpass JSON responses. Useful if you want to implement your own way of doing it. :-)

    -

    Parameters

    • query: string
    • Optional opts: Partial<OverpassOptions>

    Returns Promise<OverpassJson>

Settings

Member Visibility

Theme

\ No newline at end of file +
  • api(query, opts?): Promise<OverpassJson>

  • Parameters

    • query: string
    • Optionalopts: Partial<OverpassOptions>

    Returns Promise<OverpassJson>

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/loader.loader.html b/functions/loader.loader.html index eb0421e..d363ca9 100644 --- a/functions/loader.loader.html +++ b/functions/loader.loader.html @@ -1,8 +1,8 @@ -loader | OverpassQL Loader

Function loader

  • loader(this, content): void

  • Main OverpassQL webpack loader function.

    +loader | OverpassQL Loader

    Function loader

    • loader(this, content): void

    • Main OverpassQL webpack loader function.

      Parameters

      • this: LoaderContext<Options>

        the webpack loader context

      • content: string

        OverpassQL content

        -

      Returns void

      Description

      Consumes OverpassQL source content and transforms it into a +

    Returns void

    Description

    Consumes OverpassQL source content and transforms it into a loadable JavaScript module, optionally with minification and precached GeoJSON results.

    -

    Throws

    when this (loader context) is not provided

    -

Settings

Member Visibility

Theme

\ No newline at end of file +

Throws

when this (loader context) is not provided

+

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/properties.defaultPropertiesFilter.html b/functions/properties.defaultPropertiesFilter.html index 48d6355..9ca4546 100644 --- a/functions/properties.defaultPropertiesFilter.html +++ b/functions/properties.defaultPropertiesFilter.html @@ -1,5 +1,5 @@ -defaultPropertiesFilter | OverpassQL Loader

Function defaultPropertiesFilter

  • defaultPropertiesFilter(properties): GeoJsonProperties

  • The default OpenStreetMaps properties and tags filter. +defaultPropertiesFilter | OverpassQL Loader

    Function defaultPropertiesFilter

    The default OpenStreetMaps properties and tags filter. This removes everything but names and addresses.

    -

    Parameters

    • properties: GeoJsonProperties

      Key-value object containing OpenStreetMap tags

      +
    • defaultPropertiesFilter(properties): GeoJsonProperties

    • Parameters

      • properties: GeoJsonProperties

        Key-value object containing OpenStreetMap tags

      Returns GeoJsonProperties

      Properties with tags other than name and address removed

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/properties.hasProperties.html b/functions/properties.hasProperties.html index 0c14fb6..300b403 100644 --- a/functions/properties.hasProperties.html +++ b/functions/properties.hasProperties.html @@ -1,5 +1,5 @@ -hasProperties | OverpassQL Loader

Function hasProperties

  • hasProperties(obj?): boolean

  • Helper function to determine whether an object contains OpenStreetMaps +hasProperties | OverpassQL Loader

    Function hasProperties

    • hasProperties(obj?): boolean

    • Helper function to determine whether an object contains OpenStreetMaps GeoJSON properties.

      -

      Parameters

      • Optional obj: null | object

        The object to check

        +

        Parameters

        • Optionalobj: null | object

          The object to check

        Returns boolean

        True when the object contains properties

        -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/properties.isTraversible.html b/functions/properties.isTraversible.html index 8d4a741..0af6263 100644 --- a/functions/properties.isTraversible.html +++ b/functions/properties.isTraversible.html @@ -1,5 +1,5 @@ -isTraversible | OverpassQL Loader

Function isTraversible

  • isTraversible(obj?): boolean

  • Helper function to determine whether an object is a real traversible +isTraversible | OverpassQL Loader

    Function isTraversible

    • isTraversible(obj?): boolean

    • Helper function to determine whether an object is a real traversible key-value object, e.g., GeoJSON.

      -

      Parameters

      • Optional obj: null | object

        The object to check

        +

        Parameters

        • Optionalobj: null | object

          The object to check

        Returns boolean

        True when the object is traversible

        -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/properties.processProperties.html b/functions/properties.processProperties.html index 4e5f783..f1d7240 100644 --- a/functions/properties.processProperties.html +++ b/functions/properties.processProperties.html @@ -1,6 +1,6 @@ -processProperties | OverpassQL Loader

Function processProperties

  • processProperties(geojson, filter?): GeoJsonProperties

  • Helper function to process OpenStreetMaps GeoJSON with the supplied filter +processProperties | OverpassQL Loader

    Function processProperties

    • processProperties(geojson, filter?): GeoJsonProperties

    • Helper function to process OpenStreetMaps GeoJSON with the supplied filter function. Scans the entire object at multiple levels for filtering.

      Parameters

      • geojson: GeoJsonProperties | FeatureCollection<Geometry, GeoJsonProperties>

        OpenStreetMaps GeoJSON object

        -
      • Optional filter: PropertiesFilter

        filtering function

        +
      • Optionalfilter: PropertiesFilter

        filtering function

      Returns GeoJsonProperties

      OpenStreetMaps GeoJSON object after filtering with the function

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/syntax.stripComments.html b/functions/syntax.stripComments.html index 06da3cc..a438743 100644 --- a/functions/syntax.stripComments.html +++ b/functions/syntax.stripComments.html @@ -1,4 +1,4 @@ -stripComments | OverpassQL Loader

Function stripComments

  • stripComments(content): string

  • Remove comments from an OverpassQL string.

    +stripComments | OverpassQL Loader

    Function stripComments

    • stripComments(content): string

    • Remove comments from an OverpassQL string.

      Parameters

      • content: string

        OverpassQL content string

      Returns string

      OverpassQL content string with comments removed

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/functions/syntax.stripWhitespace.html b/functions/syntax.stripWhitespace.html index c0df9d2..2b7772a 100644 --- a/functions/syntax.stripWhitespace.html +++ b/functions/syntax.stripWhitespace.html @@ -1,4 +1,4 @@ -stripWhitespace | OverpassQL Loader

Function stripWhitespace

  • stripWhitespace(content): string

  • Remove whitespace from an OverpassQL string while preserving comments.

    +stripWhitespace | OverpassQL Loader

    Function stripWhitespace

    • stripWhitespace(content): string

    • Remove whitespace from an OverpassQL string while preserving comments.

      Parameters

      • content: string

        OverpassQL content string

      Returns string

      OverpassQL content string with extra whitespace removed

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/index.html b/index.html index 904e00d..16c0754 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -OverpassQL Loader

OverpassQL Loader

+OverpassQL Loader

OverpassQL Loader

@@ -9,13 +9,12 @@

OverpassQL Loader

-

License -Package Version -Programming Language +Package Version +Programming Language Minimized Size -Test Results -Code Coverage

+Test Results +Code Coverage

This Webpack loader allows you to pull in OverpassQL files as strings, providing seamless integration of OpenStreetMap data into your application.

@@ -23,58 +22,63 @@

OverpassQL Loader

your Webpack build process, but it also optionally caches the responses from an Overpass API server to speed up your production application.

-

Features

    +

    Features

    • Implemented in TypeScript for strong type safety.
    • Load OverpassQL scripts as strings into your JavaScript or TypeScript application.
    • Optionally cache responses from an Overpass API server.
    -

    Installation

    You can install the loader using npm, yarn, or your preferred JavaScript +

    Installation

    You can install the loader using npm, yarn, or your preferred JavaScript package management program.

    -
    yarn add --dev overpassql-loader
-
    +
    yarn add --dev overpassql-loader
+
    +

    or

    -
    npm install --save-dev overpassql-loader
-
    -

    Usage

    Add overpassql-loader to your Webpack configuration:

    -
    import type { Configuration, RuleSetUse } from 'webpack';
    import type { PropertiesFilter } from 'overpassql-loader';

    const IS_DEV: boolean = (process.env.NODE_ENV === 'development');

    const propertiesFilter: PropertiesFilter = (properties) => ({
      return (Object.keys(properties)
        .filter(tag => /addr:.*/i.test(tag))
        .reduce((filtered, tag) => {
          filtered[tag] = properties[tag];
          return filtered;
        }, {}));
    });

    const useOverpassql: RuleSetUse = {
      test: /\.overpass(ql)?$/,
      options: {
        // minify the query
        stripWhitespace: !IS_DEV,
        stripComments: !IS_DEV,

        // cache API response
        cacheGeoJSON: !IS_DEV,

        // remove tags we're not interested in
        keepProperties: false,
        propertiesFilter
      }
    }

    export const config: Configuration = {
      module: {
        rules: [useOverpassql]
      }
    }
-
    +
    npm install --save-dev overpassql-loader
+
    + +

    Usage

    Add overpassql-loader to your Webpack configuration:

    +
    import type { Configuration, RuleSetUse } from 'webpack';
    import type { PropertiesFilter } from 'overpassql-loader';

    const IS_DEV: boolean = (process.env.NODE_ENV === 'development');

    const propertiesFilter: PropertiesFilter = (properties) => ({
      return (Object.keys(properties)
        .filter(tag => /addr:.*/i.test(tag))
        .reduce((filtered, tag) => {
          filtered[tag] = properties[tag];
          return filtered;
        }, {}));
    });

    const useOverpassql: RuleSetUse = {
      test: /\.overpass(ql)?$/,
      options: {
        // minify the query
        stripWhitespace: !IS_DEV,
        stripComments: !IS_DEV,

        // cache API response
        cacheGeoJSON: !IS_DEV,

        // remove tags we're not interested in
        keepProperties: false,
        propertiesFilter
      }
    }

    export const config: Configuration = {
      module: {
        rules: [useOverpassql]
      }
    }
+
    +

    Use the import in your project:

    -
    import { overpassJson } from 'overpass-ts';
    import osmtogeojson from 'osmtogeojson';
    import query from './my-query.overpassql';

    const endpoint: string = 'https://overpass-api.de/api/interpreter';

    console.log(query); // print the query to console
    overpassJson(query, { endpoint }).then((osmdata) => {
      const geoJSON = osmtogeojson(osmdata);

      // work with the GeoJSON or OSM response
      // e.g., integrate with Leaflet.js GeoJSON layers
    });
-
    -

    Contributing

    General advice

    The following procedure for contributing changes is recommended:

    +
    import { overpassJson } from 'overpass-ts';
    import osmtogeojson from 'osmtogeojson';
    import query from './my-query.overpassql';

    const endpoint: string = 'https://overpass-api.de/api/interpreter';

    console.log(query); // print the query to console
    overpassJson(query, { endpoint }).then((osmdata) => {
      const geoJSON = osmtogeojson(osmdata);

      // work with the GeoJSON or OSM response
      // e.g., integrate with Leaflet.js GeoJSON layers
    });
+
    + +

    Contributing

    General advice

    The following procedure for contributing changes is recommended:

    • Branch to fix/[issue or description], feature/[issue or description], ...
    • Implement your changes and commit
    • Open a pull request
    -

    Of course, you're welcome to use any reasonable workflow that best suits your +

    Of course, you're welcome to use any reasonable workflow that best suits your style. After all, I committed to unprotected main throughout this project.

    Please add any of the following strings to your commit message if the commit does not modify any code (e.g., documentation work):

    [skip ci], [ci skip], [no ci], [skip actions], [actions skip]

    See: GitHub documentation, "skipping workflow runs"

    -

    Versioning

    To bump versions:

    -
    yarn version --patch
    yarn version --minor
    yarn version --major
-
    -

    Licensing

    Given this project is licensed under the MIT License, please be mindful that +

    Versioning

    To bump versions:

    +
    yarn version --patch
    yarn version --minor
    yarn version --major
+
    + +

    Licensing

    Given this project is licensed under the MIT License, please be mindful that your contributions will fall under the same licensing scheme.

    -

    Related Projects & Dependencies

    The following projects are core to the function of OverpassQL Loader. +

    Related Projects & Dependencies

    The following projects are core to the function of OverpassQL Loader. They are worth checking out. The authors have my thanks. :-)

    -

    overpass-ts

    +

    overpass-ts

    promise-based overpass api client in typescript

    -

    osmtogeojson

    +

    osmtogeojson

    Converts OSM data to GeoJSON.

    -

    License

    This project is licensed under the MIT License. +

    License

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

    -

Settings

Member Visibility

Theme

On This Page

FeaturesInstallationUsageContributingRelated Projects & DependenciesLicense
\ No newline at end of file +

Settings

Member Visibility

On This Page

FeaturesInstallationUsageContributingRelated Projects & DependenciesLicense
\ No newline at end of file diff --git a/modules/loader.html b/modules/loader.html index 045fb60..cfa9b56 100644 --- a/modules/loader.html +++ b/modules/loader.html @@ -1,5 +1,5 @@ -loader | OverpassQL Loader

Module loader

Index

Type Aliases

Options +loader | OverpassQL Loader

Module loader

Index

Type Aliases

Options PropertiesFilter

Functions

api loader -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/modules/properties.html b/modules/properties.html index 77c2d40..45728b7 100644 --- a/modules/properties.html +++ b/modules/properties.html @@ -1,5 +1,5 @@ -properties | OverpassQL Loader

Module properties

Index

Functions

defaultPropertiesFilter +properties | OverpassQL Loader

Module properties

Index

Functions

defaultPropertiesFilter hasProperties isTraversible processProperties -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/modules/syntax.html b/modules/syntax.html index 9598096..a010419 100644 --- a/modules/syntax.html +++ b/modules/syntax.html @@ -1,4 +1,4 @@ -syntax | OverpassQL Loader

Module syntax

Index

Variables

maxContentSize +syntax | OverpassQL Loader

Module syntax

Index

Variables

maxContentSize

Functions

stripComments stripWhitespace -

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file diff --git a/types/loader.Options.html b/types/loader.Options.html index 2bcb3bf..8a58266 100644 --- a/types/loader.Options.html +++ b/types/loader.Options.html @@ -1,28 +1,28 @@ -Options | OverpassQL Loader

Type alias Options

Options: {
    cacheGeoJSON?: boolean;
    esModule?: boolean;
    keepProperties?: boolean;
    osmtogeojsonOptions?: OsmToGeoJSONOptions;
    overpassOptions?: Partial<OverpassOptions>;
    propertiesFilter?: PropertiesFilter;
    simplificationTolerance?: number;
    stripComments?: boolean;
    stripWhitespace?: boolean;
}

OverpassQL Loader options.

-

Type declaration

  • Optional cacheGeoJSON?: boolean

    Preload and cache the Overpass API response from the query. +Options | OverpassQL Loader

    Type Alias Options

    Options: {
        cacheGeoJSON?: boolean;
        esModule?: boolean;
        keepProperties?: boolean;
        osmtogeojsonOptions?: OsmToGeoJSONOptions;
        overpassOptions?: Partial<OverpassOptions>;
        propertiesFilter?: PropertiesFilter;
        simplificationTolerance?: number;
        stripComments?: boolean;
        stripWhitespace?: boolean;
    }

    OverpassQL Loader options.

    +

    Type declaration

    • OptionalcacheGeoJSON?: boolean

      Preload and cache the Overpass API response from the query. Connects to the Overpass API specified in endpoint to execute the query and cache the GeoJSON response in the rendered module.

      -
    • Optional esModule?: boolean

      Emit an ES-style module. -(e.g. 'export default' instead of 'module.exports =')

      -
    • Optional keepProperties?: boolean

      Avoid clobbering properties when caching the GeoJSON response from the +

    • OptionalesModule?: boolean

      Emit an ES-style module. +(e.g. 'export default' instead of 'module.exports =')

      +
    • OptionalkeepProperties?: boolean

      Avoid clobbering properties when caching the GeoJSON response from the Overpass API.

      The value has no effect when cacheGeoJSON is not set or set to false.

      -
    • Optional osmtogeojsonOptions?: OsmToGeoJSONOptions

      Options to pass through to the "osmtogeojson" package.

      -

      See

      "osmtogeojson" package: +

    • OptionalosmtogeojsonOptions?: OsmToGeoJSONOptions

      Options to pass through to the "osmtogeojson" package.

      +

      See

      "osmtogeojson" package: https://github.com/tyrasd/osmtogeojson https://www.npmjs.com/package/osmtogeojson

      The value has no effect when cacheGeoJSON is not set or set to false.

      -
    • Optional overpassOptions?: Partial<OverpassOptions>

      Options to pass through to the Overpass API handler (e.g. "overpass-ts").

      -

      See

      "overpass-ts" package: +

    • OptionaloverpassOptions?: Partial<OverpassOptions>

      Options to pass through to the Overpass API handler (e.g. "overpass-ts").

      +

      See

      "overpass-ts" package: https://www.npmjs.com/package/overpass-ts

      -
    • Optional propertiesFilter?: PropertiesFilter

      Function to clobber properties (e.g. to remove or keep them).

      +
    • OptionalpropertiesFilter?: PropertiesFilter

      Function to clobber properties (e.g. to remove or keep them).

      The value has no effect when cacheGeoJSON is not set or set to false. The value has no effect when keepProperties is set to true.

      -
    • Optional simplificationTolerance?: number

      Tolerance value for shape simplification. +

    • OptionalsimplificationTolerance?: number

      Tolerance value for shape simplification. Function uses the "simplify-geojson" package: https://www.npmjs.com/package/simplify-geojson https://github.com/maxogden/simplify-geojson

      -
    • Optional stripComments?: boolean

      Remove comments to save space. +

    • OptionalstripComments?: boolean

      Remove comments to save space. The function to strip comments will respect "@preserve" directives.

      -
    • Optional stripWhitespace?: boolean

      Remove redundant whitespace to save space.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +
  • OptionalstripWhitespace?: boolean

    Remove redundant whitespace to save space.

    +

Settings

Member Visibility
\ No newline at end of file diff --git a/types/loader.PropertiesFilter.html b/types/loader.PropertiesFilter.html index 9892694..892b8b2 100644 --- a/types/loader.PropertiesFilter.html +++ b/types/loader.PropertiesFilter.html @@ -1 +1 @@ -PropertiesFilter | OverpassQL Loader

Type alias PropertiesFilter

PropertiesFilter: ((properties) => GeoJsonProperties)

Type declaration

    • (properties): GeoJsonProperties

    • Parameters

      • properties: GeoJsonProperties

      Returns GeoJsonProperties

Settings

Member Visibility

Theme

\ No newline at end of file +PropertiesFilter | OverpassQL Loader

Type Alias PropertiesFilter

PropertiesFilter: ((properties: GeoJsonProperties) => GeoJsonProperties)

Settings

Member Visibility
\ No newline at end of file diff --git a/variables/syntax.maxContentSize.html b/variables/syntax.maxContentSize.html index f8d737f..b314eec 100644 --- a/variables/syntax.maxContentSize.html +++ b/variables/syntax.maxContentSize.html @@ -1,3 +1,3 @@ -maxContentSize | OverpassQL Loader

Variable maxContentSizeConst

maxContentSize: number = 100000000

Maximum permissible content size, measured in number of characters, to +maxContentSize | OverpassQL Loader

Variable maxContentSizeConst

maxContentSize: number = 100000000

Maximum permissible content size, measured in number of characters, to prevent occurrences of ReDoS (Regular expression Denial of Service).

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility
\ No newline at end of file