diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 2b6d17a..733d7c9 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -25,8 +25,6 @@ --dark-hl-11: #569CD6; --light-hl-12: #098658; --dark-hl-12: #B5CEA8; - --light-hl-13: #0070C1; - --dark-hl-13: #4FC1FF; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -45,7 +43,6 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); --code-background: var(--light-code-background); } } @@ -63,7 +60,6 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); --code-background: var(--dark-code-background); } } @@ -81,7 +77,6 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); --code-background: var(--light-code-background); } @@ -99,7 +94,6 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); --code-background: var(--dark-code-background); } @@ -116,5 +110,4 @@ .hl-10 { color: var(--hl-10); } .hl-11 { color: var(--hl-11); } .hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } pre, code { background: var(--code-background); } diff --git a/docs/assets/main.js b/docs/assets/main.js index 4c8fa61..d0aa8d5 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.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,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},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),r=1,n=0;r0){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),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.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(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=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,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},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,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<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 r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,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 r=e.peekLexeme();if(r!=null)switch(r.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 n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.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 r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.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 '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;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 r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;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,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=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 r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);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()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=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=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!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&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);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 r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..839d306 --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5XUUU+DMBAH8O/S58XpdDPuzRcTH5xxmfPB+HBCgctKIe2VbDF+d5FNKVCge77//dpcD96/GPE9sSVbmZQrDF4MSEI6POeEmdRswnKgpKyjJK4iCLieuqMXCaWizO9Qhmw5my++J//4OktBVm0gapIOeanZtZZxeXd7NZ/1OPc6QBzCqsA54qvEIAv5kHmKjKlbI2JQDwqC39G0wWZ1zAp5BEZQ50EKUAifovSaiaZ3bVPy+HBrHvO9C7LrnswbUrJRgAJl/CgLEBiOyY6WgcOUNf3ei3dCnuDpOb1cO3sev8mqVXyC3POMusHzoC0Iw5270U0NkEVjMYev3Zf15nXv1F258XX8+x3VYmTkUZi2Ik1scWNhOSjN7S9eu7xuqkN+/AAwMkkfWwUAAA==" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index ca790fe..404a2c3 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":32,\"name\":\"vulgarFractionToAsciiMap\",\"url\":\"variables/vulgarFractionToAsciiMap.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"numericRegex\",\"url\":\"variables/numericRegex.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"numericRegexWithTrailingInvalid\",\"url\":\"variables/numericRegexWithTrailingInvalid.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"vulgarFractionsRegex\",\"url\":\"variables/vulgarFractionsRegex.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"romanNumeralValues\",\"url\":\"variables/romanNumeralValues.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/romanNumeralValues.html#__type\",\"classes\":\"\",\"parent\":\"romanNumeralValues\"},{\"kind\":1024,\"name\":\"MMM\",\"url\":\"variables/romanNumeralValues.html#__type.MMM\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"MM\",\"url\":\"variables/romanNumeralValues.html#__type.MM\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"M\",\"url\":\"variables/romanNumeralValues.html#__type.M\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"CM\",\"url\":\"variables/romanNumeralValues.html#__type.CM\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"DCCC\",\"url\":\"variables/romanNumeralValues.html#__type.DCCC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"DCC\",\"url\":\"variables/romanNumeralValues.html#__type.DCC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"DC\",\"url\":\"variables/romanNumeralValues.html#__type.DC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"D\",\"url\":\"variables/romanNumeralValues.html#__type.D\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"CD\",\"url\":\"variables/romanNumeralValues.html#__type.CD\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"CCC\",\"url\":\"variables/romanNumeralValues.html#__type.CCC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"CC\",\"url\":\"variables/romanNumeralValues.html#__type.CC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"C\",\"url\":\"variables/romanNumeralValues.html#__type.C\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XC\",\"url\":\"variables/romanNumeralValues.html#__type.XC\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"LXXX\",\"url\":\"variables/romanNumeralValues.html#__type.LXXX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"LXX\",\"url\":\"variables/romanNumeralValues.html#__type.LXX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"LX\",\"url\":\"variables/romanNumeralValues.html#__type.LX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"L\",\"url\":\"variables/romanNumeralValues.html#__type.L\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XL\",\"url\":\"variables/romanNumeralValues.html#__type.XL\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XXX\",\"url\":\"variables/romanNumeralValues.html#__type.XXX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XX\",\"url\":\"variables/romanNumeralValues.html#__type.XX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XII\",\"url\":\"variables/romanNumeralValues.html#__type.XII\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"XI\",\"url\":\"variables/romanNumeralValues.html#__type.XI\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"X\",\"url\":\"variables/romanNumeralValues.html#__type.X\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"IX\",\"url\":\"variables/romanNumeralValues.html#__type.IX\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"VIII\",\"url\":\"variables/romanNumeralValues.html#__type.VIII\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"VII\",\"url\":\"variables/romanNumeralValues.html#__type.VII\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"VI\",\"url\":\"variables/romanNumeralValues.html#__type.VI\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"V\",\"url\":\"variables/romanNumeralValues.html#__type.V\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"IV\",\"url\":\"variables/romanNumeralValues.html#__type.IV\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"III\",\"url\":\"variables/romanNumeralValues.html#__type.III\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"II\",\"url\":\"variables/romanNumeralValues.html#__type.II\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":1024,\"name\":\"I\",\"url\":\"variables/romanNumeralValues.html#__type.I\",\"classes\":\"\",\"parent\":\"romanNumeralValues.__type\"},{\"kind\":32,\"name\":\"romanNumeralUnicodeToAsciiMap\",\"url\":\"variables/romanNumeralUnicodeToAsciiMap.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"romanNumeralUnicodeRegex\",\"url\":\"variables/romanNumeralUnicodeRegex.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"romanNumeralRegex\",\"url\":\"variables/romanNumeralRegex.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"defaultOptions\",\"url\":\"variables/defaultOptions.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/defaultOptions.html#__type\",\"classes\":\"\",\"parent\":\"defaultOptions\"},{\"kind\":1024,\"name\":\"round\",\"url\":\"variables/defaultOptions.html#__type.round\",\"classes\":\"\",\"parent\":\"defaultOptions.__type\"},{\"kind\":1024,\"name\":\"allowTrailingInvalid\",\"url\":\"variables/defaultOptions.html#__type.allowTrailingInvalid\",\"classes\":\"\",\"parent\":\"defaultOptions.__type\"},{\"kind\":1024,\"name\":\"romanNumerals\",\"url\":\"variables/defaultOptions.html#__type.romanNumerals\",\"classes\":\"\",\"parent\":\"defaultOptions.__type\"},{\"kind\":64,\"name\":\"numericQuantity\",\"url\":\"functions/numericQuantity.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"parseRomanNumerals\",\"url\":\"functions/parseRomanNumerals.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"NumericQuantityOptions\",\"url\":\"interfaces/NumericQuantityOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"round\",\"url\":\"interfaces/NumericQuantityOptions.html#round\",\"classes\":\"\",\"parent\":\"NumericQuantityOptions\"},{\"kind\":1024,\"name\":\"allowTrailingInvalid\",\"url\":\"interfaces/NumericQuantityOptions.html#allowTrailingInvalid\",\"classes\":\"\",\"parent\":\"NumericQuantityOptions\"},{\"kind\":1024,\"name\":\"romanNumerals\",\"url\":\"interfaces/NumericQuantityOptions.html#romanNumerals\",\"classes\":\"\",\"parent\":\"NumericQuantityOptions\"},{\"kind\":4194304,\"name\":\"VulgarFraction\",\"url\":\"types/VulgarFraction.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"RomanNumeralAscii\",\"url\":\"types/RomanNumeralAscii.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"RomanNumeralUnicode\",\"url\":\"types/RomanNumeralUnicode.html\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"RomanNumeral\",\"url\":\"types/RomanNumeral.html\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,36.376]],[\"comment/0\",[]],[\"name/1\",[1,36.376]],[\"comment/1\",[]],[\"name/2\",[2,36.376]],[\"comment/2\",[]],[\"name/3\",[3,36.376]],[\"comment/3\",[]],[\"name/4\",[4,36.376]],[\"comment/4\",[]],[\"name/5\",[5,31.268]],[\"comment/5\",[]],[\"name/6\",[6,36.376]],[\"comment/6\",[]],[\"name/7\",[7,36.376]],[\"comment/7\",[]],[\"name/8\",[8,36.376]],[\"comment/8\",[]],[\"name/9\",[9,36.376]],[\"comment/9\",[]],[\"name/10\",[10,36.376]],[\"comment/10\",[]],[\"name/11\",[11,36.376]],[\"comment/11\",[]],[\"name/12\",[12,36.376]],[\"comment/12\",[]],[\"name/13\",[13,36.376]],[\"comment/13\",[]],[\"name/14\",[14,36.376]],[\"comment/14\",[]],[\"name/15\",[15,36.376]],[\"comment/15\",[]],[\"name/16\",[16,36.376]],[\"comment/16\",[]],[\"name/17\",[17,36.376]],[\"comment/17\",[]],[\"name/18\",[18,36.376]],[\"comment/18\",[]],[\"name/19\",[19,36.376]],[\"comment/19\",[]],[\"name/20\",[20,36.376]],[\"comment/20\",[]],[\"name/21\",[21,36.376]],[\"comment/21\",[]],[\"name/22\",[22,36.376]],[\"comment/22\",[]],[\"name/23\",[23,36.376]],[\"comment/23\",[]],[\"name/24\",[24,36.376]],[\"comment/24\",[]],[\"name/25\",[25,36.376]],[\"comment/25\",[]],[\"name/26\",[26,36.376]],[\"comment/26\",[]],[\"name/27\",[27,36.376]],[\"comment/27\",[]],[\"name/28\",[28,36.376]],[\"comment/28\",[]],[\"name/29\",[29,36.376]],[\"comment/29\",[]],[\"name/30\",[30,36.376]],[\"comment/30\",[]],[\"name/31\",[31,36.376]],[\"comment/31\",[]],[\"name/32\",[32,36.376]],[\"comment/32\",[]],[\"name/33\",[33,36.376]],[\"comment/33\",[]],[\"name/34\",[34,36.376]],[\"comment/34\",[]],[\"name/35\",[35,36.376]],[\"comment/35\",[]],[\"name/36\",[36,36.376]],[\"comment/36\",[]],[\"name/37\",[37,36.376]],[\"comment/37\",[]],[\"name/38\",[38,36.376]],[\"comment/38\",[]],[\"name/39\",[39,36.376]],[\"comment/39\",[]],[\"name/40\",[40,36.376]],[\"comment/40\",[]],[\"name/41\",[41,36.376]],[\"comment/41\",[]],[\"name/42\",[5,31.268]],[\"comment/42\",[]],[\"name/43\",[42,31.268]],[\"comment/43\",[]],[\"name/44\",[43,31.268]],[\"comment/44\",[]],[\"name/45\",[44,31.268]],[\"comment/45\",[]],[\"name/46\",[45,36.376]],[\"comment/46\",[]],[\"name/47\",[46,36.376]],[\"comment/47\",[]],[\"name/48\",[47,36.376]],[\"comment/48\",[]],[\"name/49\",[42,31.268]],[\"comment/49\",[]],[\"name/50\",[43,31.268]],[\"comment/50\",[]],[\"name/51\",[44,31.268]],[\"comment/51\",[]],[\"name/52\",[48,36.376]],[\"comment/52\",[]],[\"name/53\",[49,36.376]],[\"comment/53\",[]],[\"name/54\",[50,36.376]],[\"comment/54\",[]],[\"name/55\",[51,36.376]],[\"comment/55\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":5,\"name\":{\"5\":{},\"42\":{}},\"comment\":{}}],[\"allowtrailinginvalid\",{\"_index\":43,\"name\":{\"44\":{},\"50\":{}},\"comment\":{}}],[\"c\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"cc\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"ccc\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"cd\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"cm\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"d\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"dc\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"dcc\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"dccc\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"defaultoptions\",{\"_index\":41,\"name\":{\"41\":{}},\"comment\":{}}],[\"i\",{\"_index\":37,\"name\":{\"37\":{}},\"comment\":{}}],[\"ii\",{\"_index\":36,\"name\":{\"36\":{}},\"comment\":{}}],[\"iii\",{\"_index\":35,\"name\":{\"35\":{}},\"comment\":{}}],[\"iv\",{\"_index\":34,\"name\":{\"34\":{}},\"comment\":{}}],[\"ix\",{\"_index\":29,\"name\":{\"29\":{}},\"comment\":{}}],[\"l\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"lx\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"lxx\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"lxxx\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"m\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"mm\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"mmm\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"numericquantity\",{\"_index\":45,\"name\":{\"46\":{}},\"comment\":{}}],[\"numericquantityoptions\",{\"_index\":47,\"name\":{\"48\":{}},\"comment\":{}}],[\"numericregex\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"numericregexwithtrailinginvalid\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"parseromannumerals\",{\"_index\":46,\"name\":{\"47\":{}},\"comment\":{}}],[\"romannumeral\",{\"_index\":51,\"name\":{\"55\":{}},\"comment\":{}}],[\"romannumeralascii\",{\"_index\":49,\"name\":{\"53\":{}},\"comment\":{}}],[\"romannumeralregex\",{\"_index\":40,\"name\":{\"40\":{}},\"comment\":{}}],[\"romannumerals\",{\"_index\":44,\"name\":{\"45\":{},\"51\":{}},\"comment\":{}}],[\"romannumeralunicode\",{\"_index\":50,\"name\":{\"54\":{}},\"comment\":{}}],[\"romannumeralunicoderegex\",{\"_index\":39,\"name\":{\"39\":{}},\"comment\":{}}],[\"romannumeralunicodetoasciimap\",{\"_index\":38,\"name\":{\"38\":{}},\"comment\":{}}],[\"romannumeralvalues\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"round\",{\"_index\":42,\"name\":{\"43\":{},\"49\":{}},\"comment\":{}}],[\"v\",{\"_index\":33,\"name\":{\"33\":{}},\"comment\":{}}],[\"vi\",{\"_index\":32,\"name\":{\"32\":{}},\"comment\":{}}],[\"vii\",{\"_index\":31,\"name\":{\"31\":{}},\"comment\":{}}],[\"viii\",{\"_index\":30,\"name\":{\"30\":{}},\"comment\":{}}],[\"vulgarfraction\",{\"_index\":48,\"name\":{\"52\":{}},\"comment\":{}}],[\"vulgarfractionsregex\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"vulgarfractiontoasciimap\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"x\",{\"_index\":28,\"name\":{\"28\":{}},\"comment\":{}}],[\"xc\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"xi\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"xii\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"xl\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"xx\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"xxx\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WcWW/jyBHHvwv3VdGo2Rfbb4GDAAYyG2SxmRgQjIFiyTNEdDg6PF4Yftz33Pd93/d9Avko+0miJltWFd1FS93NlxV2WMef9StWk2zO3GXLxZtVdjK8yz5TzsfZCc972Xw0m2Qn2c1m+mq0/OhydLkuF/N3Fx9eXZbl89F11ss2y6k1GC3L0aenk9UzyrT/ej2bbu0vp6PVarLNk2X3vV0qJSVXD9levly/dz05NvZbD24gRS+7Hi0n83XbOexlsEEuHlT871+BCvovj9bQd9opKf8OlvIhllzMf8LF5KnFfPD+58LV8PRqPh+uRqRX84VwNTK9mi+Gq1Hp1XwpXI1Or+bL4WqK9Gq+Eq7GpFfz1YjhN0gv52sRcpIP4w/e/3qEnA7G8Tci5HQwj78ZIaeDgfytCDkdTORvR8jpYCR/J0JOBzP5uxFyUgxlcP8938wmy/Lyncmrya1HFTzcep9NhPxUuX797nJUTsv5q7P5zWhajp/I4vE4NDEuwIo6J5/ZoSmWi9lo/raVO5q+GE03W9PHCR4bpXhEIaI+9XDiUUz05fPnz49O26+dDk39xJURJiBh/oD06bKfBqQ/TZj/I6enp8crcF7pNARJSKkgREDC/AHpE/ZgQPrTlPlD+CftwDABCfMHpE+X/Twg/XnC/B87Pz8/XoHzSqchSEJKBSECEuYPSJ+wBwPSn6fMH8I/aQeGCUiY/+wsQEDllExBiICE+QPSp8t+FpD+LGH+F2chDeC80mkIkpBSQYiAhPkD0ifswYD0Zynzh/BP2oFhAhLmD0gflZ14z/HJeXm5GE9a92Zb7VO//fAnOOZFyONTIt/VfS9GTMuGbXuMp94gfj9OVcvebZyuH0TqovcN4nT9MFIXvYEQp+tHkbronYQ4XT+O1EVvKcTp+kmkLnpvIU7XTyN10ZsMcbp+FqmL3m2I0/XzSF30ZnCcrl/EzlV6WzhO2C9jhXU18X8VK6yrkf/rWGFdzfzfxArrauj/NlZYV1P/d7HCuhr7v48V1tXc/0OssK4G/x9jhXU1+f8Ue+fa1eT/c6ywrib/X2KFdTX5/xorrKvJ/7dYYV1N/r/HCutq8v8jVlhXk/+fscK6mvy+b8uPEtbV5Pd9aX6UsK4mv++r86PeDXQ1+f8bKyzZ5G9/M0h9aEWZhnxsdUiOo4KPJ1ejzXT98evqIzBPZGyQ4h2mJ+JTLy0bKolWWS42c993dXTC/s7lkLRPNOpoOl28efojvxYxRIQE2mB7HAh5XyHsGqZG7bW4rxw/sRnN1+X6vQc1V5t5/SXis4ZFe8/tA2/FrCbveM90H/uxUWv4XO4b+m0sq3nJlPP1ZHk1utyW02/ZmqilkQ8L/FZ7KxPiQ3r5QD1HdfNx8vztfHCdDmnoJwXlA6OZ3A/SF+hz2gdR9jpYPcMH2zuuERf2arUyNUI/Oh4c3a1NLfGdRXCGltC+mBe9LdPxdr07uctuJsuVretJlvd5394DXZWT6dj+dco609Z1MZtZeBfu2IvJ5XqxtBa1ybPtDcpw0BN538iLi95w51D9efUHldX2bmHIepz1jRLIjCGz7VPbMO/pviwMssqRFSesOLIShJVAVpKwkshKEVYKWWnCSiOrgrAqkJUhrAwu64AwY43yM8oO159RABgmwCgEDDNgFASGKTAKA8McGAWCYRKMQsEwC0bBYJgGo3AwzCOneOSYh31vMuSeqyZvXA+27MJnh3nYtwpD6bPDPOxD/lD57DAP+8ztv15zDMQ+Aw+1LyAGYh9Jh4XPDgOxT4hD47PDQOwD25D55k6OidgHqCFjHkOOkfBqROU+Q8yE29IzHzzeGFO29sxHj2Mq3Baf+fBxjIVXWHz8OMbCbfWZjwvHXLgtP/OB4RgMt/VnPjIck+HVpeIjwzEZUV0rPjICkxHV8PKREZiMqKaXj4zAZEQ1vnxkRGMNqeaXj4zAZEQ1wHxkBCYjqgnmIyMwGVGNMB8ZgcmIaob5yAhMRtj6cx8ZgclIW3/uIyMxGVmNMR8ZiclIW3/uIyMxGWnrz31kJCYjbf25j4xsLPC2/txHRmIy0taf+8hITEba+nMfGYnJSFt/7iMjMRlpqHErMRlFrS8Kg1HUeq8wF0Wt9wpjUdR6rzAVRa33CkNR1HqvGvdd5I0XRqKo9V5hIopa7xUGoqj1XmEemuKhMQ9N8dCYh6Z4aMxDUzw05qEpHhrz0BQPjXloiodu3AmTt8KYh6Z4aMxDUzw05lFQPArMo6B4FJhHQfEoMI+C4lFgHgXFo8A8CopHgXkUFI8C8ygoHkXj2YR8OME8CopHgXkYiofBPAzFw2Aeprof9i1hBgMxtu7Ct4QZTMTYwgvfEmYwEkPeEhvMxNjSC97jul+IHFtiKsYWXwivJeZibPmF9Fo2nhstAOFb7kzz0dEiEL71rj4ETS0F4Vvx6kPQNCfPvj4GbTl5/vUxaCvICtTHoK0FInzrbn0Imloi0tdQ9SFoapFIX0vVh6CpZSJ9TVUfurio3sLcTJbryfisfhszHGZZ7y576V7OPLzrucvy7X/uexmvf0T9I+sfVf/o+qeof0z9wwbul7lfF4i5SMyFYi4Wc8GYi8ZcOObi5S6e2v26uMrFVS6ucnHVTqOLq1xc5eIqF1e7eNrF0y6edvG0i6ddPL07aRdPu3jaxStcvMLFK1y8wsUrXLzCxStcvGJXRRevcPGMi2eqePf7d2L2/yzc3T7Lnh7b03MicpdM7oJKIlj1hnft3vCWuze8+9BC7GObHakBJ6JdIlXF3pVrygO7aOCiSBfso4APdZqX6KS2D797F0G5zJDLAFwhhnDBSUDlOFWwMT4VDlxy0gX7gEuXUy0zbtYMdAwfUE71ftBit0cCmgLkNFT9SujBQS9IqhdK7AJ6QVK9UDZ8QC9IqhfKG+QCekGS53KLXEAvCKoXpmi8ArCCAjtFSXJQY0Fxnd5iH4BVUFi3PtgJnA2nzgZdCwZcCgXlgDwA/ZyiP8MugH5O0XebjJ992IYELQo6wVBn1fD3dTpQbm8+WuMs64190CjgHA7xfVOuX7fNYhCOaqJqb7TaHps/bI+BCBqeDtUh0B16yxx6U+Sh96je7AIhBjAExRWGeFRUAZrcUHOVrgC43M3ujmNAXfcwzGa3tQbOBi68A6qxPUEenxSoi6HYegKtF1WJZ/ZvsoG+A1eoPITTjfv3f/YhwOWT09WpdqvBWYCGN7vbuwF1OngMg+aWFNUbPOxBNkkmaSwQoIUldUneNFcVgFlSF039TzFdPewdg6oY2CXUqoT9V486BPRtTtYHxfD3Bmg06lTw8gDUC6qXbvHdBXDhpAsqcQ7mrKAupFuMJQfDTFCj5Bavw6DLBFXFxvIIrgRBwWsuqQCW8F492wey6/J6sh30W6Phxf39/wHO9tDRWVgAAA=="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 18b4f8f..07a385b 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -11,6 +11,7 @@ --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); @@ -32,7 +33,6 @@ --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -51,6 +51,7 @@ --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); @@ -72,7 +73,6 @@ --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); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -93,6 +93,7 @@ --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); @@ -134,6 +135,7 @@ --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); @@ -182,6 +184,7 @@ body { --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); @@ -221,6 +224,7 @@ body { --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); @@ -468,13 +472,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -485,6 +488,19 @@ blockquote { .tsd-typography ol { margin: 1em 0; } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} .tsd-breadcrumb { margin: 0; @@ -900,8 +916,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -909,12 +926,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#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: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -970,6 +990,11 @@ a.tsd-index-link { 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; @@ -1070,7 +1095,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1122,7 +1149,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/docs/functions/numericQuantity.html b/docs/functions/numericQuantity.html index bc03b55..b78be3a 100644 --- a/docs/functions/numericQuantity.html +++ b/docs/functions/numericQuantity.html @@ -1,72 +1,3 @@ -numericQuantity | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Function numericQuantity

