diff --git a/assets/highlight.css b/assets/highlight.css new file mode 100644 index 0000000..85cd183 --- /dev/null +++ b/assets/highlight.css @@ -0,0 +1,78 @@ +:root { + --light-hl-0: #0000FF; + --dark-hl-0: #569CD6; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #0070C1; + --dark-hl-2: #4FC1FF; + --light-hl-3: #795E26; + --dark-hl-3: #DCDCAA; + --light-hl-4: #A31515; + --dark-hl-4: #CE9178; + --light-hl-5: #008000; + --dark-hl-5: #6A9955; + --light-hl-6: #001080; + --dark-hl-6: #9CDCFE; + --light-hl-7: #098658; + --dark-hl-7: #B5CEA8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js new file mode 100644 index 0000000..4c8fa61 --- /dev/null +++ b/assets/main.js @@ -0,0 +1,58 @@ +"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)})});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/assets/search.js b/assets/search.js new file mode 100644 index 0000000..b163025 --- /dev/null +++ b/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"rows\":[{\"kind\":64,\"name\":\"fromCharCode\",\"url\":\"functions/fromCharCode.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"fromCodePoint\",\"url\":\"functions/fromCodePoint.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"concat\",\"url\":\"functions/concat.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"repeat\",\"url\":\"functions/repeat.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"valueOf\",\"url\":\"functions/valueOf.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"length\",\"url\":\"functions/length.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"charAt\",\"url\":\"functions/charAt.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"charCodeAt\",\"url\":\"functions/charCodeAt.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"codePointAt\",\"url\":\"functions/codePointAt.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"localeCompare\",\"url\":\"functions/localeCompare.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"includes\",\"url\":\"functions/includes.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"startsWith\",\"url\":\"functions/startsWith.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"endsWith\",\"url\":\"functions/endsWith.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"indexOf\",\"url\":\"functions/indexOf.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"lastIndexOf\",\"url\":\"functions/lastIndexOf.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"search\",\"url\":\"functions/search.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"match\",\"url\":\"functions/match.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"matchAll\",\"url\":\"functions/matchAll.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toString\",\"url\":\"functions/toString.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"slice\",\"url\":\"functions/slice.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"substring\",\"url\":\"functions/substring.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"split\",\"url\":\"functions/split.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"trimStart\",\"url\":\"functions/trimStart.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"trimEnd\",\"url\":\"functions/trimEnd.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"trim\",\"url\":\"functions/trim.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"padStart\",\"url\":\"functions/padStart.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"padEnd\",\"url\":\"functions/padEnd.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toUpperCase\",\"url\":\"functions/toUpperCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toLocaleUpperCase\",\"url\":\"functions/toLocaleUpperCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toLowerCase\",\"url\":\"functions/toLowerCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toLocaleLowerCase\",\"url\":\"functions/toLocaleLowerCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"replace\",\"url\":\"functions/replace.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"normalize\",\"url\":\"functions/normalize.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"of\",\"url\":\"functions/of.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"from\",\"url\":\"functions/from.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"splice\",\"url\":\"functions/splice.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"reverse\",\"url\":\"functions/reverse.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"sort\",\"url\":\"functions/sort.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"filter\",\"url\":\"functions/filter.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"spaces\",\"url\":\"functions/spaces.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"is\",\"url\":\"functions/is.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"isEmpty\",\"url\":\"functions/isEmpty.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"isCharacter\",\"url\":\"functions/isCharacter.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"index\",\"url\":\"functions/index.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"indexRange\",\"url\":\"functions/indexRange.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"codePointRange\",\"url\":\"functions/codePointRange.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"compare\",\"url\":\"functions/compare.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"isEqual\",\"url\":\"functions/isEqual.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"get\",\"url\":\"functions/get.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"getAll\",\"url\":\"functions/getAll.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"set\",\"url\":\"functions/set.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"begin\",\"url\":\"functions/begin.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"middle\",\"url\":\"functions/middle.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"end\",\"url\":\"functions/end.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"longestCommonInfix\",\"url\":\"functions/longestCommonInfix.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"longestCommonPrefix\",\"url\":\"functions/longestCommonPrefix.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"longestCommonSuffix\",\"url\":\"functions/longestCommonSuffix.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"longestUncommonInfixes\",\"url\":\"functions/longestUncommonInfixes.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toBaseline\",\"url\":\"functions/toBaseline.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toSuperscript\",\"url\":\"functions/toSuperscript.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toSubscript\",\"url\":\"functions/toSubscript.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toKebabCase\",\"url\":\"functions/toKebabCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toSnakeCase\",\"url\":\"functions/toSnakeCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toCamelCase\",\"url\":\"functions/toCamelCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"toPascalCase\",\"url\":\"functions/toPascalCase.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"ngrams\",\"url\":\"functions/ngrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"uniqueNgrams\",\"url\":\"functions/uniqueNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countNgrams\",\"url\":\"functions/countNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countUniqueNgrams\",\"url\":\"functions/countUniqueNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countEachNgram\",\"url\":\"functions/countEachNgram.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"matchingNgrams\",\"url\":\"functions/matchingNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"uniqueMatchingNgrams\",\"url\":\"functions/uniqueMatchingNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countMatchingNgrams\",\"url\":\"functions/countMatchingNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countEachMatchingNgram\",\"url\":\"functions/countEachMatchingNgram.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"countUniqueMatchingNgrams\",\"url\":\"functions/countUniqueMatchingNgrams.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"euclideanDistance\",\"url\":\"functions/euclideanDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"hammingDistance\",\"url\":\"functions/hammingDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaccardIndex\",\"url\":\"functions/jaccardIndex.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaccardDistance\",\"url\":\"functions/jaccardDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"sorensenDiceIndex\",\"url\":\"functions/sorensenDiceIndex.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"sorensenDiceDistance\",\"url\":\"functions/sorensenDiceDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"tverskyIndex\",\"url\":\"functions/tverskyIndex.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"tverskyDistance\",\"url\":\"functions/tverskyDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaroSimilarity\",\"url\":\"functions/jaroSimilarity.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaroDistance\",\"url\":\"functions/jaroDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaroWinklerSimilarity\",\"url\":\"functions/jaroWinklerSimilarity.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"jaroWinklerDistance\",\"url\":\"functions/jaroWinklerDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"levenshteinDistance\",\"url\":\"functions/levenshteinDistance.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"damerauLevenshteinDistance\",\"url\":\"functions/damerauLevenshteinDistance.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"DIGITS\",\"url\":\"variables/DIGITS.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"OCT_DIGITS\",\"url\":\"variables/OCT_DIGITS.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"HEX_DIGITS\",\"url\":\"variables/HEX_DIGITS.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"UPPERCASE\",\"url\":\"variables/UPPERCASE.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"LOWERCASE\",\"url\":\"variables/LOWERCASE.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"LETTERS\",\"url\":\"variables/LETTERS.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"PUNCTUATION\",\"url\":\"variables/PUNCTUATION.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"WHITESPACE\",\"url\":\"variables/WHITESPACE.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"PRINTABLE\",\"url\":\"variables/PRINTABLE.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"MIN_CODE_POINT\",\"url\":\"variables/MIN_CODE_POINT.html\",\"classes\":\"\"},{\"kind\":32,\"name\":\"MAX_CODE_POINT\",\"url\":\"variables/MAX_CODE_POINT.html\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"size\",\"url\":\"modules.html#size\",\"classes\":\"\"},{\"kind\":4194304,\"name\":\"ReplaceFunction\",\"url\":\"types/ReplaceFunction.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/ReplaceFunction.html#__type\",\"classes\":\"\",\"parent\":\"ReplaceFunction\"},{\"kind\":4194304,\"name\":\"MapFunction\",\"url\":\"types/MapFunction.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/MapFunction.html#__type\",\"classes\":\"\",\"parent\":\"MapFunction\"},{\"kind\":4194304,\"name\":\"CompareFunction\",\"url\":\"types/CompareFunction.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/CompareFunction.html#__type\",\"classes\":\"\",\"parent\":\"CompareFunction\"},{\"kind\":4194304,\"name\":\"TestFunction\",\"url\":\"types/TestFunction.html\",\"classes\":\"\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/TestFunction.html#__type\",\"classes\":\"\",\"parent\":\"TestFunction\"},{\"kind\":8388608,\"name\":\"isPrefix\",\"url\":\"modules.html#isPrefix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"isSuffix\",\"url\":\"modules.html#isSuffix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"isInfix\",\"url\":\"modules.html#isInfix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"at\",\"url\":\"modules.html#at\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"prefix\",\"url\":\"modules.html#prefix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"left\",\"url\":\"modules.html#left\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"infix\",\"url\":\"modules.html#infix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"suffix\",\"url\":\"modules.html#suffix\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"right\",\"url\":\"modules.html#right\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,43.737]],[\"comment/0\",[]],[\"name/1\",[1,43.737]],[\"comment/1\",[]],[\"name/2\",[2,43.737]],[\"comment/2\",[]],[\"name/3\",[3,43.737]],[\"comment/3\",[]],[\"name/4\",[4,43.737]],[\"comment/4\",[]],[\"name/5\",[5,43.737]],[\"comment/5\",[]],[\"name/6\",[6,43.737]],[\"comment/6\",[]],[\"name/7\",[7,43.737]],[\"comment/7\",[]],[\"name/8\",[8,43.737]],[\"comment/8\",[]],[\"name/9\",[9,43.737]],[\"comment/9\",[]],[\"name/10\",[10,43.737]],[\"comment/10\",[]],[\"name/11\",[11,43.737]],[\"comment/11\",[]],[\"name/12\",[12,43.737]],[\"comment/12\",[]],[\"name/13\",[13,43.737]],[\"comment/13\",[]],[\"name/14\",[14,43.737]],[\"comment/14\",[]],[\"name/15\",[15,43.737]],[\"comment/15\",[]],[\"name/16\",[16,43.737]],[\"comment/16\",[]],[\"name/17\",[17,43.737]],[\"comment/17\",[]],[\"name/18\",[18,43.737]],[\"comment/18\",[]],[\"name/19\",[19,43.737]],[\"comment/19\",[]],[\"name/20\",[20,43.737]],[\"comment/20\",[]],[\"name/21\",[21,43.737]],[\"comment/21\",[]],[\"name/22\",[22,43.737]],[\"comment/22\",[]],[\"name/23\",[23,43.737]],[\"comment/23\",[]],[\"name/24\",[24,43.737]],[\"comment/24\",[]],[\"name/25\",[25,43.737]],[\"comment/25\",[]],[\"name/26\",[26,43.737]],[\"comment/26\",[]],[\"name/27\",[27,43.737]],[\"comment/27\",[]],[\"name/28\",[28,43.737]],[\"comment/28\",[]],[\"name/29\",[29,43.737]],[\"comment/29\",[]],[\"name/30\",[30,43.737]],[\"comment/30\",[]],[\"name/31\",[31,43.737]],[\"comment/31\",[]],[\"name/32\",[32,43.737]],[\"comment/32\",[]],[\"name/33\",[33,43.737]],[\"comment/33\",[]],[\"name/34\",[34,43.737]],[\"comment/34\",[]],[\"name/35\",[35,43.737]],[\"comment/35\",[]],[\"name/36\",[36,43.737]],[\"comment/36\",[]],[\"name/37\",[37,43.737]],[\"comment/37\",[]],[\"name/38\",[38,43.737]],[\"comment/38\",[]],[\"name/39\",[39,43.737]],[\"comment/39\",[]],[\"name/40\",[40,43.737]],[\"comment/40\",[]],[\"name/41\",[41,43.737]],[\"comment/41\",[]],[\"name/42\",[42,43.737]],[\"comment/42\",[]],[\"name/43\",[43,43.737]],[\"comment/43\",[]],[\"name/44\",[44,43.737]],[\"comment/44\",[]],[\"name/45\",[45,43.737]],[\"comment/45\",[]],[\"name/46\",[46,43.737]],[\"comment/46\",[]],[\"name/47\",[47,43.737]],[\"comment/47\",[]],[\"name/48\",[48,43.737]],[\"comment/48\",[]],[\"name/49\",[49,43.737]],[\"comment/49\",[]],[\"name/50\",[50,43.737]],[\"comment/50\",[]],[\"name/51\",[51,43.737]],[\"comment/51\",[]],[\"name/52\",[52,43.737]],[\"comment/52\",[]],[\"name/53\",[53,43.737]],[\"comment/53\",[]],[\"name/54\",[54,43.737]],[\"comment/54\",[]],[\"name/55\",[55,43.737]],[\"comment/55\",[]],[\"name/56\",[56,43.737]],[\"comment/56\",[]],[\"name/57\",[57,43.737]],[\"comment/57\",[]],[\"name/58\",[58,43.737]],[\"comment/58\",[]],[\"name/59\",[59,43.737]],[\"comment/59\",[]],[\"name/60\",[60,43.737]],[\"comment/60\",[]],[\"name/61\",[61,43.737]],[\"comment/61\",[]],[\"name/62\",[62,43.737]],[\"comment/62\",[]],[\"name/63\",[63,43.737]],[\"comment/63\",[]],[\"name/64\",[64,43.737]],[\"comment/64\",[]],[\"name/65\",[65,43.737]],[\"comment/65\",[]],[\"name/66\",[66,43.737]],[\"comment/66\",[]],[\"name/67\",[67,43.737]],[\"comment/67\",[]],[\"name/68\",[68,43.737]],[\"comment/68\",[]],[\"name/69\",[69,43.737]],[\"comment/69\",[]],[\"name/70\",[70,43.737]],[\"comment/70\",[]],[\"name/71\",[71,43.737]],[\"comment/71\",[]],[\"name/72\",[72,43.737]],[\"comment/72\",[]],[\"name/73\",[73,43.737]],[\"comment/73\",[]],[\"name/74\",[74,43.737]],[\"comment/74\",[]],[\"name/75\",[75,43.737]],[\"comment/75\",[]],[\"name/76\",[76,43.737]],[\"comment/76\",[]],[\"name/77\",[77,43.737]],[\"comment/77\",[]],[\"name/78\",[78,43.737]],[\"comment/78\",[]],[\"name/79\",[79,43.737]],[\"comment/79\",[]],[\"name/80\",[80,43.737]],[\"comment/80\",[]],[\"name/81\",[81,43.737]],[\"comment/81\",[]],[\"name/82\",[82,43.737]],[\"comment/82\",[]],[\"name/83\",[83,43.737]],[\"comment/83\",[]],[\"name/84\",[84,43.737]],[\"comment/84\",[]],[\"name/85\",[85,43.737]],[\"comment/85\",[]],[\"name/86\",[86,43.737]],[\"comment/86\",[]],[\"name/87\",[87,43.737]],[\"comment/87\",[]],[\"name/88\",[88,43.737]],[\"comment/88\",[]],[\"name/89\",[89,43.737]],[\"comment/89\",[]],[\"name/90\",[90,43.737]],[\"comment/90\",[]],[\"name/91\",[91,43.737]],[\"comment/91\",[]],[\"name/92\",[92,43.737]],[\"comment/92\",[]],[\"name/93\",[93,43.737]],[\"comment/93\",[]],[\"name/94\",[94,43.737]],[\"comment/94\",[]],[\"name/95\",[95,43.737]],[\"comment/95\",[]],[\"name/96\",[96,43.737]],[\"comment/96\",[]],[\"name/97\",[97,43.737]],[\"comment/97\",[]],[\"name/98\",[98,43.737]],[\"comment/98\",[]],[\"name/99\",[99,43.737]],[\"comment/99\",[]],[\"name/100\",[100,43.737]],[\"comment/100\",[]],[\"name/101\",[101,43.737]],[\"comment/101\",[]],[\"name/102\",[102,32.75]],[\"comment/102\",[]],[\"name/103\",[103,43.737]],[\"comment/103\",[]],[\"name/104\",[102,32.75]],[\"comment/104\",[]],[\"name/105\",[104,43.737]],[\"comment/105\",[]],[\"name/106\",[102,32.75]],[\"comment/106\",[]],[\"name/107\",[105,43.737]],[\"comment/107\",[]],[\"name/108\",[102,32.75]],[\"comment/108\",[]],[\"name/109\",[106,43.737]],[\"comment/109\",[]],[\"name/110\",[107,43.737]],[\"comment/110\",[]],[\"name/111\",[108,43.737]],[\"comment/111\",[]],[\"name/112\",[109,43.737]],[\"comment/112\",[]],[\"name/113\",[110,43.737]],[\"comment/113\",[]],[\"name/114\",[111,43.737]],[\"comment/114\",[]],[\"name/115\",[112,43.737]],[\"comment/115\",[]],[\"name/116\",[113,43.737]],[\"comment/116\",[]],[\"name/117\",[114,43.737]],[\"comment/117\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":102,\"name\":{\"102\":{},\"104\":{},\"106\":{},\"108\":{}},\"comment\":{}}],[\"at\",{\"_index\":109,\"name\":{\"112\":{}},\"comment\":{}}],[\"begin\",{\"_index\":51,\"name\":{\"51\":{}},\"comment\":{}}],[\"charat\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"charcodeat\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"codepointat\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"codepointrange\",{\"_index\":45,\"name\":{\"45\":{}},\"comment\":{}}],[\"compare\",{\"_index\":46,\"name\":{\"46\":{}},\"comment\":{}}],[\"comparefunction\",{\"_index\":104,\"name\":{\"105\":{}},\"comment\":{}}],[\"concat\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"counteachmatchingngram\",{\"_index\":73,\"name\":{\"73\":{}},\"comment\":{}}],[\"counteachngram\",{\"_index\":69,\"name\":{\"69\":{}},\"comment\":{}}],[\"countmatchingngrams\",{\"_index\":72,\"name\":{\"72\":{}},\"comment\":{}}],[\"countngrams\",{\"_index\":67,\"name\":{\"67\":{}},\"comment\":{}}],[\"countuniquematchingngrams\",{\"_index\":74,\"name\":{\"74\":{}},\"comment\":{}}],[\"countuniquengrams\",{\"_index\":68,\"name\":{\"68\":{}},\"comment\":{}}],[\"dameraulevenshteindistance\",{\"_index\":88,\"name\":{\"88\":{}},\"comment\":{}}],[\"digits\",{\"_index\":89,\"name\":{\"89\":{}},\"comment\":{}}],[\"end\",{\"_index\":53,\"name\":{\"53\":{}},\"comment\":{}}],[\"endswith\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"euclideandistance\",{\"_index\":75,\"name\":{\"75\":{}},\"comment\":{}}],[\"filter\",{\"_index\":38,\"name\":{\"38\":{}},\"comment\":{}}],[\"from\",{\"_index\":34,\"name\":{\"34\":{}},\"comment\":{}}],[\"fromcharcode\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"fromcodepoint\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"get\",{\"_index\":48,\"name\":{\"48\":{}},\"comment\":{}}],[\"getall\",{\"_index\":49,\"name\":{\"49\":{}},\"comment\":{}}],[\"hammingdistance\",{\"_index\":76,\"name\":{\"76\":{}},\"comment\":{}}],[\"hex_digits\",{\"_index\":91,\"name\":{\"91\":{}},\"comment\":{}}],[\"includes\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"index\",{\"_index\":43,\"name\":{\"43\":{}},\"comment\":{}}],[\"indexof\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"indexrange\",{\"_index\":44,\"name\":{\"44\":{}},\"comment\":{}}],[\"infix\",{\"_index\":112,\"name\":{\"115\":{}},\"comment\":{}}],[\"is\",{\"_index\":40,\"name\":{\"40\":{}},\"comment\":{}}],[\"ischaracter\",{\"_index\":42,\"name\":{\"42\":{}},\"comment\":{}}],[\"isempty\",{\"_index\":41,\"name\":{\"41\":{}},\"comment\":{}}],[\"isequal\",{\"_index\":47,\"name\":{\"47\":{}},\"comment\":{}}],[\"isinfix\",{\"_index\":108,\"name\":{\"111\":{}},\"comment\":{}}],[\"isprefix\",{\"_index\":106,\"name\":{\"109\":{}},\"comment\":{}}],[\"issuffix\",{\"_index\":107,\"name\":{\"110\":{}},\"comment\":{}}],[\"jaccarddistance\",{\"_index\":78,\"name\":{\"78\":{}},\"comment\":{}}],[\"jaccardindex\",{\"_index\":77,\"name\":{\"77\":{}},\"comment\":{}}],[\"jarodistance\",{\"_index\":84,\"name\":{\"84\":{}},\"comment\":{}}],[\"jarosimilarity\",{\"_index\":83,\"name\":{\"83\":{}},\"comment\":{}}],[\"jarowinklerdistance\",{\"_index\":86,\"name\":{\"86\":{}},\"comment\":{}}],[\"jarowinklersimilarity\",{\"_index\":85,\"name\":{\"85\":{}},\"comment\":{}}],[\"lastindexof\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"left\",{\"_index\":111,\"name\":{\"114\":{}},\"comment\":{}}],[\"length\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"letters\",{\"_index\":94,\"name\":{\"94\":{}},\"comment\":{}}],[\"levenshteindistance\",{\"_index\":87,\"name\":{\"87\":{}},\"comment\":{}}],[\"localecompare\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"longestcommoninfix\",{\"_index\":54,\"name\":{\"54\":{}},\"comment\":{}}],[\"longestcommonprefix\",{\"_index\":55,\"name\":{\"55\":{}},\"comment\":{}}],[\"longestcommonsuffix\",{\"_index\":56,\"name\":{\"56\":{}},\"comment\":{}}],[\"longestuncommoninfixes\",{\"_index\":57,\"name\":{\"57\":{}},\"comment\":{}}],[\"lowercase\",{\"_index\":93,\"name\":{\"93\":{}},\"comment\":{}}],[\"mapfunction\",{\"_index\":103,\"name\":{\"103\":{}},\"comment\":{}}],[\"match\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"matchall\",{\"_index\":17,\"name\":{\"17\":{}},\"comment\":{}}],[\"matchingngrams\",{\"_index\":70,\"name\":{\"70\":{}},\"comment\":{}}],[\"max_code_point\",{\"_index\":99,\"name\":{\"99\":{}},\"comment\":{}}],[\"middle\",{\"_index\":52,\"name\":{\"52\":{}},\"comment\":{}}],[\"min_code_point\",{\"_index\":98,\"name\":{\"98\":{}},\"comment\":{}}],[\"ngrams\",{\"_index\":65,\"name\":{\"65\":{}},\"comment\":{}}],[\"normalize\",{\"_index\":32,\"name\":{\"32\":{}},\"comment\":{}}],[\"oct_digits\",{\"_index\":90,\"name\":{\"90\":{}},\"comment\":{}}],[\"of\",{\"_index\":33,\"name\":{\"33\":{}},\"comment\":{}}],[\"padend\",{\"_index\":26,\"name\":{\"26\":{}},\"comment\":{}}],[\"padstart\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"prefix\",{\"_index\":110,\"name\":{\"113\":{}},\"comment\":{}}],[\"printable\",{\"_index\":97,\"name\":{\"97\":{}},\"comment\":{}}],[\"punctuation\",{\"_index\":95,\"name\":{\"95\":{}},\"comment\":{}}],[\"repeat\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"replace\",{\"_index\":31,\"name\":{\"31\":{}},\"comment\":{}}],[\"replacefunction\",{\"_index\":101,\"name\":{\"101\":{}},\"comment\":{}}],[\"reverse\",{\"_index\":36,\"name\":{\"36\":{}},\"comment\":{}}],[\"right\",{\"_index\":114,\"name\":{\"117\":{}},\"comment\":{}}],[\"search\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"set\",{\"_index\":50,\"name\":{\"50\":{}},\"comment\":{}}],[\"size\",{\"_index\":100,\"name\":{\"100\":{}},\"comment\":{}}],[\"slice\",{\"_index\":19,\"name\":{\"19\":{}},\"comment\":{}}],[\"sorensendicedistance\",{\"_index\":80,\"name\":{\"80\":{}},\"comment\":{}}],[\"sorensendiceindex\",{\"_index\":79,\"name\":{\"79\":{}},\"comment\":{}}],[\"sort\",{\"_index\":37,\"name\":{\"37\":{}},\"comment\":{}}],[\"spaces\",{\"_index\":39,\"name\":{\"39\":{}},\"comment\":{}}],[\"splice\",{\"_index\":35,\"name\":{\"35\":{}},\"comment\":{}}],[\"split\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"startswith\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"substring\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"suffix\",{\"_index\":113,\"name\":{\"116\":{}},\"comment\":{}}],[\"testfunction\",{\"_index\":105,\"name\":{\"107\":{}},\"comment\":{}}],[\"tobaseline\",{\"_index\":58,\"name\":{\"58\":{}},\"comment\":{}}],[\"tocamelcase\",{\"_index\":63,\"name\":{\"63\":{}},\"comment\":{}}],[\"tokebabcase\",{\"_index\":61,\"name\":{\"61\":{}},\"comment\":{}}],[\"tolocalelowercase\",{\"_index\":30,\"name\":{\"30\":{}},\"comment\":{}}],[\"tolocaleuppercase\",{\"_index\":28,\"name\":{\"28\":{}},\"comment\":{}}],[\"tolowercase\",{\"_index\":29,\"name\":{\"29\":{}},\"comment\":{}}],[\"topascalcase\",{\"_index\":64,\"name\":{\"64\":{}},\"comment\":{}}],[\"tosnakecase\",{\"_index\":62,\"name\":{\"62\":{}},\"comment\":{}}],[\"tostring\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"tosubscript\",{\"_index\":60,\"name\":{\"60\":{}},\"comment\":{}}],[\"tosuperscript\",{\"_index\":59,\"name\":{\"59\":{}},\"comment\":{}}],[\"touppercase\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"trim\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"trimend\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"trimstart\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"tverskydistance\",{\"_index\":82,\"name\":{\"82\":{}},\"comment\":{}}],[\"tverskyindex\",{\"_index\":81,\"name\":{\"81\":{}},\"comment\":{}}],[\"uniquematchingngrams\",{\"_index\":71,\"name\":{\"71\":{}},\"comment\":{}}],[\"uniquengrams\",{\"_index\":66,\"name\":{\"66\":{}},\"comment\":{}}],[\"uppercase\",{\"_index\":92,\"name\":{\"92\":{}},\"comment\":{}}],[\"valueof\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"whitespace\",{\"_index\":96,\"name\":{\"96\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/assets/style.css b/assets/style.css new file mode 100644 index 0000000..18b4f8f --- /dev/null +++ b/assets/style.css @@ -0,0 +1,1367 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --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 */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --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 */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1700px; + padding: 0 2rem; +} + +/* Footer */ +.tsd-generator { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; +} + +.tsd-generator > p { + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; +} + +.container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: relative; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation.settings { + margin: 1rem 0; +} +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); +} +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li, +.tsd-page-navigation li { + padding: 0; + max-width: 100%; +} +.tsd-nested-navigation { + margin-left: 3rem; +} +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; +} +.tsd-small-nested-navigation { + margin-left: 1.5rem; +} +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; +} + +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); +} + +.tsd-page-navigation ul { + padding-left: 1.75rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + + cursor: pointer; +} +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/functions/begin.html b/functions/begin.html new file mode 100644 index 0000000..3abeb2e --- /dev/null +++ b/functions/begin.html @@ -0,0 +1,176 @@ +begin | extra-string
+
+ +
+
+
+
+ +

Function begin

+
+
    + +
  • +

    Get leftmost part of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      count: number = 1
      +

      number of characters [1]

      +
      +
    +

    Returns string

    x[0:n] | n = count

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/charAt.html b/functions/charAt.html new file mode 100644 index 0000000..76cb16e --- /dev/null +++ b/functions/charAt.html @@ -0,0 +1,176 @@ +charAt | extra-string
+
+ +
+
+
+
+ +

Function charAt

+
+
    + +
  • +

    Get character at given index in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      character index

      +
      +
    +

    Returns string

    character

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/charCodeAt.html b/functions/charCodeAt.html new file mode 100644 index 0000000..352c7d9 --- /dev/null +++ b/functions/charCodeAt.html @@ -0,0 +1,176 @@ +charCodeAt | extra-string
+
+ +
+
+
+
+ +

Function charCodeAt

+
+
    + +
  • +

    Get UTF-16 code unit of a character in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      character index

      +
      +
    +

    Returns number

    UTF-16 code unit

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/codePointAt.html b/functions/codePointAt.html new file mode 100644 index 0000000..1fff387 --- /dev/null +++ b/functions/codePointAt.html @@ -0,0 +1,176 @@ +codePointAt | extra-string
+
+ +
+
+
+
+ +

Function codePointAt

+
+
    + +
  • +

    Get unicode code point of a character in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      character index

      +
      +
    +

    Returns number

    unicode code point

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/codePointRange.html b/functions/codePointRange.html new file mode 100644 index 0000000..5306f83 --- /dev/null +++ b/functions/codePointRange.html @@ -0,0 +1,171 @@ +codePointRange | extra-string
+
+ +
+
+
+
+ +

Function codePointRange

+
+
    + +
  • +

    Get unicode code point range of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns [number, number]

    code point range [min, max]

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/compare.html b/functions/compare.html new file mode 100644 index 0000000..969a068 --- /dev/null +++ b/functions/compare.html @@ -0,0 +1,176 @@ +compare | extra-string
+
+ +
+
+
+
+ +

Function compare

+
+
    + +
  • +

    Compare two strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns number

    x<y: -ve, x=y: 0, x>y: +ve

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/concat.html b/functions/concat.html new file mode 100644 index 0000000..501d64c --- /dev/null +++ b/functions/concat.html @@ -0,0 +1,171 @@ +concat | extra-string
+
+ +
+
+
+
+ +

Function concat

+
+
    + +
  • +

    Combine multiple values into a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...values: any[]
      +

      values

      +
      +
    +

    Returns string

    combined string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countEachMatchingNgram.html b/functions/countEachMatchingNgram.html new file mode 100644 index 0000000..ef23678 --- /dev/null +++ b/functions/countEachMatchingNgram.html @@ -0,0 +1,181 @@ +countEachMatchingNgram | extra-string
+
+ +
+
+
+
+ +

Function countEachMatchingNgram

+
+
    + +
  • +

    Count each matching n-gram between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns Map<string, number>

    Map {gᵢ: count(gᵢ)} | gᵢ = iᵗʰ matching n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countEachNgram.html b/functions/countEachNgram.html new file mode 100644 index 0000000..f16f910 --- /dev/null +++ b/functions/countEachNgram.html @@ -0,0 +1,176 @@ +countEachNgram | extra-string
+
+ +
+
+
+
+ +

Function countEachNgram

+
+
    + +
  • +

    Count each n-gram of a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns Map<string, number>

    Map {gᵢ: count(gᵢ)} | gᵢ = iᵗʰ n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countMatchingNgrams.html b/functions/countMatchingNgrams.html new file mode 100644 index 0000000..9ee7f08 --- /dev/null +++ b/functions/countMatchingNgrams.html @@ -0,0 +1,181 @@ +countMatchingNgrams | extra-string
+
+ +
+
+
+
+ +

Function countMatchingNgrams

+
+
    + +
  • +

    Count the total number of matching n-grams between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    |[gᵢ]| | gᵢ = iᵗʰ matching n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countNgrams.html b/functions/countNgrams.html new file mode 100644 index 0000000..532ebe4 --- /dev/null +++ b/functions/countNgrams.html @@ -0,0 +1,176 @@ +countNgrams | extra-string
+
+ +
+
+
+
+ +

Function countNgrams

+
+
    + +
  • +

    Count the total number of n-grams of a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    |gᵢ| | gᵢ = iᵗʰ n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countUniqueMatchingNgrams.html b/functions/countUniqueMatchingNgrams.html new file mode 100644 index 0000000..255072d --- /dev/null +++ b/functions/countUniqueMatchingNgrams.html @@ -0,0 +1,181 @@ +countUniqueMatchingNgrams | extra-string
+
+ +
+
+
+
+ +

Function countUniqueMatchingNgrams

+
+
    + +
  • +

    Count the total number of unique matching n-grams between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    |Set {gᵢ}| | gᵢ = iᵗʰ unique matching n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/countUniqueNgrams.html b/functions/countUniqueNgrams.html new file mode 100644 index 0000000..f1f2646 --- /dev/null +++ b/functions/countUniqueNgrams.html @@ -0,0 +1,176 @@ +countUniqueNgrams | extra-string
+
+ +
+
+
+
+ +

Function countUniqueNgrams

+
+
    + +
  • +

    Count the total number of unique n-grams of a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    |Set {gᵢ}| | gᵢ = iᵗʰ n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/damerauLevenshteinDistance.html b/functions/damerauLevenshteinDistance.html new file mode 100644 index 0000000..a30223a --- /dev/null +++ b/functions/damerauLevenshteinDistance.html @@ -0,0 +1,196 @@ +damerauLevenshteinDistance | extra-string
+
+ +
+
+
+
+ +

Function damerauLevenshteinDistance

+
+
    + +
  • +

    Get Damerau–Levenshtein distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      ins: number = 1
      +

      insertion cost [1]

      +
      +
      • +
    • +
      del: number = 1
      +

      deletion cost [1]

      +
      +
      • +
    • +
      sub: number = 1
      +

      substitution cost [1]

      +
      +
      • +
    • +
      tra: number = 1
      +

      transposition cost [1]

      +
      +
    +

    Returns number

    damerau–levenshtein distance

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/end.html b/functions/end.html new file mode 100644 index 0000000..5afee44 --- /dev/null +++ b/functions/end.html @@ -0,0 +1,176 @@ +end | extra-string
+
+ +
+
+
+
+ +

Function end

+
+
    + +
  • +

    Get rightmost part of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      count: number = 1
      +

      number of characters [1]

      +
      +
    +

    Returns string

    x[|x|-n:] | n = count

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/endsWith.html b/functions/endsWith.html new file mode 100644 index 0000000..d3f2b4c --- /dev/null +++ b/functions/endsWith.html @@ -0,0 +1,181 @@ +endsWith | extra-string
+
+ +
+
+
+
+ +

Function endsWith

+
+
    + +
  • +

    Check if string has a given suffix.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      suffix: string
      +

      suffix to look for

      +
      +
      • +
    • +
      Optional end: number
      +

      end index [end]

      +
      +
    +

    Returns boolean

    has suffix?

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/euclideanDistance.html b/functions/euclideanDistance.html new file mode 100644 index 0000000..7609ca8 --- /dev/null +++ b/functions/euclideanDistance.html @@ -0,0 +1,176 @@ +euclideanDistance | extra-string
+
+ +
+
+
+
+ +

Function euclideanDistance

+
+
    + +
  • +

    Get euclidean distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns number

    euclidean distance

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/filter.html b/functions/filter.html new file mode 100644 index 0000000..f8c7718 --- /dev/null +++ b/functions/filter.html @@ -0,0 +1,181 @@ +filter | extra-string
+
+ +
+
+
+
+ +

Function filter

+
+
    + +
  • +

    Filter characters which pass a test.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      ft: TestFunction
      +

      test function (v, i, x)

      +
      +
      • +
    • +
      Optional ths: any
      +

      this argument

      +
      +
    +

    Returns string

    characters which pass the test

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/from.html b/functions/from.html new file mode 100644 index 0000000..1092ac5 --- /dev/null +++ b/functions/from.html @@ -0,0 +1,180 @@ +from | extra-string
+
+ +
+
+
+
+ +

Function from

+
+
    + +
  • +

    Create string from iterable, like Array.from().

    +
    +
    +

    Parameters

    +
      +
    • +
      xs: Iterable<string>
      +

      list of strings (iterable)

      +
      +
      • +
    • +
      Optional fm: MapFunction
      +

      map function (x, i)

      +
      +
      • +
    • +
      Optional ths: any
      +

      this argument

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/fromCharCode.html b/functions/fromCharCode.html new file mode 100644 index 0000000..837ed0c --- /dev/null +++ b/functions/fromCharCode.html @@ -0,0 +1,171 @@ +fromCharCode | extra-string
+
+ +
+
+
+
+ +

Function fromCharCode

+
+
    + +
  • +

    Get characters whose UTF-16 code units are given.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...codes: number[]
      +

      UTF-16 code units

      +
      +
    +

    Returns string

    characters

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/fromCodePoint.html b/functions/fromCodePoint.html new file mode 100644 index 0000000..f154f0c --- /dev/null +++ b/functions/fromCodePoint.html @@ -0,0 +1,171 @@ +fromCodePoint | extra-string
+
+ +
+
+
+
+ +

Function fromCodePoint

+
+
    + +
  • +

    Get characters whose unicode code points are given.

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...codes: number[]
      +

      unicode code points

      +
      +
    +

    Returns string

    characters

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/get.html b/functions/get.html new file mode 100644 index 0000000..28852c2 --- /dev/null +++ b/functions/get.html @@ -0,0 +1,176 @@ +get | extra-string
+
+ +
+
+
+
+ +

Function get

+
+
    + +
  • +

    Get character at a given index in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      character index (-ve ⇒ from right)

      +
      +
    +

    Returns string

    x[i] | i = at

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/getAll.html b/functions/getAll.html new file mode 100644 index 0000000..a4bb046 --- /dev/null +++ b/functions/getAll.html @@ -0,0 +1,176 @@ +getAll | extra-string
+
+ +
+
+
+
+ +

Function getAll

+
+
    + +
  • +

    Get characters at indices.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      ats: Iterable<number>
      +

      character indices (-ve ⇒ from right)

      +
      +
    +

    Returns string

    x[i] + x[j] + ... | [i, j, ...] = ats

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/hammingDistance.html b/functions/hammingDistance.html new file mode 100644 index 0000000..dd0a497 --- /dev/null +++ b/functions/hammingDistance.html @@ -0,0 +1,176 @@ +hammingDistance | extra-string
+
+ +
+
+
+
+ +

Function hammingDistance

+
+
    + +
  • +

    Get hamming distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns number

    hamming distance

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/includes.html b/functions/includes.html new file mode 100644 index 0000000..010fb3a --- /dev/null +++ b/functions/includes.html @@ -0,0 +1,181 @@ +includes | extra-string
+
+ +
+
+
+
+ +

Function includes

+
+
    + +
  • +

    Check if string has a given infix.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      infix: string
      +

      infix to look for

      +
      +
      • +
    • +
      Optional start: number
      +

      start index [0]

      +
      +
    +

    Returns boolean

    has infix?

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/index.html b/functions/index.html new file mode 100644 index 0000000..af6f4a3 --- /dev/null +++ b/functions/index.html @@ -0,0 +1,176 @@ +index | extra-string
+
+ +
+
+
+
+ +

Function index

+
+
    + +
  • +

    Get non-negative index within string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      character index

      +
      +
    +

    Returns number

    +ve index

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/indexOf.html b/functions/indexOf.html new file mode 100644 index 0000000..7edd629 --- /dev/null +++ b/functions/indexOf.html @@ -0,0 +1,181 @@ +indexOf | extra-string
+
+ +
+
+
+
+ +

Function indexOf

+
+
    + +
  • +

    Get first index of a given infix in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      infix: string
      +

      infix to look for

      +
      +
      • +
    • +
      Optional start: number
      +

      start index [0]

      +
      +
    +

    Returns number

    first index of infix

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/indexRange.html b/functions/indexRange.html new file mode 100644 index 0000000..d703d73 --- /dev/null +++ b/functions/indexRange.html @@ -0,0 +1,181 @@ +indexRange | extra-string
+
+ +
+
+
+
+ +

Function indexRange

+
+
    + +
  • +

    Get non-negative index range within string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      start: number
      +

      start index

      +
      +
      • +
    • +
      end: number
      +

      end index

      +
      +
    +

    Returns [number, number]

    +ve index range [start, end]

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/is.html b/functions/is.html new file mode 100644 index 0000000..a62fc1e --- /dev/null +++ b/functions/is.html @@ -0,0 +1,171 @@ +is | extra-string
+
+ +
+
+
+
+ +

Function is

+
+
    + +
  • +

    Check if value is a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      v: any
      +

      a value

      +
      +
    +

    Returns boolean

    whether value is a string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/isCharacter.html b/functions/isCharacter.html new file mode 100644 index 0000000..c7d4fc4 --- /dev/null +++ b/functions/isCharacter.html @@ -0,0 +1,171 @@ +isCharacter | extra-string
+
+ +
+
+
+
+ +

Function isCharacter

+
+
    + +
  • +

    Check if string is a character.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns boolean

    whether string is a character

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/isEmpty.html b/functions/isEmpty.html new file mode 100644 index 0000000..97502ef --- /dev/null +++ b/functions/isEmpty.html @@ -0,0 +1,171 @@ +isEmpty | extra-string
+
+ +
+
+
+
+ +

Function isEmpty

+
+
    + +
  • +

    Check if string is empty.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns boolean

    whether string is empty

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/isEqual.html b/functions/isEqual.html new file mode 100644 index 0000000..cfb8ed5 --- /dev/null +++ b/functions/isEqual.html @@ -0,0 +1,176 @@ +isEqual | extra-string
+
+ +
+
+
+
+ +

Function isEqual

+
+
    + +
  • +

    Check if two strings are equal.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns boolean

    x=y?

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaccardDistance.html b/functions/jaccardDistance.html new file mode 100644 index 0000000..0bbb73b --- /dev/null +++ b/functions/jaccardDistance.html @@ -0,0 +1,181 @@ +jaccardDistance | extra-string
+
+ +
+
+
+
+ +

Function jaccardDistance

+
+
    + +
  • +

    Get jaccard distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    1 - jaccardIndex(x, y)

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaccardIndex.html b/functions/jaccardIndex.html new file mode 100644 index 0000000..eb57b60 --- /dev/null +++ b/functions/jaccardIndex.html @@ -0,0 +1,181 @@ +jaccardIndex | extra-string
+
+ +
+
+
+
+ +

Function jaccardIndex

+
+
    + +
  • +

    Get jaccard index between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    |X ∩ Y|/|X ∪ Y| | X,Y = n-grams of x,y

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaroDistance.html b/functions/jaroDistance.html new file mode 100644 index 0000000..001c195 --- /dev/null +++ b/functions/jaroDistance.html @@ -0,0 +1,176 @@ +jaroDistance | extra-string
+
+ +
+
+
+
+ +

Function jaroDistance

+
+
    + +
  • +

    Get Jaro distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns number

    1 - jaroSimilarity(x, y)

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaroSimilarity.html b/functions/jaroSimilarity.html new file mode 100644 index 0000000..a1cbb44 --- /dev/null +++ b/functions/jaroSimilarity.html @@ -0,0 +1,176 @@ +jaroSimilarity | extra-string
+
+ +
+
+
+
+ +

Function jaroSimilarity

+
+
    + +
  • +

    Get Jaro similarity between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns number

    (m/|x| + m/|y| + (m-t)/m)/3 | m = # matches, t = # transpositions

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaroWinklerDistance.html b/functions/jaroWinklerDistance.html new file mode 100644 index 0000000..2bf07fd --- /dev/null +++ b/functions/jaroWinklerDistance.html @@ -0,0 +1,181 @@ +jaroWinklerDistance | extra-string
+
+ +
+
+
+
+ +

Function jaroWinklerDistance

+
+
    + +
  • +

    Get Jaro-Winkler distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      p: number = 0.1
      +

      scaling factor for common prefix (0.1 - 0.25) [0.1]

      +
      +
    +

    Returns number

    1 - jaroWinklerSimilarity(x, y)

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/jaroWinklerSimilarity.html b/functions/jaroWinklerSimilarity.html new file mode 100644 index 0000000..3320903 --- /dev/null +++ b/functions/jaroWinklerSimilarity.html @@ -0,0 +1,181 @@ +jaroWinklerSimilarity | extra-string
+
+ +
+
+
+
+ +

Function jaroWinklerSimilarity

+
+
    + +
  • +

    Get Jaro-Winkler similarity between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      p: number = 0.1
      +

      scaling factor for common prefix (0.1 - 0.25) [0.1]

      +
      +
    +

    Returns number

    simⱼ + ℓp(1 - simⱼ) | simⱼ = jaro similarity, ℓ = |longest common prefix|

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/lastIndexOf.html b/functions/lastIndexOf.html new file mode 100644 index 0000000..2850694 --- /dev/null +++ b/functions/lastIndexOf.html @@ -0,0 +1,181 @@ +lastIndexOf | extra-string
+
+ +
+
+
+
+ +

Function lastIndexOf

+
+
    + +
  • +

    Get last index of a given infix in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      infix: string
      +

      infix to look for

      +
      +
      • +
    • +
      Optional rstart: number
      +

      reverse start index [end-1]

      +
      +
    +

    Returns number

    last index of infix

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/length.html b/functions/length.html new file mode 100644 index 0000000..61207a0 --- /dev/null +++ b/functions/length.html @@ -0,0 +1,171 @@ +length | extra-string
+
+ +
+
+
+
+ +

Function length

+
+
    + +
  • +

    Get length of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns number

    length of string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/levenshteinDistance.html b/functions/levenshteinDistance.html new file mode 100644 index 0000000..a2864fd --- /dev/null +++ b/functions/levenshteinDistance.html @@ -0,0 +1,191 @@ +levenshteinDistance | extra-string
+
+ +
+
+
+
+ +

Function levenshteinDistance

+
+
    + +
  • +

    Get Levenshtein distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      ins: number = 1
      +

      insertion cost [1]

      +
      +
      • +
    • +
      del: number = 1
      +

      deletion cost [1]

      +
      +
      • +
    • +
      sub: number = 1
      +

      substitution cost [1]

      +
      +
    +

    Returns number

    levenshtein distance

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/localeCompare.html b/functions/localeCompare.html new file mode 100644 index 0000000..a5480ee --- /dev/null +++ b/functions/localeCompare.html @@ -0,0 +1,186 @@ +localeCompare | extra-string
+
+ +
+
+
+
+ +

Function localeCompare

+
+
    + +
  • +

    Compare two strings in the current or given locale.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      Optional locales: string | string[]
      +

      language or locale tag(s)

      +
      +
      • +
    • +
      Optional options: CollatorOptions
      +

      comparison options

      +
      +
    +

    Returns number

    x<y: -ve, x=y: 0, x>y: +ve

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/longestCommonInfix.html b/functions/longestCommonInfix.html new file mode 100644 index 0000000..a4dcfd6 --- /dev/null +++ b/functions/longestCommonInfix.html @@ -0,0 +1,176 @@ +longestCommonInfix | extra-string
+
+ +
+
+
+
+ +

Function longestCommonInfix

+
+
    + +
  • +

    Get the longest common infix between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns string

    longest common infix

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/longestCommonPrefix.html b/functions/longestCommonPrefix.html new file mode 100644 index 0000000..2b4d65e --- /dev/null +++ b/functions/longestCommonPrefix.html @@ -0,0 +1,176 @@ +longestCommonPrefix | extra-string
+
+ +
+
+
+
+ +

Function longestCommonPrefix

+
+
    + +
  • +

    Get the longest common prefix of strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns string

    longest common prefix

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/longestCommonSuffix.html b/functions/longestCommonSuffix.html new file mode 100644 index 0000000..4a80133 --- /dev/null +++ b/functions/longestCommonSuffix.html @@ -0,0 +1,176 @@ +longestCommonSuffix | extra-string
+
+ +
+
+
+
+ +

Function longestCommonSuffix

+
+
    + +
  • +

    Get the longest common suffix of strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns string

    longest common suffix

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/longestUncommonInfixes.html b/functions/longestUncommonInfixes.html new file mode 100644 index 0000000..9916d6c --- /dev/null +++ b/functions/longestUncommonInfixes.html @@ -0,0 +1,176 @@ +longestUncommonInfixes | extra-string
+
+ +
+
+
+
+ +

Function longestUncommonInfixes

+
+
    + +
  • +

    Get the longest uncommon infixes of strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
    +

    Returns [string, string]

    [infix1, infix2]

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/match.html b/functions/match.html new file mode 100644 index 0000000..1bd7a38 --- /dev/null +++ b/functions/match.html @@ -0,0 +1,176 @@ +match | extra-string
+
+ +
+
+
+
+ +

Function match

+
+
    + +
  • +

    Get results of matching string with regular expression.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      regexp: string | RegExp
      +

      regular expression

      +
      +
    +

    Returns RegExpMatchArray

    /g: all matches, else: match with capturing groups or null

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/matchAll.html b/functions/matchAll.html new file mode 100644 index 0000000..a543e92 --- /dev/null +++ b/functions/matchAll.html @@ -0,0 +1,176 @@ +matchAll | extra-string
+
+ +
+
+
+
+ +

Function matchAll

+
+
    + +
  • +

    Get detailed results of matching string with regular expression.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      regexp: RegExp
      +

      regular expression (with /g)

      +
      +
    +

    Returns IterableIterator<RegExpMatchArray>

    match with capturing groups ...

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/matchingNgrams.html b/functions/matchingNgrams.html new file mode 100644 index 0000000..64bc503 --- /dev/null +++ b/functions/matchingNgrams.html @@ -0,0 +1,181 @@ +matchingNgrams | extra-string
+
+ +
+
+
+
+ +

Function matchingNgrams

+
+
    + +
  • +

    Get matching n-grams between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns string[]

    [gᵢ] | gᵢ = iᵗʰ matching n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/middle.html b/functions/middle.html new file mode 100644 index 0000000..28c1bcc --- /dev/null +++ b/functions/middle.html @@ -0,0 +1,181 @@ +middle | extra-string
+
+ +
+
+
+
+ +

Function middle

+
+
    + +
  • +

    Get a portion of string from middle.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      start: number
      +

      start index

      +
      +
      • +
    • +
      count: number = 1
      +

      number of characters [1]

      +
      +
    +

    Returns string

    x[i:i+n] | i = start, n = count

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/ngrams.html b/functions/ngrams.html new file mode 100644 index 0000000..ddbe7b0 --- /dev/null +++ b/functions/ngrams.html @@ -0,0 +1,176 @@ +ngrams | extra-string
+
+ +
+
+
+
+ +

Function ngrams

+
+
    + +
  • +

    Get n-grams of a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns string[]

    [x[0:n], x[1:n+1], ...]

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/normalize.html b/functions/normalize.html new file mode 100644 index 0000000..0b89f81 --- /dev/null +++ b/functions/normalize.html @@ -0,0 +1,176 @@ +normalize | extra-string
+
+ +
+
+
+
+ +

Function normalize

+
+
    + +
  • +

    Normalize string by given form, as per Unicode Standard Annex #15.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional form: string
      +

      normalization form (NFC, NFD, NFKC, NFKD)

      +
      +
    +

    Returns string

    normalized string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/of.html b/functions/of.html new file mode 100644 index 0000000..7d6f5af --- /dev/null +++ b/functions/of.html @@ -0,0 +1,171 @@ +of | extra-string
+
+ +
+
+
+
+ +

Function of

+
+
    + +
  • +

    Create string from arguments, like Array.of().

    +
    +
    +

    Parameters

    +
      +
    • +
      Rest ...args: string[]
      +

      arguments

      +
      +
    +

    Returns string

    p + q + ... | [p, q, ...] = args

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/padEnd.html b/functions/padEnd.html new file mode 100644 index 0000000..3dcd546 --- /dev/null +++ b/functions/padEnd.html @@ -0,0 +1,181 @@ +padEnd | extra-string
+
+ +
+
+
+
+ +

Function padEnd

+
+
    + +
  • +

    Pad end of string to fit a desired length.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      length: number
      +

      desired length

      +
      +
      • +
    • +
      padding: string = " "
      +

      pad with [ ]

      +
      +
    +

    Returns string

    padded string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/padStart.html b/functions/padStart.html new file mode 100644 index 0000000..91ec5b5 --- /dev/null +++ b/functions/padStart.html @@ -0,0 +1,181 @@ +padStart | extra-string
+
+ +
+
+
+
+ +

Function padStart

+
+
    + +
  • +

    Pad start of string to fit a desired length.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      length: number
      +

      desired length

      +
      +
      • +
    • +
      padding: string = " "
      +

      pad with [ ]

      +
      +
    +

    Returns string

    padded string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/repeat.html b/functions/repeat.html new file mode 100644 index 0000000..4ed029a --- /dev/null +++ b/functions/repeat.html @@ -0,0 +1,176 @@ +repeat | extra-string
+
+ +
+
+
+
+ +

Function repeat

+
+
    + +
  • +

    Repeat string given number of times.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      times: number
      +

      number of times

      +
      +
    +

    Returns string

    repeated string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/replace.html b/functions/replace.html new file mode 100644 index 0000000..9ff46fc --- /dev/null +++ b/functions/replace.html @@ -0,0 +1,208 @@ +replace | extra-string
+
+ +
+
+
+
+ +

Function replace

+
+
    + +
  • +

    Replace first match of given pattern by replacement.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      pattern: string
      +

      substring to match

      +
      +
      • +
    • +
      replacement: string
      +

      replacement substring

      +
      +
    +

    Returns string

    replaced string

    + +
    • + +
  • +

    Replace first or all matches of given pattern by replacement.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      pattern: string | RegExp
      +

      pattern to match

      +
      +
      • +
    • +
      replacement: string | ReplaceFunction
      +

      replacement substring or replacer

      +
      +
    +

    Returns string

    replaced string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/reverse.html b/functions/reverse.html new file mode 100644 index 0000000..ec45cfa --- /dev/null +++ b/functions/reverse.html @@ -0,0 +1,171 @@ +reverse | extra-string
+
+ +
+
+
+
+ +

Function reverse

+
+
    + +
  • +

    Reverse a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    reversed string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/search.html b/functions/search.html new file mode 100644 index 0000000..998a287 --- /dev/null +++ b/functions/search.html @@ -0,0 +1,176 @@ +search | extra-string
+
+ +
+
+
+
+ +

Function search

+
+
    + +
  • +

    Get first index of regular expression match in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      regexp: string | RegExp
      +

      regular expression

      +
      +
    +

    Returns number

    first index of match

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/set.html b/functions/set.html new file mode 100644 index 0000000..d437d59 --- /dev/null +++ b/functions/set.html @@ -0,0 +1,181 @@ +set | extra-string
+
+ +
+
+
+
+ +

Function set

+
+
    + +
  • +

    Write a substring at specified index in string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      at: number
      +

      write index (-ve ⇒ from right)

      +
      +
      • +
    • +
      write: string
      +

      substring to write

      +
      +
    +

    Returns string

    x[0:i] + w + x[i+|w|:] | i = at, w = write

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/slice.html b/functions/slice.html new file mode 100644 index 0000000..0d8e2d4 --- /dev/null +++ b/functions/slice.html @@ -0,0 +1,181 @@ +slice | extra-string
+
+ +
+
+
+
+ +

Function slice

+
+
    + +
  • +

    Extract section of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional start: number
      +

      start index (-ve ⇒ from right) [0]

      +
      +
      • +
    • +
      Optional end: number
      +

      end index (-ve ⇒ from right) [end]

      +
      +
    +

    Returns string

    section of string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/sorensenDiceDistance.html b/functions/sorensenDiceDistance.html new file mode 100644 index 0000000..b18bd98 --- /dev/null +++ b/functions/sorensenDiceDistance.html @@ -0,0 +1,181 @@ +sorensenDiceDistance | extra-string
+
+ +
+
+
+
+ +

Function sorensenDiceDistance

+
+
    + +
  • +

    Get Sørensen-Dice distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    1 - sorensenDiceIndex(x, y)

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/sorensenDiceIndex.html b/functions/sorensenDiceIndex.html new file mode 100644 index 0000000..6999b4b --- /dev/null +++ b/functions/sorensenDiceIndex.html @@ -0,0 +1,181 @@ +sorensenDiceIndex | extra-string
+
+ +
+
+
+
+ +

Function sorensenDiceIndex

+
+
    + +
  • +

    Get Sørensen-Dice index between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns number

    2|X ∩ Y|/(|X| + |Y|) | X,Y = n-grams of x,y

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/sort.html b/functions/sort.html new file mode 100644 index 0000000..1a11c33 --- /dev/null +++ b/functions/sort.html @@ -0,0 +1,175 @@ +sort | extra-string
+
+ +
+
+
+
+ +

Function sort

+
+
    + +
  • +

    Arrange characters in an order.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional fc: CompareFunction
      +

      compare function (a, b)

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/spaces.html b/functions/spaces.html new file mode 100644 index 0000000..18372a4 --- /dev/null +++ b/functions/spaces.html @@ -0,0 +1,170 @@ +spaces | extra-string
+
+ +
+
+
+
+ +

Function spaces

+
+
    + +
  • +

    Get a string of spaces.

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
      +

      number of spaces

      +
      +
    +

    Returns string

    +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/splice.html b/functions/splice.html new file mode 100644 index 0000000..634273d --- /dev/null +++ b/functions/splice.html @@ -0,0 +1,186 @@ +splice | extra-string
+
+ +
+
+
+
+ +

Function splice

+
+
    + +
  • +

    Remove/replace characters in a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      start: number
      +

      start index

      +
      +
      • +
    • +
      remove: number = 0
      +

      number of characters to remove

      +
      +
      • +
    • +
      add: string = ""
      +

      substring to add

      +
      +
    +

    Returns string

    x[0:i] + add + x[i+r] | i = start, r = remove

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/split.html b/functions/split.html new file mode 100644 index 0000000..0484a4a --- /dev/null +++ b/functions/split.html @@ -0,0 +1,181 @@ +split | extra-string
+
+ +
+
+
+
+ +

Function split

+
+
    + +
  • +

    Split string by a given separator into substrings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional separator: string | RegExp
      +

      separator string or regular expression

      +
      +
      • +
    • +
      Optional limit: number
      +

      maximum number of substrings

      +
      +
    +

    Returns string[]

    substrings

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/startsWith.html b/functions/startsWith.html new file mode 100644 index 0000000..c37b885 --- /dev/null +++ b/functions/startsWith.html @@ -0,0 +1,181 @@ +startsWith | extra-string
+
+ +
+
+
+
+ +

Function startsWith

+
+
    + +
  • +

    Check if string has a given prefix.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      prefix: string
      +

      prefix to look for

      +
      +
      • +
    • +
      Optional start: number
      +

      start index [0]

      +
      +
    +

    Returns boolean

    has prefix?

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/substring.html b/functions/substring.html new file mode 100644 index 0000000..c38c6e9 --- /dev/null +++ b/functions/substring.html @@ -0,0 +1,181 @@ +substring | extra-string
+
+ +
+
+
+
+ +

Function substring

+
+
    + +
  • +

    Extract section of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      start: number
      +

      start index (-ve ⇒ 0) [0]

      +
      +
      • +
    • +
      Optional end: number
      +

      end index (-ve ⇒ 0) [end]

      +
      +
    +

    Returns string

    section of string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toBaseline.html b/functions/toBaseline.html new file mode 100644 index 0000000..dbd393b --- /dev/null +++ b/functions/toBaseline.html @@ -0,0 +1,181 @@ +toBaseline | extra-string
+
+ +
+
+
+
+ +

Function toBaseline

+
+
    + +
  • +

    Convert a string to baseline characters (limited support).

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      fsup: MapFunction = null
      +

      map function for superscript characters (v, i, x)

      +
      +
      • +
    • +
      fsub: MapFunction = null
      +

      map function for subscript characters (v, i, x)

      +
      +
    +

    Returns string

    baselined string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toCamelCase.html b/functions/toCamelCase.html new file mode 100644 index 0000000..d52e9d0 --- /dev/null +++ b/functions/toCamelCase.html @@ -0,0 +1,181 @@ +toCamelCase | extra-string
+
+ +
+
+
+
+ +

Function toCamelCase

+
+
    + +
  • +

    Convert a string to camel-case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      re: RegExp = null
      +

      word seperator pattern [/[^0-9A-Za-z]+/g]

      +
      +
      • +
    • +
      upper: boolean = false
      +

      upper camel case?

      +
      +
    +

    Returns string

    camelCase | CamelCase

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toKebabCase.html b/functions/toKebabCase.html new file mode 100644 index 0000000..6bc8f1f --- /dev/null +++ b/functions/toKebabCase.html @@ -0,0 +1,181 @@ +toKebabCase | extra-string
+
+ +
+
+
+
+ +

Function toKebabCase

+
+
    + +
  • +

    Convert a string to kebab-case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      re: RegExp = null
      +

      word seperator pattern [/[^0-9A-Za-z]+/g]

      +
      +
      • +
    • +
      sep: string = "-"
      +

      separator to join with [-]

      +
      +
    +

    Returns string

    kebab-case | kebabcase

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toLocaleLowerCase.html b/functions/toLocaleLowerCase.html new file mode 100644 index 0000000..560fc77 --- /dev/null +++ b/functions/toLocaleLowerCase.html @@ -0,0 +1,176 @@ +toLocaleLowerCase | extra-string
+
+ +
+
+
+
+ +

Function toLocaleLowerCase

+
+
    + +
  • +

    Convert string to lower case, as per locale-specific case mappings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional locales: string | string[]
      +

      BCP 47 language tag(s)

      +
      +
    +

    Returns string

    lower cased string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toLocaleUpperCase.html b/functions/toLocaleUpperCase.html new file mode 100644 index 0000000..735de9f --- /dev/null +++ b/functions/toLocaleUpperCase.html @@ -0,0 +1,176 @@ +toLocaleUpperCase | extra-string
+
+ +
+
+
+
+ +

Function toLocaleUpperCase

+
+
    + +
  • +

    Convert string to upper case, as per locale-specific case mappings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      Optional locales: string | string[]
      +

      BCP 47 language tag(s)

      +
      +
    +

    Returns string

    upper cased string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toLowerCase.html b/functions/toLowerCase.html new file mode 100644 index 0000000..ac6682d --- /dev/null +++ b/functions/toLowerCase.html @@ -0,0 +1,171 @@ +toLowerCase | extra-string
+
+ +
+
+
+
+ +

Function toLowerCase

+
+
    + +
  • +

    Convert string to lower case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    lower cased string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toPascalCase.html b/functions/toPascalCase.html new file mode 100644 index 0000000..b34fd12 --- /dev/null +++ b/functions/toPascalCase.html @@ -0,0 +1,176 @@ +toPascalCase | extra-string
+
+ +
+
+
+
+ +

Function toPascalCase

+
+
    + +
  • +

    Convert a string to pascal-case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      re: RegExp = null
      +

      word seperator pattern [/[^0-9A-Za-z]+/g]

      +
      +
    +

    Returns string

    PascalCase

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toSnakeCase.html b/functions/toSnakeCase.html new file mode 100644 index 0000000..a7ea46b --- /dev/null +++ b/functions/toSnakeCase.html @@ -0,0 +1,176 @@ +toSnakeCase | extra-string
+
+ +
+
+
+
+ +

Function toSnakeCase

+
+
    + +
  • +

    Convert a string to snake-case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      re: RegExp = null
      +

      word seperator pattern [/[^0-9A-Za-z]+/g]

      +
      +
    +

    Returns string

    snake_case

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toString.html b/functions/toString.html new file mode 100644 index 0000000..beee987 --- /dev/null +++ b/functions/toString.html @@ -0,0 +1,171 @@ +toString | extra-string
+
+ +
+
+
+
+ +

Function toString

+
+
    + +
  • +

    Get string representation of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    string representation

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toSubscript.html b/functions/toSubscript.html new file mode 100644 index 0000000..3cc9bf2 --- /dev/null +++ b/functions/toSubscript.html @@ -0,0 +1,171 @@ +toSubscript | extra-string
+
+ +
+
+
+
+ +

Function toSubscript

+
+
    + +
  • +

    Convert a string to superscript characters (limited support).

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    superscripted characters

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toSuperscript.html b/functions/toSuperscript.html new file mode 100644 index 0000000..9bdf32f --- /dev/null +++ b/functions/toSuperscript.html @@ -0,0 +1,171 @@ +toSuperscript | extra-string
+
+ +
+
+
+
+ +

Function toSuperscript

+
+
    + +
  • +

    Convert a string to superscript characters (limited support).

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    superscripted characters

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/toUpperCase.html b/functions/toUpperCase.html new file mode 100644 index 0000000..955ad2e --- /dev/null +++ b/functions/toUpperCase.html @@ -0,0 +1,171 @@ +toUpperCase | extra-string
+
+ +
+
+
+
+ +

Function toUpperCase

+
+
    + +
  • +

    Convert string to upper case.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    upper cased string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/trim.html b/functions/trim.html new file mode 100644 index 0000000..4b8a9b0 --- /dev/null +++ b/functions/trim.html @@ -0,0 +1,171 @@ +trim | extra-string
+
+ +
+
+
+
+ +

Function trim

+
+
    + +
  • +

    Remove whitespace from begining and end of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    trimmed string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/trimEnd.html b/functions/trimEnd.html new file mode 100644 index 0000000..936c54d --- /dev/null +++ b/functions/trimEnd.html @@ -0,0 +1,171 @@ +trimEnd | extra-string
+
+ +
+
+
+
+ +

Function trimEnd

+
+
    + +
  • +

    Remove whitespace from end of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    trimmed string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/trimStart.html b/functions/trimStart.html new file mode 100644 index 0000000..94dfa7b --- /dev/null +++ b/functions/trimStart.html @@ -0,0 +1,171 @@ +trimStart | extra-string
+
+ +
+
+
+
+ +

Function trimStart

+
+
    + +
  • +

    Remove whitespace from begining of string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
    +

    Returns string

    trimmed string

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/tverskyDistance.html b/functions/tverskyDistance.html new file mode 100644 index 0000000..abf4d01 --- /dev/null +++ b/functions/tverskyDistance.html @@ -0,0 +1,191 @@ +tverskyDistance | extra-string
+
+ +
+
+
+
+ +

Function tverskyDistance

+
+
    + +
  • +

    Get Tversky distance between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
      • +
    • +
      a: number = 1
      +

      alpha [1]

      +
      +
      • +
    • +
      b: number = 1
      +

      beta [1]

      +
      +
    +

    Returns number

    1 - tverskyIndex(x, y)

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/tverskyIndex.html b/functions/tverskyIndex.html new file mode 100644 index 0000000..6ae0073 --- /dev/null +++ b/functions/tverskyIndex.html @@ -0,0 +1,191 @@ +tverskyIndex | extra-string
+
+ +
+
+
+
+ +

Function tverskyIndex

+
+
    + +
  • +

    Get Tversky index between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
      • +
    • +
      a: number = 1
      +

      alpha [1]

      +
      +
      • +
    • +
      b: number = 1
      +

      beta [1]

      +
      +
    +

    Returns number

    |X ∩ Y|/(|X ∩ Y| + α|X \ Y| + β|Y \ X|) | X,Y = n-grams of x,y

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/uniqueMatchingNgrams.html b/functions/uniqueMatchingNgrams.html new file mode 100644 index 0000000..9cb7736 --- /dev/null +++ b/functions/uniqueMatchingNgrams.html @@ -0,0 +1,181 @@ +uniqueMatchingNgrams | extra-string
+
+ +
+
+
+
+ +

Function uniqueMatchingNgrams

+
+
    + +
  • +

    Get unique matching n-grams between strings.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      y: string
      +

      another string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns Set<string>

    Set {gᵢ} | gᵢ = iᵗʰ unique matching n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/uniqueNgrams.html b/functions/uniqueNgrams.html new file mode 100644 index 0000000..316a5d7 --- /dev/null +++ b/functions/uniqueNgrams.html @@ -0,0 +1,176 @@ +uniqueNgrams | extra-string
+
+ +
+
+
+
+ +

Function uniqueNgrams

+
+
    + +
  • +

    Find unique n-grams of a string.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string

      +
      +
      • +
    • +
      n: number
      +

      n-gram length

      +
      +
    +

    Returns Set<string>

    Set {gᵢ} | gᵢ = iᵗʰ n-gram

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/functions/valueOf.html b/functions/valueOf.html new file mode 100644 index 0000000..2b51894 --- /dev/null +++ b/functions/valueOf.html @@ -0,0 +1,171 @@ +valueOf | extra-string
+
+ +
+
+
+
+ +

Function valueOf

+
+
    + +
  • +

    Get primitive value of string object.

    +
    +
    +

    Parameters

    +
      +
    • +
      x: string
      +

      a string object

      +
      +
    +

    Returns string

    primitive value

    + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..c09292e --- /dev/null +++ b/index.html @@ -0,0 +1,725 @@ +extra-string
+
+ +
+
+
+
+

extra-string

+

A collection of common string functions.
+📦 Node.js, +🌐 Web, +📜 Files, +📰 Docs.

+

A string is a sequence of characters. In JavaScript, strings are not +mutable. Any transfomation of a string, such as slice or concat +generates a new string. The JavaScript runtime however may optimize this +behavior by mutating strings behind the scenes, when it can be guarenteed that +the previous string is not accessible to the programmer. The runtime may +also avoid copying slices of a string, or even concatenation of slices of +strings, by implementing it as a series of lookups into existing strings. +Food for thought.

+

This package provides functions for generating spaces; querying about a +string such as is, isEmpty, isCharacter, index, indexRange, +codePointRange; comparing strings such as compare, isEqual; getting +parts of a string such as get, getAll, set, begin, middle, end; +searching a string such as longestCommonInfix, longestCommonPrefix, +longestCommonSuffix, longestUncommonInfixes; transforming a string such +as toBaseline, toSuperscript, toSubscript; transforming case of a +string such as toKebabCase, toSnakeCase, toCamelCase, toPascalCase; +finding ngrams in strings such as ngrams, uniqueNgrams, countNgrams, +countUniqueNgrams, countEachNgram, matchingNgrams, uniqueMatchingNgrams, +countMatchingNgrams, countEachMatchingNgram, countUniqueMatchingNgrams; +and finding similarity/distance between strings such as euclideanDistance, +hammingDistance, jaccardIndex, jaccardDistance, sorensenDiceIndex, +sorensenDiceDistance, tverskyIndex, tverskyDistance, jaroSimilarity, +jaroDistance, jaroWinklerSimilarity, jaroWinklerDistance, +levenshteinDistance, damerauLevenshteinDistance.

+

This package also provides Array-like functions for strings. These includes +functions for generating a string such as of, from; transforming a +string such as splice, reverse, sort; and functional behavior such as +filter. All built-in string functions are also included. Finally, +constants for ASCII characters, and minimum/maximum code point are +included.

+

This package is available in both Node.js and Web formats. The web format +is exposed as extra_string standalone variable and can be loaded from +jsDelivr CDN.

+
+

Stability: Experimental.

+
+
+ + +
const string = require('extra-string');
// import * as string from "extra-string";
// import * as string from "https://unpkg.com/extra-string/index.mjs"; (deno)

string.longestCommonInfix('dismiss', 'mississipi');
// → 'miss'

string.longestUncommonInfixes('chocolatier', 'engineer');
// → ['chocolati', 'engine']

string.toKebabCase('Malwa Plateau');
// → 'malwa-plateau'

'6.626 x 10' + string.toSuperscript('-34');
// → '6.626 x 10⁻³⁴' (Planck's constant)

string.tverskyDistance('pikachu', 'raichu', 3, 0.2, 0.4);
// → 0.6666666666666667
+
+
+
+ + +

Index

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
DIGITSDecimal digits 0-9.
OCT_DIGITSOctal digits 0-7.
HEX_DIGITSHexadecimal digits 0-9, A-F, a-f.
UPPERCASEEnglish letters A-Z.
LOWERCASEEnglish letters a-z.
LETTERSCombination of uppercase, lowercase english letters.
PUNCTUATIONPunctuation symbols (ASCII).
WHITESPACEThe string "\t\n\x0b\x0c\r ".
PRINTABLECombination of digits, letters, punctuation, and whitespace (ASCII).
MIN_CODE_POINTMinimum unicode code point.
MAX_CODE_POINTMaximum unicode code point.
fromCharCodeGet characters whose UTF-16 code units are given.
fromCodePointGet characters whose unicode code points are given.
concatCombine multiple strings into one.
repeatRepeat string given number of times.
valueOfGet primitive value of string object.
lengthGet length of string.
charAtGet character at given index in string.
charCodeAtGet UTF-16 code unit of a character in string.
codePointAtGet unicode code point of a character in string.
localeCompareCompare two strings in the current or given locale.
includesCheck if string has a given infix.
startsWithCheck if string has a given prefix.
endsWithCheck if string has a given suffix.
indexOfGet first index of a given infix in string.
lastIndexOfGet last index of a given infix in string.
searchGet first index of regular expression match in string.
matchGet results of matching string with regular expression.
matchAllGet detailed results of matching string with regular expression.
toStringGet string representation of string.
sliceExtract section of string.
substringExtract section of string.
splitSplit string by a given separator into substrings.
trimStartRemove whitespace from begining of string.
trimEndRemove whitespace from end of string.
trimRemove whitespace from begining and end of string.
padStartPad start of string to fit a desired length.
padEndPad end of string to fit a desired length.
toUpperCaseConvert string to upper case.
toLocaleUpperCaseConvert string to upper case, as per locale-specific case mappings.
toLowerCaseConvert string to lower case.
toLocaleLowerCaseConvert string to lower case, as per locale-specific case mappings.
replaceReplace first match of given pattern by replacement.
normalizeNormalize string by given form, as per Unicode Standard Annex #15.
ofCreate string from arguments, like Array.of().
fromCreate string from iterable, like Array.from().
spliceRemove/replace characters in a string.
reverseReverse a string.
sortArrange characters in an order.
filterFilter characters which pass a test.
spacesGet a string of spaces.
isCheck if value is a string.
isEmptyCheck if string is empty.
isCharacterCheck if string is a character.
indexGet non-negative index within string.
indexRangeGet non-negative index range within string.
codePointRangeGet unicode code point range of string.
compareCompare two strings.
isEqualCheck if two strings are equal.
getGet character at a given index in string.
getAllGet characters at indices.
setWrite a substring at specified index in string.
beginGet leftmost part of string.
middleGet a portion of string from middle.
endGet rightmost part of string.
longestCommonInfixGet the longest common infix between strings.
longestCommonPrefixGet the longest common prefix of strings.
longestCommonSuffixGet the longest common suffix of strings.
longestUncommonInfixesGet the longest uncommon infixes of strings.
toBaselineConvert a string to baseline characters (limited support).
toSuperscriptConvert a string to superscript characters (limited support).
toSubscriptConvert a string to superscript characters (limited support).
toKebabCaseConvert a string to kebab-case.
toSnakeCaseConvert a string to snake-case.
toCamelCaseConvert a string to camel-case.
toPascalCaseConvert a string to pascal-case.
ngramsGet n-grams of a string.
uniqueNgramsFind unique n-grams of a string.
countNgramsCount the total number of n-grams of a string.
countUniqueNgramsCount the total number of unique n-grams of a string.
countEachNgramCount each n-gram of a string.
matchingNgramsGet matching n-grams between strings.
uniqueMatchingNgramsGet unique matching n-grams between strings.
countMatchingNgramsCount the total number of matching n-grams between strings.
countEachMatchingNgramCount each matching n-gram between strings.
countUniqueMatchingNgramsCount the total number of unique matching n-grams between strings.
euclideanDistanceGet euclidean distance between strings.
hammingDistanceGet hamming distance between strings.
jaccardIndexGet jaccard index between strings.
jaccardDistanceGet jaccard distance between strings.
sorensenDiceIndexGet Sørensen-Dice index between strings.
sorensenDiceDistanceGet Sørensen-Dice distance between strings.
tverskyIndexGet Tversky index between strings.
tverskyDistanceGet Tversky distance between strings.
jaroSimilarityGet Jaro similarity between strings.
jaroDistanceGet Jaro distance between strings.
jaroWinklerSimilarityGet Jaro-Winkler similarity between strings.
jaroWinklerDistanceGet Jaro-Winkler distance between strings.
levenshteinDistanceGet Levenshtein distance between strings.
damerauLevenshteinDistanceGet Damerau–Levenshtein distance between strings.
+
+
+ + +

References

+
+
+ + +


+ORG +DOI +Coverage Status +Test Coverage +Maintainability

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/modules.html b/modules.html new file mode 100644 index 0000000..f5baa5b --- /dev/null +++ b/modules.html @@ -0,0 +1,316 @@ +extra-string
+
+ +
+
+
+
+

extra-string

+
+
+
+ +
+
+

References

+
at +infix +isInfix +isPrefix +isSuffix +left +prefix +right +size +suffix +
+
+

Type Aliases

+
CompareFunction +MapFunction +ReplaceFunction +TestFunction +
+
+

Variables

+
DIGITS +HEX_DIGITS +LETTERS +LOWERCASE +MAX_CODE_POINT +MIN_CODE_POINT +OCT_DIGITS +PRINTABLE +PUNCTUATION +UPPERCASE +WHITESPACE +
+
+

Functions

+
begin +charAt +charCodeAt +codePointAt +codePointRange +compare +concat +countEachMatchingNgram +countEachNgram +countMatchingNgrams +countNgrams +countUniqueMatchingNgrams +countUniqueNgrams +damerauLevenshteinDistance +end +endsWith +euclideanDistance +filter +from +fromCharCode +fromCodePoint +get +getAll +hammingDistance +includes +index +indexOf +indexRange +is +isCharacter +isEmpty +isEqual +jaccardDistance +jaccardIndex +jaroDistance +jaroSimilarity +jaroWinklerDistance +jaroWinklerSimilarity +lastIndexOf +length +levenshteinDistance +localeCompare +longestCommonInfix +longestCommonPrefix +longestCommonSuffix +longestUncommonInfixes +match +matchAll +matchingNgrams +middle +ngrams +normalize +of +padEnd +padStart +repeat +replace +reverse +search +set +slice +sorensenDiceDistance +sorensenDiceIndex +sort +spaces +splice +split +startsWith +substring +toBaseline +toCamelCase +toKebabCase +toLocaleLowerCase +toLocaleUpperCase +toLowerCase +toPascalCase +toSnakeCase +toString +toSubscript +toSuperscript +toUpperCase +trim +trimEnd +trimStart +tverskyDistance +tverskyIndex +uniqueMatchingNgrams +uniqueNgrams +valueOf +
+
+

References

+
+

at

Renames and re-exports get
+
+

infix

Renames and re-exports middle
+
+

isInfix

Renames and re-exports includes
+
+

isPrefix

Renames and re-exports startsWith
+
+

isSuffix

Renames and re-exports endsWith
+
+

left

Renames and re-exports begin
+
+

prefix

Renames and re-exports begin
+
+

right

Renames and re-exports end
+
+

size

Renames and re-exports length
+
+

suffix

Renames and re-exports end
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+

On This Page

 +
+
+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/CompareFunction.html b/types/CompareFunction.html new file mode 100644 index 0000000..be31ab8 --- /dev/null +++ b/types/CompareFunction.html @@ -0,0 +1,180 @@ +CompareFunction | extra-string
+
+ +
+
+
+
+ +

Type alias CompareFunction

+
CompareFunction: ((a, b) => number)
+
+

Type declaration

+
    +
  • +
      +
    • (a, b): number
      • +
    • +

      Handle comparison of two strings.

      +
      +
      +

      Parameters

      +
        +
      • +
        a: string
        +

        a string

        +
        +
        • +
      • +
        b: string
        +

        another string

        +
        +
      +

      Returns number

      x<y: -ve, x=y: 0, x>y: +ve

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/MapFunction.html b/types/MapFunction.html new file mode 100644 index 0000000..d2bd4d5 --- /dev/null +++ b/types/MapFunction.html @@ -0,0 +1,185 @@ +MapFunction | extra-string
+
+ +
+
+
+
+ +

Type alias MapFunction

+
MapFunction: ((v, i, x?) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (v, i, x?): string
      • +
    • +

      Handle transformation of a substring (or character) to another.

      +
      +
      +

      Parameters

      +
        +
      • +
        v: string
        +

        a substring (or character)

        +
        +
        • +
      • +
        i: number
        +

        index of substring

        +
        +
        • +
      • +
        Optional x: string
        +

        string containing the substring

        +
        +
      +

      Returns string

      transformed substring

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/ReplaceFunction.html b/types/ReplaceFunction.html new file mode 100644 index 0000000..d398a5d --- /dev/null +++ b/types/ReplaceFunction.html @@ -0,0 +1,173 @@ +ReplaceFunction | extra-string
+
+ +
+
+
+
+ +

Type alias ReplaceFunction

+
ReplaceFunction: ((substring, ...args) => string)
+
+

Type declaration

+
    +
  • +
      +
    • (substring, ...args): string
      • +
    • +

      Handle replacement of matched string and parameters with another string.

      +
      +
      +

      Parameters

      +
        +
      • +
        substring: string
        • +
      • +
        Rest ...args: any[]
      +

      Returns string

      +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/types/TestFunction.html b/types/TestFunction.html new file mode 100644 index 0000000..92a96ab --- /dev/null +++ b/types/TestFunction.html @@ -0,0 +1,185 @@ +TestFunction | extra-string
+
+ +
+
+
+
+ +

Type alias TestFunction

+
TestFunction: ((v, i, x) => boolean)
+
+

Type declaration

+
    +
  • +
      +
    • (v, i, x): boolean
      • +
    • +

      Handle selection of a substring (or character) in string.

      +
      +
      +

      Parameters

      +
        +
      • +
        v: string
        +

        a substring (or character)

        +
        +
        • +
      • +
        i: number
        +

        index of substring in string

        +
        +
        • +
      • +
        x: string
        +

        string containing the substring

        +
        +
      +

      Returns boolean

      whether it is selected

      + +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/DIGITS.html b/variables/DIGITS.html new file mode 100644 index 0000000..2d44588 --- /dev/null +++ b/variables/DIGITS.html @@ -0,0 +1,158 @@ +DIGITS | extra-string
+
+ +
+
+
+
+ +

Variable DIGITSConst

+
DIGITS: string = "0123456789"
+

Decimal digits 0-9.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/HEX_DIGITS.html b/variables/HEX_DIGITS.html new file mode 100644 index 0000000..48bdb33 --- /dev/null +++ b/variables/HEX_DIGITS.html @@ -0,0 +1,158 @@ +HEX_DIGITS | extra-string
+
+ +
+
+
+
+ +

Variable HEX_DIGITSConst

+
HEX_DIGITS: string = "0123456789ABCDEFabcdef"
+

Hexadecimal digits 0-9, A-F, a-f.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/LETTERS.html b/variables/LETTERS.html new file mode 100644 index 0000000..8164aec --- /dev/null +++ b/variables/LETTERS.html @@ -0,0 +1,158 @@ +LETTERS | extra-string
+
+ +
+
+
+
+ +

Variable LETTERSConst

+
LETTERS: string = ...
+

Combination of uppercase, lowercase english letters.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/LOWERCASE.html b/variables/LOWERCASE.html new file mode 100644 index 0000000..f4c4601 --- /dev/null +++ b/variables/LOWERCASE.html @@ -0,0 +1,158 @@ +LOWERCASE | extra-string
+
+ +
+
+
+
+ +

Variable LOWERCASEConst

+
LOWERCASE: string = "abcdefghijklmnopqrstuvwxyz"
+

English letters a-z.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/MAX_CODE_POINT.html b/variables/MAX_CODE_POINT.html new file mode 100644 index 0000000..0ab97b4 --- /dev/null +++ b/variables/MAX_CODE_POINT.html @@ -0,0 +1,158 @@ +MAX_CODE_POINT | extra-string
+
+ +
+
+
+
+ +

Variable MAX_CODE_POINTConst

+
MAX_CODE_POINT: number = 0x10FFFF
+

Maximum unicode code point.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/MIN_CODE_POINT.html b/variables/MIN_CODE_POINT.html new file mode 100644 index 0000000..2ad517b --- /dev/null +++ b/variables/MIN_CODE_POINT.html @@ -0,0 +1,158 @@ +MIN_CODE_POINT | extra-string
+
+ +
+
+
+
+ +

Variable MIN_CODE_POINTConst

+
MIN_CODE_POINT: number = 0x000000
+

Minimum unicode code point.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/OCT_DIGITS.html b/variables/OCT_DIGITS.html new file mode 100644 index 0000000..561eb19 --- /dev/null +++ b/variables/OCT_DIGITS.html @@ -0,0 +1,158 @@ +OCT_DIGITS | extra-string
+
+ +
+
+
+
+ +

Variable OCT_DIGITSConst

+
OCT_DIGITS: string = "01234567"
+

Octal digits 0-7.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/PRINTABLE.html b/variables/PRINTABLE.html new file mode 100644 index 0000000..585b622 --- /dev/null +++ b/variables/PRINTABLE.html @@ -0,0 +1,158 @@ +PRINTABLE | extra-string
+
+ +
+
+
+
+ +

Variable PRINTABLEConst

+
PRINTABLE: string = ...
+

Combination of digits, letters, punctuation, and whitespace (ASCII).

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/PUNCTUATION.html b/variables/PUNCTUATION.html new file mode 100644 index 0000000..a788fd4 --- /dev/null +++ b/variables/PUNCTUATION.html @@ -0,0 +1,158 @@ +PUNCTUATION | extra-string
+
+ +
+
+
+
+ +

Variable PUNCTUATIONConst

+
PUNCTUATION: string = "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+

Punctuation symbols (ASCII).

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/UPPERCASE.html b/variables/UPPERCASE.html new file mode 100644 index 0000000..53b2da5 --- /dev/null +++ b/variables/UPPERCASE.html @@ -0,0 +1,158 @@ +UPPERCASE | extra-string
+
+ +
+
+
+
+ +

Variable UPPERCASEConst

+
UPPERCASE: string = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+

English letters A-Z.

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/variables/WHITESPACE.html b/variables/WHITESPACE.html new file mode 100644 index 0000000..fff5033 --- /dev/null +++ b/variables/WHITESPACE.html @@ -0,0 +1,158 @@ +WHITESPACE | extra-string
+
+ +
+
+
+
+ +

Variable WHITESPACEConst

+
WHITESPACE: string = "\t\n\x0b\x0c\r "
+

The string "\t\n\x0b\x0c\r ".

+
+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
    • +
+
+

Theme

+
+
+
+

Generated using TypeDoc

+
\ No newline at end of file