-
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/parseRomanNumerals.html b/docs/functions/parseRomanNumerals.html index a600787..2ce5fad 100644 --- a/docs/functions/parseRomanNumerals.html +++ b/docs/functions/parseRomanNumerals.html @@ -1,72 +1,5 @@ -parseRomanNumerals | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Function parseRomanNumerals

-
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 9291d7b..9b327aa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,18 +1,4 @@ -numeric-quantity - v2.0.0
-
- -
-
-
-
-

numeric-quantity - v2.0.0

-

npm +numeric-quantity - v2.0.0

numeric-quantity - v2.0.0

npm workflow status codecov.io downloads @@ -39,54 +25,4 @@

numeric-quantity - v2.0.0

As UMD (all exports are properties of the global object NumericQuantity):

<script src="https://unpkg.com/numeric-quantity"></script>
<script>
  console.log(NumericQuantity.numericQuantity('xii', { romanNumerals: true })); // 12
</script>
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/NumericQuantityOptions.html b/docs/interfaces/NumericQuantityOptions.html index 4199ab8..6fb11ad 100644 --- a/docs/interfaces/NumericQuantityOptions.html +++ b/docs/interfaces/NumericQuantityOptions.html @@ -1,114 +1,14 @@ -NumericQuantityOptions | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Interface NumericQuantityOptions

-
-

Hierarchy

-
    -
  • NumericQuantityOptions
-
-
-
- -
-
-

Properties

-
allowTrailingInvalid? +NumericQuantityOptions | numeric-quantity - v2.0.0

Interface NumericQuantityOptions

interface NumericQuantityOptions {
    allowTrailingInvalid?: boolean;
    romanNumerals?: boolean;
    round?: number | false;
}

Properties

allowTrailingInvalid? romanNumerals? round? -
-
-

Properties

-
-

Optional allowTrailingInvalid

-
allowTrailingInvalid?: boolean
-

Allow and ignore trailing invalid characters à la parseFloat.

-
-
-

Default

false
+

Properties

Optional allowTrailingInvalid

allowTrailingInvalid?: boolean

Allow and ignore trailing invalid characters à la parseFloat.

+

Default

false
-
-
-

Optional romanNumerals

-
romanNumerals?: boolean
-

Attempt to parse Roman numerals if Arabic numeral parsing fails.

-
-
-

Default

false
+

Optional romanNumerals

romanNumerals?: boolean

Attempt to parse Roman numerals if Arabic numeral parsing fails.

+

Default

false
-
-
-

Optional round

-
round?: number | false
-

Round the result to this many decimal places. Defaults to 3; must +

Optional round

round?: number | false

Round the result to this many decimal places. Defaults to 3; must be greater than or equal to zero.

-
-
-

Default

3
+

Default

3
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index e88cb95..64302a9 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,34 +1,9 @@ -numeric-quantity - v2.0.0
-
- -
-
-
-
-

numeric-quantity - v2.0.0

-
-
-

Index

-
-

Interfaces

-
NumericQuantityOptions -
-
-

Type Aliases

-
RomanNumeral -RomanNumeralAscii -RomanNumeralUnicode -VulgarFraction -
-
-

Variables

-
defaultOptions +numeric-quantity - v2.0.0

numeric-quantity - v2.0.0

Index

Interfaces

NumericQuantityOptions +

Type Aliases

RomanNumeral +RomanNumeralAscii +RomanNumeralUnicode +VulgarFraction +

Variables

defaultOptions numericRegex numericRegexWithTrailingInvalid romanNumeralRegex @@ -37,46 +12,6 @@

Variables

romanNumeralValues vulgarFractionToAsciiMap vulgarFractionsRegex -
-
-

Functions

-
numericQuantity +

Functions

numericQuantity parseRomanNumerals -
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RomanNumeral.html b/docs/types/RomanNumeral.html index 96d608c..1f650ec 100644 --- a/docs/types/RomanNumeral.html +++ b/docs/types/RomanNumeral.html @@ -1,60 +1,2 @@ -RomanNumeral | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Type alias RomanNumeral

-
RomanNumeral: RomanNumeralAscii | RomanNumeralUnicode
-

Union of ASCII and Unicode Roman numeral characters/code points.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +RomanNumeral | numeric-quantity - v2.0.0

Type alias RomanNumeral

RomanNumeral: RomanNumeralAscii | RomanNumeralUnicode

Union of ASCII and Unicode Roman numeral characters/code points.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RomanNumeralAscii.html b/docs/types/RomanNumeralAscii.html index 7d6c926..012ebc2 100644 --- a/docs/types/RomanNumeralAscii.html +++ b/docs/types/RomanNumeralAscii.html @@ -1,60 +1,2 @@ -RomanNumeralAscii | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Type alias RomanNumeralAscii

-
RomanNumeralAscii: "I" | "V" | "X" | "L" | "C" | "D" | "M"
-

Allowable Roman numeral characters (ASCII, uppercase only).

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +RomanNumeralAscii | numeric-quantity - v2.0.0

Type alias RomanNumeralAscii

RomanNumeralAscii: "I" | "V" | "X" | "L" | "C" | "D" | "M"

Allowable Roman numeral characters (ASCII, uppercase only).

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/RomanNumeralUnicode.html b/docs/types/RomanNumeralUnicode.html index 5c5bea7..ec19b26 100644 --- a/docs/types/RomanNumeralUnicode.html +++ b/docs/types/RomanNumeralUnicode.html @@ -1,61 +1,3 @@ -RomanNumeralUnicode | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Type alias RomanNumeralUnicode

-
RomanNumeralUnicode: "Ⅰ" | "Ⅱ" | "Ⅲ" | "Ⅳ" | "Ⅴ" | "Ⅵ" | "Ⅶ" | "Ⅷ" | "Ⅸ" | "Ⅹ" | "Ⅺ" | "Ⅻ" | "Ⅼ" | "Ⅽ" | "Ⅾ" | "Ⅿ" | "ⅰ" | "ⅱ" | "ⅲ" | "ⅳ" | "ⅴ" | "ⅵ" | "ⅶ" | "ⅷ" | "ⅸ" | "ⅹ" | "ⅺ" | "ⅻ" | "ⅼ" | "ⅽ" | "ⅾ" | "ⅿ"
-

Unicode Roman numeral code points (uppercase and lowercase, +RomanNumeralUnicode | numeric-quantity - v2.0.0

Type alias RomanNumeralUnicode

RomanNumeralUnicode: "Ⅰ" | "Ⅱ" | "Ⅲ" | "Ⅳ" | "Ⅴ" | "Ⅵ" | "Ⅶ" | "Ⅷ" | "Ⅸ" | "Ⅹ" | "Ⅺ" | "Ⅻ" | "Ⅼ" | "Ⅽ" | "Ⅾ" | "Ⅿ" | "ⅰ" | "ⅱ" | "ⅲ" | "ⅳ" | "ⅴ" | "ⅵ" | "ⅶ" | "ⅷ" | "ⅸ" | "ⅹ" | "ⅺ" | "ⅻ" | "ⅼ" | "ⅽ" | "ⅾ" | "ⅿ"

Unicode Roman numeral code points (uppercase and lowercase, representing 1-12, 50, 100, 500, and 1000).

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/VulgarFraction.html b/docs/types/VulgarFraction.html index c8112c0..1cb6cec 100644 --- a/docs/types/VulgarFraction.html +++ b/docs/types/VulgarFraction.html @@ -1,60 +1,2 @@ -VulgarFraction | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Type alias VulgarFraction

-
VulgarFraction: "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞" | "⅟"
-

Unicode vulgar fraction code points.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +VulgarFraction | numeric-quantity - v2.0.0

Type alias VulgarFraction

VulgarFraction: "¼" | "½" | "¾" | "⅐" | "⅑" | "⅒" | "⅓" | "⅔" | "⅕" | "⅖" | "⅗" | "⅘" | "⅙" | "⅚" | "⅛" | "⅜" | "⅝" | "⅞" | "⅟"

Unicode vulgar fraction code points.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/defaultOptions.html b/docs/variables/defaultOptions.html index 0395ce0..4701914 100644 --- a/docs/variables/defaultOptions.html +++ b/docs/variables/defaultOptions.html @@ -1,66 +1,2 @@ -defaultOptions | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable defaultOptionsConst

-
defaultOptions: {
    allowTrailingInvalid: false;
    romanNumerals: false;
    round: number;
} = ...
-
-

Type declaration

-
    -
  • -
    allowTrailingInvalid: false
    • -
  • -
    romanNumerals: false
    • -
  • -
    round: number
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +defaultOptions | numeric-quantity - v2.0.0

Variable defaultOptionsConst

defaultOptions: {
    allowTrailingInvalid: false;
    romanNumerals: false;
    round: number;
} = ...

Default options for numericQuantity.

+

Type declaration

  • allowTrailingInvalid: false
  • romanNumerals: false
  • round: number

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/numericRegex.html b/docs/variables/numericRegex.html index 6eb87b2..3f3055c 100644 --- a/docs/variables/numericRegex.html +++ b/docs/variables/numericRegex.html @@ -1,66 +1,35 @@ -numericRegex | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable numericRegexConst

-
numericRegex: RegExp = ...
-

Captures the individual elements of a numeric string.

+numericRegex | numeric-quantity - v2.0.0

Variable numericRegexConst

numericRegex: RegExp = ...

Captures the individual elements of a numeric string.

Capture groups:

-
+=====+====================+========================+
|  #  |    Description     |        Example         |
+=====+====================+========================+
|  0  |  entire string     |  "2 1/3" from "2 1/3"  |
+-----+--------------------+------------------------+
|  1  |  "negative" dash   |  "-" from "-2 1/3"     |
+-----+--------------------+------------------------+
|  2  |  the whole number  |  "2" from "2 1/3"      |
|     |  - OR -            |                        |
|     |  the numerator     |  "1" from "1/3"        |
|     +                    +                        |
| (This may include comma/underscore separators)    |
+-----+--------------------+------------------------+
|  3  |  entire fraction   |  " 1/3" from "2 1/3"   |
|     |  - OR -            |                        |
|     |  decimal portion   |  ".33" from "2.33"     |
|     |  - OR -            |                        |
|     |  denominator       |  "/3" from "1/3"       |
+=====+====================+========================+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#DescriptionExample(s)
0entire string"2 1/3" from "2 1/3"
1"negative" dash"-" from "-2 1/3"
2whole number or numerator"2" from "2 1/3"; "1" from "1/3"
3entire fraction, decimal portion, or denominator" 1/3" from "2 1/3"; ".33" from "2.33"; "/3" from "1/3"

+
Capture group 2 may include comma/underscore separators.

+

Example

numericRegex.exec("1")     // [ "1",     "1", null,   null ]
numericRegex.exec("1.23")  // [ "1.23",  "1", ".23",  null ]
numericRegex.exec("1 2/3") // [ "1 2/3", "1", " 2/3", " 2" ]
numericRegex.exec("2/3")   // [ "2/3",   "2", "/3",   null ]
numericRegex.exec("2 / 3") // [ "2 / 3", "2", "/ 3",  null ]
-
-
-

Example

numericRegex.exec("1")     // [ "1",     "1", null,   null ]
    numericRegex.exec("1.23")  // [ "1.23",  "1", ".23",  null ]
    numericRegex.exec("1 2/3") // [ "1 2/3", "1", " 2/3", " 2" ]
    numericRegex.exec("2/3")   // [ "2/3",   "2", "/3",   null ]
    numericRegex.exec("2 / 3") // [ "2 / 3", "2", "/ 3",  null ]
-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/numericRegexWithTrailingInvalid.html b/docs/variables/numericRegexWithTrailingInvalid.html index f8ed473..43b22a4 100644 --- a/docs/variables/numericRegexWithTrailingInvalid.html +++ b/docs/variables/numericRegexWithTrailingInvalid.html @@ -1,60 +1,2 @@ -numericRegexWithTrailingInvalid | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable numericRegexWithTrailingInvalidConst

-
numericRegexWithTrailingInvalid: RegExp = ...
-

Same as numericRegex, but allows/ignores trailing invalid characters.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +numericRegexWithTrailingInvalid | numeric-quantity - v2.0.0

Variable numericRegexWithTrailingInvalidConst

numericRegexWithTrailingInvalid: RegExp = ...

Same as numericRegex, but allows (and ignores) trailing invalid characters.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/romanNumeralRegex.html b/docs/variables/romanNumeralRegex.html index 2e2b76e..2c1aa82 100644 --- a/docs/variables/romanNumeralRegex.html +++ b/docs/variables/romanNumeralRegex.html @@ -1,66 +1,39 @@ -romanNumeralRegex | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable romanNumeralRegexConst

-
romanNumeralRegex: RegExp = ...
-

Captures a valid Roman numeral sequence.

+romanNumeralRegex | numeric-quantity - v2.0.0

Variable romanNumeralRegexConst

romanNumeralRegex: RegExp = ...

Captures a valid Roman numeral sequence.

Capture groups:

-
+=====+=================+==========================+
|  #  |   Description   |         Example          |
+=====+=================+==========================+
|  0  |  Entire string  |  "MCCXIV" from "MCCXIV"  |
+-----+-----------------+--------------------------+
|  1  |  Thousands      |  "M" from "MCCXIV"       |
+-----+-----------------+--------------------------+
|  2  |  Hundreds       |  "CC" from "MCCXIV"      |
+-----+-----------------+--------------------------+
|  3  |  Tens           |  "X" from "MCCXIV"       |
+-----+-----------------+--------------------------+
|  4  |  Ones           |  "IV" from "MCCXIV"      |
+=====+=================+==========================+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
#DescriptionExample
0Entire string"MCCXIV" from "MCCXIV"
1Thousands"M" from "MCCXIV"
2Hundreds"CC" from "MCCXIV"
3Tens"X" from "MCCXIV"
4Ones"IV" from "MCCXIV"

+

Example

romanNumeralRegex.exec("M")      // [      "M", "M",   "",  "",   "" ]
romanNumeralRegex.exec("XII")    // [    "XII",  "",   "", "X", "II" ]
romanNumeralRegex.exec("MCCXIV") // [ "MCCXIV", "M", "CC", "X", "IV" ]
-
-
-

Example

romanNumeralRegex.exec("M")      // [      "M", "M",   "",  "",   "" ]
    romanNumeralRegex.exec("XII")    // [    "XII",  "",   "", "X", "II" ]
    romanNumeralRegex.exec("MCCXIV") // [ "MCCXIV", "M", "CC", "X", "IV" ]
-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/romanNumeralUnicodeRegex.html b/docs/variables/romanNumeralUnicodeRegex.html index e059466..c7f4877 100644 --- a/docs/variables/romanNumeralUnicodeRegex.html +++ b/docs/variables/romanNumeralUnicodeRegex.html @@ -1,60 +1,2 @@ -romanNumeralUnicodeRegex | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable romanNumeralUnicodeRegexConst

-
romanNumeralUnicodeRegex: RegExp = ...
-

Captures all Unicode Roman numeral code points.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +romanNumeralUnicodeRegex | numeric-quantity - v2.0.0

Variable romanNumeralUnicodeRegexConst

romanNumeralUnicodeRegex: RegExp = ...

Captures all Unicode Roman numeral code points.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/romanNumeralUnicodeToAsciiMap.html b/docs/variables/romanNumeralUnicodeToAsciiMap.html index f65d10e..d6b48a2 100644 --- a/docs/variables/romanNumeralUnicodeToAsciiMap.html +++ b/docs/variables/romanNumeralUnicodeToAsciiMap.html @@ -1,60 +1,2 @@ -romanNumeralUnicodeToAsciiMap | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable romanNumeralUnicodeToAsciiMapConst

-
romanNumeralUnicodeToAsciiMap: Record<RomanNumeralUnicode, keyof typeof romanNumeralValues> = ...
-

Map of Unicode Roman numeral code points to their ASCII equivalents.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +romanNumeralUnicodeToAsciiMap | numeric-quantity - v2.0.0

Variable romanNumeralUnicodeToAsciiMapConst

romanNumeralUnicodeToAsciiMap: {
    Ⅰ: "I";
    Ⅱ: "II";
    Ⅲ: "III";
    Ⅳ: "IV";
    Ⅴ: "V";
    Ⅵ: "VI";
    Ⅶ: "VII";
    Ⅷ: "VIII";
    Ⅸ: "IX";
    Ⅹ: "X";
    Ⅺ: "XI";
    Ⅻ: "XII";
    Ⅼ: "L";
    Ⅽ: "C";
    Ⅾ: "D";
    Ⅿ: "M";
    ⅰ: "I";
    ⅱ: "II";
    ⅲ: "III";
    ⅳ: "IV";
    ⅴ: "V";
    ⅵ: "VI";
    ⅶ: "VII";
    ⅷ: "VIII";
    ⅸ: "IX";
    ⅹ: "X";
    ⅺ: "XI";
    ⅻ: "XII";
    ⅼ: "L";
    ⅽ: "C";
    ⅾ: "D";
    ⅿ: "M";
} = ...

Map of Unicode Roman numeral code points to their ASCII equivalents.

+

Type declaration

  • Readonly Ⅰ: "I"
  • Readonly Ⅱ: "II"
  • Readonly Ⅲ: "III"
  • Readonly Ⅳ: "IV"
  • Readonly Ⅴ: "V"
  • Readonly Ⅵ: "VI"
  • Readonly Ⅶ: "VII"
  • Readonly Ⅷ: "VIII"
  • Readonly Ⅸ: "IX"
  • Readonly Ⅹ: "X"
  • Readonly Ⅺ: "XI"
  • Readonly Ⅻ: "XII"
  • Readonly Ⅼ: "L"
  • Readonly Ⅽ: "C"
  • Readonly Ⅾ: "D"
  • Readonly Ⅿ: "M"
  • Readonly ⅰ: "I"
  • Readonly ⅱ: "II"
  • Readonly ⅲ: "III"
  • Readonly ⅳ: "IV"
  • Readonly ⅴ: "V"
  • Readonly ⅵ: "VI"
  • Readonly ⅶ: "VII"
  • Readonly ⅷ: "VIII"
  • Readonly ⅸ: "IX"
  • Readonly ⅹ: "X"
  • Readonly ⅺ: "XI"
  • Readonly ⅻ: "XII"
  • Readonly ⅼ: "L"
  • Readonly ⅽ: "C"
  • Readonly ⅾ: "D"
  • Readonly ⅿ: "M"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/romanNumeralValues.html b/docs/variables/romanNumeralValues.html index 5fc5e2a..91352be 100644 --- a/docs/variables/romanNumeralValues.html +++ b/docs/variables/romanNumeralValues.html @@ -1,124 +1,2 @@ -romanNumeralValues | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable romanNumeralValuesConst

-
romanNumeralValues: {
    C: number;
    CC: number;
    CCC: number;
    CD: number;
    CM: number;
    D: number;
    DC: number;
    DCC: number;
    DCCC: number;
    I: number;
    II: number;
    III: number;
    IV: number;
    IX: number;
    L: number;
    LX: number;
    LXX: number;
    LXXX: number;
    M: number;
    MM: number;
    MMM: number;
    V: number;
    VI: number;
    VII: number;
    VIII: number;
    X: number;
    XC: number;
    XI: number;
    XII: number;
    XL: number;
    XX: number;
    XXX: number;
} = ...
-
-

Type declaration

-
    -
  • -
    C: number
    • -
  • -
    CC: number
    • -
  • -
    CCC: number
    • -
  • -
    CD: number
    • -
  • -
    CM: number
    • -
  • -
    D: number
    • -
  • -
    DC: number
    • -
  • -
    DCC: number
    • -
  • -
    DCCC: number
    • -
  • -
    I: number
    • -
  • -
    II: number
    • -
  • -
    III: number
    • -
  • -
    IV: number
    • -
  • -
    IX: number
    • -
  • -
    L: number
    • -
  • -
    LX: number
    • -
  • -
    LXX: number
    • -
  • -
    LXXX: number
    • -
  • -
    M: number
    • -
  • -
    MM: number
    • -
  • -
    MMM: number
    • -
  • -
    V: number
    • -
  • -
    VI: number
    • -
  • -
    VII: number
    • -
  • -
    VIII: number
    • -
  • -
    X: number
    • -
  • -
    XC: number
    • -
  • -
    XI: number
    • -
  • -
    XII: number
    • -
  • -
    XL: number
    • -
  • -
    XX: number
    • -
  • -
    XXX: number
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +romanNumeralValues | numeric-quantity - v2.0.0

Variable romanNumeralValuesConst

romanNumeralValues: {
    C: 100;
    CC: 200;
    CCC: 300;
    CD: 400;
    CM: 900;
    D: 500;
    DC: 600;
    DCC: 700;
    DCCC: 800;
    I: 1;
    II: 2;
    III: 3;
    IV: 4;
    IX: 9;
    L: 50;
    LX: 60;
    LXX: 70;
    LXXX: 80;
    M: 1000;
    MM: 2000;
    MMM: 3000;
    V: 5;
    VI: 6;
    VII: 7;
    VIII: 8;
    X: 10;
    XC: 90;
    XI: 11;
    XII: 12;
    XL: 40;
    XX: 20;
    XXX: 30;
} = ...

Map of Roman numeral sequences to their decimal equivalents.

+

Type declaration

  • Readonly C: 100
  • Readonly CC: 200
  • Readonly CCC: 300
  • Readonly CD: 400
  • Readonly CM: 900
  • Readonly D: 500
  • Readonly DC: 600
  • Readonly DCC: 700
  • Readonly DCCC: 800
  • Readonly I: 1
  • Readonly II: 2
  • Readonly III: 3
  • Readonly IV: 4
  • Readonly IX: 9
  • Readonly L: 50
  • Readonly LX: 60
  • Readonly LXX: 70
  • Readonly LXXX: 80
  • Readonly M: 1000
  • Readonly MM: 2000
  • Readonly MMM: 3000
  • Readonly V: 5
  • Readonly VI: 6
  • Readonly VII: 7
  • Readonly VIII: 8
  • Readonly X: 10
  • Readonly XC: 90
  • Readonly XI: 11
  • Readonly XII: 12
  • Readonly XL: 40
  • Readonly XX: 20
  • Readonly XXX: 30

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/vulgarFractionToAsciiMap.html b/docs/variables/vulgarFractionToAsciiMap.html index 089992d..d63732f 100644 --- a/docs/variables/vulgarFractionToAsciiMap.html +++ b/docs/variables/vulgarFractionToAsciiMap.html @@ -1,60 +1,2 @@ -vulgarFractionToAsciiMap | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable vulgarFractionToAsciiMapConst

-
vulgarFractionToAsciiMap: Record<VulgarFraction, string> = ...
-

Map of Unicode fraction code points to their ASCII equivalents.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +vulgarFractionToAsciiMap | numeric-quantity - v2.0.0

Variable vulgarFractionToAsciiMapConst

vulgarFractionToAsciiMap: {
    ¼: "1/4";
    ½: "1/2";
    ¾: "3/4";
    ⅐: "1/7";
    ⅑: "1/9";
    ⅒: "1/10";
    ⅓: "1/3";
    ⅔: "2/3";
    ⅕: "1/5";
    ⅖: "2/5";
    ⅗: "3/5";
    ⅘: "4/5";
    ⅙: "1/6";
    ⅚: "5/6";
    ⅛: "1/8";
    ⅜: "3/8";
    ⅝: "5/8";
    ⅞: "7/8";
    ⅟: "1/";
} = ...

Map of Unicode fraction code points to their ASCII equivalents.

+

Type declaration

  • Readonly ¼: "1/4"
  • Readonly ½: "1/2"
  • Readonly ¾: "3/4"
  • Readonly ⅐: "1/7"
  • Readonly ⅑: "1/9"
  • Readonly ⅒: "1/10"
  • Readonly ⅓: "1/3"
  • Readonly ⅔: "2/3"
  • Readonly ⅕: "1/5"
  • Readonly ⅖: "2/5"
  • Readonly ⅗: "3/5"
  • Readonly ⅘: "4/5"
  • Readonly ⅙: "1/6"
  • Readonly ⅚: "5/6"
  • Readonly ⅛: "1/8"
  • Readonly ⅜: "3/8"
  • Readonly ⅝: "5/8"
  • Readonly ⅞: "7/8"
  • Readonly ⅟: "1/"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/variables/vulgarFractionsRegex.html b/docs/variables/vulgarFractionsRegex.html index 7d301c8..6d9cba3 100644 --- a/docs/variables/vulgarFractionsRegex.html +++ b/docs/variables/vulgarFractionsRegex.html @@ -1,60 +1,2 @@ -vulgarFractionsRegex | numeric-quantity - v2.0.0
-
- -
-
-
-
- -

Variable vulgarFractionsRegexConst

-
vulgarFractionsRegex: RegExp = ...
-

Captures any Unicode vulgar fractions.

-
-
-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +vulgarFractionsRegex | numeric-quantity - v2.0.0

Variable vulgarFractionsRegexConst

vulgarFractionsRegex: RegExp = ...

Captures any Unicode vulgar fractions.

+

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file