+1

.nojekyll

Reviewed

··· 1 1 + TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

+85

assets/highlight.css

Reviewed

··· 1 1 + :root { 2 2 + --light-hl-0: #001080; 3 3 + --dark-hl-0: #9CDCFE; 4 4 + --light-hl-1: #000000; 5 5 + --dark-hl-1: #D4D4D4; 6 6 + --light-hl-2: #AF00DB; 7 7 + --dark-hl-2: #C586C0; 8 8 + --light-hl-3: #A31515; 9 9 + --dark-hl-3: #CE9178; 10 10 + --light-hl-4: #795E26; 11 11 + --dark-hl-4: #DCDCAA; 12 12 + --light-hl-5: #098658; 13 13 + --dark-hl-5: #B5CEA8; 14 14 + --light-hl-6: #008000; 15 15 + --dark-hl-6: #6A9955; 16 16 + --light-hl-7: #0000FF; 17 17 + --dark-hl-7: #569CD6; 18 18 + --light-hl-8: #267F99; 19 19 + --dark-hl-8: #4EC9B0; 20 20 + --light-code-background: #FFFFFF; 21 21 + --dark-code-background: #1E1E1E; 22 22 + } 23 23 + 24 24 + @media (prefers-color-scheme: light) { :root { 25 25 + --hl-0: var(--light-hl-0); 26 26 + --hl-1: var(--light-hl-1); 27 27 + --hl-2: var(--light-hl-2); 28 28 + --hl-3: var(--light-hl-3); 29 29 + --hl-4: var(--light-hl-4); 30 30 + --hl-5: var(--light-hl-5); 31 31 + --hl-6: var(--light-hl-6); 32 32 + --hl-7: var(--light-hl-7); 33 33 + --hl-8: var(--light-hl-8); 34 34 + --code-background: var(--light-code-background); 35 35 + } } 36 36 + 37 37 + @media (prefers-color-scheme: dark) { :root { 38 38 + --hl-0: var(--dark-hl-0); 39 39 + --hl-1: var(--dark-hl-1); 40 40 + --hl-2: var(--dark-hl-2); 41 41 + --hl-3: var(--dark-hl-3); 42 42 + --hl-4: var(--dark-hl-4); 43 43 + --hl-5: var(--dark-hl-5); 44 44 + --hl-6: var(--dark-hl-6); 45 45 + --hl-7: var(--dark-hl-7); 46 46 + --hl-8: var(--dark-hl-8); 47 47 + --code-background: var(--dark-code-background); 48 48 + } } 49 49 + 50 50 + :root[data-theme='light'] { 51 51 + --hl-0: var(--light-hl-0); 52 52 + --hl-1: var(--light-hl-1); 53 53 + --hl-2: var(--light-hl-2); 54 54 + --hl-3: var(--light-hl-3); 55 55 + --hl-4: var(--light-hl-4); 56 56 + --hl-5: var(--light-hl-5); 57 57 + --hl-6: var(--light-hl-6); 58 58 + --hl-7: var(--light-hl-7); 59 59 + --hl-8: var(--light-hl-8); 60 60 + --code-background: var(--light-code-background); 61 61 + } 62 62 + 63 63 + :root[data-theme='dark'] { 64 64 + --hl-0: var(--dark-hl-0); 65 65 + --hl-1: var(--dark-hl-1); 66 66 + --hl-2: var(--dark-hl-2); 67 67 + --hl-3: var(--dark-hl-3); 68 68 + --hl-4: var(--dark-hl-4); 69 69 + --hl-5: var(--dark-hl-5); 70 70 + --hl-6: var(--dark-hl-6); 71 71 + --hl-7: var(--dark-hl-7); 72 72 + --hl-8: var(--dark-hl-8); 73 73 + --code-background: var(--dark-code-background); 74 74 + } 75 75 + 76 76 + .hl-0 { color: var(--hl-0); } 77 77 + .hl-1 { color: var(--hl-1); } 78 78 + .hl-2 { color: var(--hl-2); } 79 79 + .hl-3 { color: var(--hl-3); } 80 80 + .hl-4 { color: var(--hl-4); } 81 81 + .hl-5 { color: var(--hl-5); } 82 82 + .hl-6 { color: var(--hl-6); } 83 83 + .hl-7 { color: var(--hl-7); } 84 84 + .hl-8 { color: var(--hl-8); } 85 85 + pre, code { background: var(--code-background); }

+58

assets/main.js

Reviewed

··· 1 1 + "use strict"; 2 2 + "use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i<r.length;i++){var s=r[i],o=e[s];if(Array.isArray(o)){n[s]=o.slice();continue}if(typeof o=="string"||typeof o=="number"||typeof o=="boolean"){n[s]=o;continue}throw new TypeError("clone is not deep and does not support nested objects")}return n},t.FieldRef=function(e,n,r){this.docRef=e,this.fieldName=n,this._stringValue=r},t.FieldRef.joiner="/",t.FieldRef.fromString=function(e){var n=e.indexOf(t.FieldRef.joiner);if(n===-1)throw"malformed field ref string";var r=e.slice(0,n),i=e.slice(n+1);return new t.FieldRef(i,r,e)},t.FieldRef.prototype.toString=function(){return this._stringValue==null&&(this._stringValue=this.fieldName+t.FieldRef.joiner+this.docRef),this._stringValue};t.Set=function(e){if(this.elements=Object.create(null),e){this.length=e.length;for(var n=0;n<this.length;n++)this.elements[e[n]]=!0}else this.length=0},t.Set.complete={intersect:function(e){return e},union:function(){return this},contains:function(){return!0}},t.Set.empty={intersect:function(){return this},union:function(e){return e},contains:function(){return!1}},t.Set.prototype.contains=function(e){return!!this.elements[e]},t.Set.prototype.intersect=function(e){var n,r,i,s=[];if(e===t.Set.complete)return this;if(e===t.Set.empty)return e;this.length<e.length?(n=this,r=e):(n=e,r=this),i=Object.keys(n.elements);for(var o=0;o<i.length;o++){var a=i[o];a in r.elements&&s.push(a)}return new t.Set(s)},t.Set.prototype.union=function(e){return e===t.Set.complete?t.Set.complete:e===t.Set.empty?this:new t.Set(Object.keys(this.elements).concat(Object.keys(e.elements)))},t.idf=function(e,n){var r=0;for(var i in e)i!="_index"&&(r+=Object.keys(e[i]).length);var s=(n-r+.5)/(r+.5);return Math.log(1+Math.abs(s))},t.Token=function(e,n){this.str=e||"",this.metadata=n||{}},t.Token.prototype.toString=function(){return this.str},t.Token.prototype.update=function(e){return this.str=e(this.str,this.metadata),this},t.Token.prototype.clone=function(e){return e=e||function(n){return n},new t.Token(e(this.str,this.metadata),this.metadata)};t.tokenizer=function(e,n){if(e==null||e==null)return[];if(Array.isArray(e))return e.map(function(m){return new t.Token(t.utils.asString(m).toLowerCase(),t.utils.clone(n))});for(var r=e.toString().toLowerCase(),i=r.length,s=[],o=0,a=0;o<=i;o++){var u=r.charAt(o),l=o-a;if(u.match(t.tokenizer.separator)||o==i){if(l>0){var h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. 3 3 + `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r<n;r++){for(var i=this._stack[r],s=[],o=0;o<e.length;o++){var a=i(e[o],o,e);if(!(a==null||a===""))if(Array.isArray(a))for(var u=0;u<a.length;u++)s.push(a[u]);else s.push(a)}e=s}return e},t.Pipeline.prototype.runString=function(e,n){var r=new t.Token(e,n);return this.run([r]).map(function(i){return i.toString()})},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})};t.Vector=function(e){this._magnitude=0,this.elements=e||[]},t.Vector.prototype.positionForIndex=function(e){if(this.elements.length==0)return 0;for(var n=0,r=this.elements.length/2,i=r-n,s=Math.floor(i/2),o=this.elements[s*2];i>1&&(o<e&&(n=s),o>e&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(o<e)return(s+1)*2},t.Vector.prototype.insert=function(e,n){this.upsert(e,n,function(){throw"duplicate index"})},t.Vector.prototype.upsert=function(e,n,r){this._magnitude=0;var i=this.positionForIndex(e);this.elements[i]==e?this.elements[i+1]=r(this.elements[i+1],n):this.elements.splice(i,0,e,n)},t.Vector.prototype.magnitude=function(){if(this._magnitude)return this._magnitude;for(var e=0,n=this.elements.length,r=1;r<n;r+=2){var i=this.elements[r];e+=i*i}return this._magnitude=Math.sqrt(e)},t.Vector.prototype.dot=function(e){for(var n=0,r=this.elements,i=e.elements,s=r.length,o=i.length,a=0,u=0,l=0,h=0;l<s&&h<o;)a=r[l],u=i[h],a<u?l+=2:a>u?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n<this.elements.length;n+=2,r++)e[r]=this.elements[n];return e},t.Vector.prototype.toJSON=function(){return this.elements};t.stemmer=function(){var e={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},n={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},r="[^aeiou]",i="[aeiouy]",s=r+"[^aeiouy]*",o=i+"[aeiou]*",a="^("+s+")?"+o+s,u="^("+s+")?"+o+s+"("+o+")?$",l="^("+s+")?"+o+s+o+s,h="^("+s+")?"+i,m=new RegExp(a),v=new RegExp(l),b=new RegExp(u),y=new RegExp(h),E=/^(.+?)(ss|i)es$/,p=/^(.+?)([^s])s$/,f=/^(.+?)eed$/,S=/^(.+?)(ed|ing)$/,w=/.$/,k=/(at|bl|iz)$/,_=new RegExp("([^aeiouylsz])\\1$"),z=new RegExp("^"+s+i+"[^aeiouwxy]$"),H=/^(.+?[^aeiou])y$/,q=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,$=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,V=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,W=/^(.+?)(s|t)(ion)$/,P=/^(.+?)e$/,U=/ll$/,G=new RegExp("^"+s+i+"[^aeiouwxy]$"),N=function(c){var g,C,T,d,x,O,D;if(c.length<3)return c;if(T=c.substr(0,1),T=="y"&&(c=T.toUpperCase()+c.substr(1)),d=E,x=p,d.test(c)?c=c.replace(d,"$1$2"):x.test(c)&&(c=c.replace(x,"$1$2")),d=f,x=S,d.test(c)){var L=d.exec(c);d=m,d.test(L[1])&&(d=w,c=c.replace(d,""))}else if(x.test(c)){var L=x.exec(c);g=L[1],x=y,x.test(g)&&(c=g,x=k,O=_,D=z,x.test(c)?c=c+"e":O.test(c)?(d=w,c=c.replace(d,"")):D.test(c)&&(c=c+"e"))}if(d=H,d.test(c)){var L=d.exec(c);g=L[1],c=g+"i"}if(d=q,d.test(c)){var L=d.exec(c);g=L[1],C=L[2],d=m,d.test(g)&&(c=g+e[C])}if(d=$,d.test(c)){var L=d.exec(c);g=L[1],C=L[2],d=m,d.test(g)&&(c=g+n[C])}if(d=V,x=W,d.test(c)){var L=d.exec(c);g=L[1],d=v,d.test(g)&&(c=g)}else if(x.test(c)){var L=x.exec(c);g=L[1]+L[2],x=v,x.test(g)&&(c=g)}if(d=P,d.test(c)){var L=d.exec(c);g=L[1],d=v,x=b,O=G,(d.test(g)||x.test(g)&&!O.test(g))&&(c=g)}return d=U,x=v,d.test(c)&&x.test(c)&&(d=w,c=c.replace(d,"")),T=="y"&&(c=T.toLowerCase()+c.substr(1)),c};return function(M){return M.update(N)}}(),t.Pipeline.registerFunction(t.stemmer,"stemmer");t.generateStopWordFilter=function(e){var n=e.reduce(function(r,i){return r[i]=i,r},{});return function(r){if(r&&n[r.toString()]!==r.toString())return r}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter");t.trimmer=function(e){return e.update(function(n){return n.replace(/^\W+/,"").replace(/\W+$/,"")})},t.Pipeline.registerFunction(t.trimmer,"trimmer");t.TokenSet=function(){this.final=!1,this.edges={},this.id=t.TokenSet._nextId,t.TokenSet._nextId+=1},t.TokenSet._nextId=1,t.TokenSet.fromArray=function(e){for(var n=new t.TokenSet.Builder,r=0,i=e.length;r<i;r++)n.insert(e[r]);return n.finish(),n.root},t.TokenSet.fromClause=function(e){return"editDistance"in e?t.TokenSet.fromFuzzyString(e.term,e.editDistance):t.TokenSet.fromString(e.term)},t.TokenSet.fromFuzzyString=function(e,n){for(var r=new t.TokenSet,i=[{node:r,editsRemaining:n,str:e}];i.length;){var s=i.pop();if(s.str.length>0){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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i<s;i++){var o=e[i],a=i==s-1;if(o=="*")n.edges[o]=n,n.final=a;else{var u=new t.TokenSet;u.final=a,n.edges[o]=u,n=u}}return r},t.TokenSet.prototype.toArray=function(){for(var e=[],n=[{prefix:"",node:this}];n.length;){var r=n.pop(),i=Object.keys(r.node.edges),s=i.length;r.node.final&&(r.prefix.charAt(0),e.push(r.prefix));for(var o=0;o<s;o++){var a=i[o];n.push({prefix:r.prefix.concat(a),node:r.node.edges[a]})}}return e},t.TokenSet.prototype.toString=function(){if(this._str)return this._str;for(var e=this.final?"1":"0",n=Object.keys(this.edges).sort(),r=n.length,i=0;i<r;i++){var s=n[i],o=this.edges[s];e=e+s+o.id}return e},t.TokenSet.prototype.intersect=function(e){for(var n=new t.TokenSet,r=void 0,i=[{qNode:e,output:n,node:this}];i.length;){r=i.pop();for(var s=Object.keys(r.qNode.edges),o=s.length,a=Object.keys(r.node.edges),u=a.length,l=0;l<o;l++)for(var h=s[l],m=0;m<u;m++){var v=a[m];if(v==h||h=="*"){var b=r.node.edges[v],y=r.qNode.edges[h],E=b.final&&y.final,p=void 0;v in r.output.edges?(p=r.output.edges[v],p.final=p.final||E):(p=new t.TokenSet,p.final=E,r.output.edges[v]=p),i.push({qNode:y,output:p,node:b})}}}return n},t.TokenSet.Builder=function(){this.previousWord="",this.root=new t.TokenSet,this.uncheckedNodes=[],this.minimizedNodes={}},t.TokenSet.Builder.prototype.insert=function(e){var n,r=0;if(e<this.previousWord)throw new Error("Out of order word insertion");for(var i=0;i<e.length&&i<this.previousWord.length&&e[i]==this.previousWord[i];i++)r++;this.minimize(r),this.uncheckedNodes.length==0?n=this.root:n=this.uncheckedNodes[this.uncheckedNodes.length-1].child;for(var i=r;i<e.length;i++){var s=new t.TokenSet,o=e[i];n.edges[o]=s,this.uncheckedNodes.push({parent:n,char:o,child:s}),n=s}n.final=!0,this.previousWord=e},t.TokenSet.Builder.prototype.finish=function(){this.minimize(0)},t.TokenSet.Builder.prototype.minimize=function(e){for(var n=this.uncheckedNodes.length-1;n>=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u<this.fields.length;u++)i[this.fields[u]]=new t.Vector;e.call(n,n);for(var u=0;u<n.clauses.length;u++){var l=n.clauses[u],h=null,m=t.Set.empty;l.usePipeline?h=this.pipeline.runString(l.term,{fields:l.fields}):h=[l.term];for(var v=0;v<h.length;v++){var b=h[v];l.term=b;var y=t.TokenSet.fromClause(l),E=this.tokenSet.intersect(y).toArray();if(E.length===0&&l.presence===t.Query.presence.REQUIRED){for(var p=0;p<l.fields.length;p++){var f=l.fields[p];o[f]=t.Set.empty}break}for(var S=0;S<E.length;S++)for(var w=E[S],k=this.invertedIndex[w],_=k._index,p=0;p<l.fields.length;p++){var f=l.fields[p],z=k[f],H=Object.keys(z),q=w+"/"+f,$=new t.Set(H);if(l.presence==t.Query.presence.REQUIRED&&(m=m.union($),o[f]===void 0&&(o[f]=t.Set.complete)),l.presence==t.Query.presence.PROHIBITED){a[f]===void 0&&(a[f]=t.Set.empty),a[f]=a[f].union($);continue}if(i[f].upsert(_,l.boost,function(Ie,ke){return Ie+ke}),!s[q]){for(var V=0;V<H.length;V++){var W=H[V],P=new t.FieldRef(W,f),U=z[W],G;(G=r[P])===void 0?r[P]=new t.MatchData(w,f,U):G.add(w,f,U)}s[q]=!0}}}if(l.presence===t.Query.presence.REQUIRED)for(var p=0;p<l.fields.length;p++){var f=l.fields[p];o[f]=o[f].intersect(m)}}for(var N=t.Set.complete,M=t.Set.empty,u=0;u<this.fields.length;u++){var f=this.fields[u];o[f]&&(N=N.intersect(o[f])),a[f]&&(M=M.union(a[f]))}var c=Object.keys(r),g=[],C=Object.create(null);if(n.isNegated()){c=Object.keys(this.fieldVectors);for(var u=0;u<c.length;u++){var P=c[u],T=t.FieldRef.fromString(P);r[P]=new t.MatchData}}for(var u=0;u<c.length;u++){var T=t.FieldRef.fromString(c[u]),d=T.docRef;if(N.contains(d)&&!M.contains(d)){var x=this.fieldVectors[T],O=i[T.fieldName].similarity(x),D;if((D=C[d])!==void 0)D.score+=O,D.matchData.combine(r[T]);else{var L={ref:d,score:O,matchData:r[T]};C[d]=L,g.push(L)}}}return g.sort(function(Se,Te){return Te.score-Se.score})},t.Index.prototype.toJSON=function(){var e=Object.keys(this.invertedIndex).sort().map(function(r){return[r,this.invertedIndex[r]]},this),n=Object.keys(this.fieldVectors).map(function(r){return[r,this.fieldVectors[r].toJSON()]},this);return{version:t.version,fields:this.fields,fieldVectors:n,invertedIndex:e,pipeline:this.pipeline.toJSON()}},t.Index.load=function(e){var n={},r={},i=e.fieldVectors,s=Object.create(null),o=e.invertedIndex,a=new t.TokenSet.Builder,u=t.Pipeline.load(e.pipeline);e.version!=t.version&&t.utils.warn("Version mismatch when loading serialised index. Current version of lunr '"+t.version+"' does not match serialized index '"+e.version+"'");for(var l=0;l<i.length;l++){var h=i[l],m=h[0],v=h[1];r[m]=new t.Vector(v)}for(var l=0;l<o.length;l++){var h=o[l],b=h[0],y=h[1];a.insert(b),s[b]=y}return a.finish(),n.fields=e.fields,n.fieldVectors=r,n.invertedIndex=s,n.tokenSet=a.root,n.pipeline=u,new t.Index(n)};t.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=t.tokenizer,this.pipeline=new t.Pipeline,this.searchPipeline=new t.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},t.Builder.prototype.ref=function(e){this._ref=e},t.Builder.prototype.field=function(e,n){if(/\//.test(e))throw new RangeError("Field '"+e+"' contains illegal character '/'");this._fields[e]=n||{}},t.Builder.prototype.b=function(e){e<0?this._b=0:e>1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s<i.length;s++){var o=i[s],a=this._fields[o].extractor,u=a?a(e):e[o],l=this.tokenizer(u,{fields:[o]}),h=this.pipeline.run(l),m=new t.FieldRef(r,o),v=Object.create(null);this.fieldTermFrequencies[m]=v,this.fieldLengths[m]=0,this.fieldLengths[m]+=h.length;for(var b=0;b<h.length;b++){var y=h[b];if(v[y]==null&&(v[y]=0),v[y]+=1,this.invertedIndex[y]==null){var E=Object.create(null);E._index=this.termIndex,this.termIndex+=1;for(var p=0;p<i.length;p++)E[i[p]]=Object.create(null);this.invertedIndex[y]=E}this.invertedIndex[y][o][r]==null&&(this.invertedIndex[y][o][r]=Object.create(null));for(var f=0;f<this.metadataWhitelist.length;f++){var S=this.metadataWhitelist[f],w=y.metadata[S];this.invertedIndex[y][o][r][S]==null&&(this.invertedIndex[y][o][r][S]=[]),this.invertedIndex[y][o][r][S].push(w)}}}},t.Builder.prototype.calculateAverageFieldLengths=function(){for(var e=Object.keys(this.fieldLengths),n=e.length,r={},i={},s=0;s<n;s++){var o=t.FieldRef.fromString(e[s]),a=o.fieldName;i[a]||(i[a]=0),i[a]+=1,r[a]||(r[a]=0),r[a]+=this.fieldLengths[o]}for(var u=Object.keys(this._fields),s=0;s<u.length;s++){var l=u[s];r[l]=r[l]/i[l]}this.averageFieldLength=r},t.Builder.prototype.createFieldVectors=function(){for(var e={},n=Object.keys(this.fieldTermFrequencies),r=n.length,i=Object.create(null),s=0;s<r;s++){for(var o=t.FieldRef.fromString(n[s]),a=o.fieldName,u=this.fieldLengths[o],l=new t.Vector,h=this.fieldTermFrequencies[o],m=Object.keys(h),v=m.length,b=this._fields[a].boost||1,y=this._documents[o.docRef].boost||1,E=0;E<v;E++){var p=m[E],f=h[p],S=this.invertedIndex[p]._index,w,k,_;i[p]===void 0?(w=t.idf(this.invertedIndex[p],this.documentCount),i[p]=w):w=i[p],k=w*((this._k1+1)*f)/(this._k1*(1-this._b+this._b*(u/this.averageFieldLength[a]))+f),k*=b,k*=y,_=Math.round(k*1e3)/1e3,l.insert(S,_)}e[o]=l}this.fieldVectors=e},t.Builder.prototype.createTokenSet=function(){this.tokenSet=t.TokenSet.fromArray(Object.keys(this.invertedIndex).sort())},t.Builder.prototype.build=function(){return this.calculateAverageFieldLengths(),this.createFieldVectors(),this.createTokenSet(),new t.Index({invertedIndex:this.invertedIndex,fieldVectors:this.fieldVectors,tokenSet:this.tokenSet,fields:Object.keys(this._fields),pipeline:this.searchPipeline})},t.Builder.prototype.use=function(e){var n=Array.prototype.slice.call(arguments,1);n.unshift(this),e.apply(this,n)},t.MatchData=function(e,n,r){for(var i=Object.create(null),s=Object.keys(r||{}),o=0;o<s.length;o++){var a=s[o];i[a]=r[a].slice()}this.metadata=Object.create(null),e!==void 0&&(this.metadata[e]=Object.create(null),this.metadata[e][n]=i)},t.MatchData.prototype.combine=function(e){for(var n=Object.keys(e.metadata),r=0;r<n.length;r++){var i=n[r],s=Object.keys(e.metadata[i]);this.metadata[i]==null&&(this.metadata[i]=Object.create(null));for(var o=0;o<s.length;o++){var a=s[o],u=Object.keys(e.metadata[i][a]);this.metadata[i][a]==null&&(this.metadata[i][a]=Object.create(null));for(var l=0;l<u.length;l++){var h=u[l];this.metadata[i][a][h]==null?this.metadata[i][a][h]=e.metadata[i][a][h]:this.metadata[i][a][h]=this.metadata[i][a][h].concat(e.metadata[i][a][h])}}}},t.MatchData.prototype.add=function(e,n,r){if(!(e in this.metadata)){this.metadata[e]=Object.create(null),this.metadata[e][n]=r;return}if(!(n in this.metadata[e])){this.metadata[e][n]=r;return}for(var i=Object.keys(r),s=0;s<i.length;s++){var o=i[s];o in this.metadata[e][n]?this.metadata[e][n][o]=this.metadata[e][n][o].concat(r[o]):this.metadata[e][n][o]=r[o]}},t.Query=function(e){this.clauses=[],this.allFields=e},t.Query.wildcard=new String("*"),t.Query.wildcard.NONE=0,t.Query.wildcard.LEADING=1,t.Query.wildcard.TRAILING=2,t.Query.presence={OPTIONAL:1,REQUIRED:2,PROHIBITED:3},t.Query.prototype.clause=function(e){return"fields"in e||(e.fields=this.allFields),"boost"in e||(e.boost=1),"usePipeline"in e||(e.usePipeline=!0),"wildcard"in e||(e.wildcard=t.Query.wildcard.NONE),e.wildcard&t.Query.wildcard.LEADING&&e.term.charAt(0)!=t.Query.wildcard&&(e.term="*"+e.term),e.wildcard&t.Query.wildcard.TRAILING&&e.term.slice(-1)!=t.Query.wildcard&&(e.term=""+e.term+"*"),"presence"in e||(e.presence=t.Query.presence.OPTIONAL),this.clauses.push(e),this},t.Query.prototype.isNegated=function(){for(var e=0;e<this.clauses.length;e++)if(this.clauses[e].presence!=t.Query.presence.PROHIBITED)return!1;return!0},t.Query.prototype.term=function(e,n){if(Array.isArray(e))return e.forEach(function(i){this.term(i,t.utils.clone(n))},this),this;var r=n||{};return r.term=e.toString(),this.clause(r),this},t.QueryParseError=function(e,n,r){this.name="QueryParseError",this.message=e,this.start=n,this.end=r},t.QueryParseError.prototype=new Error,t.QueryLexer=function(e){this.lexemes=[],this.str=e,this.length=e.length,this.pos=0,this.start=0,this.escapeCharPositions=[]},t.QueryLexer.prototype.run=function(){for(var e=t.QueryLexer.lexText;e;)e=e(this)},t.QueryLexer.prototype.sliceString=function(){for(var e=[],n=this.start,r=this.pos,i=0;i<this.escapeCharPositions.length;i++)r=this.escapeCharPositions[i],e.push(this.str.slice(n,r)),n=r+1;return e.push(this.str.slice(n,this.pos)),this.escapeCharPositions.length=0,e.join("")},t.QueryLexer.prototype.emit=function(e){this.lexemes.push({type:e,str:this.sliceString(),start:this.start,end:this.pos}),this.start=this.pos},t.QueryLexer.prototype.escapeCharacter=function(){this.escapeCharPositions.push(this.pos-1),this.pos+=1},t.QueryLexer.prototype.next=function(){if(this.pos>=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos<this.length},t.QueryLexer.EOS="EOS",t.QueryLexer.FIELD="FIELD",t.QueryLexer.TERM="TERM",t.QueryLexer.EDIT_DISTANCE="EDIT_DISTANCE",t.QueryLexer.BOOST="BOOST",t.QueryLexer.PRESENCE="PRESENCE",t.QueryLexer.lexField=function(e){return e.backup(),e.emit(t.QueryLexer.FIELD),e.ignore(),t.QueryLexer.lexText},t.QueryLexer.lexTerm=function(e){if(e.width()>1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i<s;i++)if(r[i]===n){r.splice(i,1);return}}dispatchEvent(e){if(!(e.type in this.listeners))return!0;let n=this.listeners[e.type].slice();for(let r=0,i=n.length;r<i;r++)n[r].call(this,e);return!e.defaultPrevented}};var ne=(t,e=100)=>{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;i<s;i++){n=this.anchors[i];let o=n.anchor.getBoundingClientRect();n.position=o.top+document.body.scrollTop}this.anchors.sort((i,s)=>i.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o<s&&i[o+1].position<r;)o+=1;this.index!=o&&(this.index>-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("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 n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;o<s.length;o++){let a=s[o],u=r.data.rows[Number(a.ref)],l=1;u.name.toLowerCase().startsWith(i.toLowerCase())&&(l*=1+1/(1+Math.abs(u.name.length-i.length))),a.score*=l}s.sort((o,a)=>a.score-o.score);for(let o=0,a=Math.min(10,s.length);o<a;o++){let u=r.data.rows[Number(s[o].ref)],l=fe(u.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(l+=` (score: ${s[o].score.toFixed(2)})`),u.parent&&(l=`<span class="parent">${fe(u.parent,i)}.</span>${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function fe(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ie(t.substring(s,o)),`<b>${ie(t.substring(o,o+r.length))}</b>`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&amp;","<":"&lt;",">":"&gt;","'":"&#039;",'"':"&quot;"};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } 4 4 + `}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); 5 5 + /*! Bundled license information: 6 6 + 7 7 + lunr/lunr.js: 8 8 + (** 9 9 + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 10 10 + * Copyright (C) 2020 Oliver Nightingale 11 11 + * @license MIT 12 12 + *) 13 13 + (*! 14 14 + * lunr.utils 15 15 + * Copyright (C) 2020 Oliver Nightingale 16 16 + *) 17 17 + (*! 18 18 + * lunr.Set 19 19 + * Copyright (C) 2020 Oliver Nightingale 20 20 + *) 21 21 + (*! 22 22 + * lunr.tokenizer 23 23 + * Copyright (C) 2020 Oliver Nightingale 24 24 + *) 25 25 + (*! 26 26 + * lunr.Pipeline 27 27 + * Copyright (C) 2020 Oliver Nightingale 28 28 + *) 29 29 + (*! 30 30 + * lunr.Vector 31 31 + * Copyright (C) 2020 Oliver Nightingale 32 32 + *) 33 33 + (*! 34 34 + * lunr.stemmer 35 35 + * Copyright (C) 2020 Oliver Nightingale 36 36 + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt 37 37 + *) 38 38 + (*! 39 39 + * lunr.stopWordFilter 40 40 + * Copyright (C) 2020 Oliver Nightingale 41 41 + *) 42 42 + (*! 43 43 + * lunr.trimmer 44 44 + * Copyright (C) 2020 Oliver Nightingale 45 45 + *) 46 46 + (*! 47 47 + * lunr.TokenSet 48 48 + * Copyright (C) 2020 Oliver Nightingale 49 49 + *) 50 50 + (*! 51 51 + * lunr.Index 52 52 + * Copyright (C) 2020 Oliver Nightingale 53 53 + *) 54 54 + (*! 55 55 + * lunr.Builder 56 56 + * Copyright (C) 2020 Oliver Nightingale 57 57 + *) 58 58 + */

+1

assets/search.js

Reviewed

··· 1 1 + window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"8388608\":\"Reference\"},\"rows\":[{\"kind\":256,\"name\":\"RedactOptions\",\"url\":\"interfaces/RedactOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"replaceFrom\",\"url\":\"interfaces/RedactOptions.html#replaceFrom\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedactOptions\"},{\"kind\":1024,\"name\":\"replaceWith\",\"url\":\"interfaces/RedactOptions.html#replaceWith\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedactOptions\"},{\"kind\":1024,\"name\":\"replace\",\"url\":\"interfaces/RedactOptions.html#replace\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"RedactOptions\"},{\"kind\":64,\"name\":\"redactString\",\"url\":\"functions/redactString.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":8388608,\"name\":\"default\",\"url\":\"modules.html#default\",\"classes\":\"tsd-kind-reference\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,15.404]],[\"comment/0\",[]],[\"name/1\",[1,15.404]],[\"comment/1\",[]],[\"name/2\",[2,15.404]],[\"comment/2\",[]],[\"name/3\",[3,15.404]],[\"comment/3\",[]],[\"name/4\",[4,23.107]],[\"comment/4\",[]],[\"name/5\",[5,15.404]],[\"comment/5\",[]]],\"invertedIndex\":[[\"default\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"redactoptions\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"redactstring\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"replace\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"replacefrom\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"replacewith\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}]],\"pipeline\":[]}}");

+1279

assets/style.css

Reviewed

··· 1 1 + :root { 2 2 + /* Light */ 3 3 + --light-color-background: #f2f4f8; 4 4 + --light-color-background-secondary: #eff0f1; 5 5 + --light-color-warning-text: #222; 6 6 + --light-color-background-warning: #e6e600; 7 7 + --light-color-icon-background: var(--light-color-background); 8 8 + --light-color-accent: #c5c7c9; 9 9 + --light-color-text: #222; 10 10 + --light-color-text-aside: #707070; 11 11 + --light-color-link: #4da6ff; 12 12 + --light-color-ts: #db1373; 13 13 + --light-color-ts-interface: #139d2c; 14 14 + --light-color-ts-enum: #9c891a; 15 15 + --light-color-ts-class: #2484e5; 16 16 + --light-color-ts-function: #572be7; 17 17 + --light-color-ts-namespace: #b111c9; 18 18 + --light-color-ts-private: #707070; 19 19 + --light-color-ts-variable: #4d68ff; 20 20 + --light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>"); 21 21 + --light-color-scheme: light; 22 22 + 23 23 + /* Dark */ 24 24 + --dark-color-background: #2b2e33; 25 25 + --dark-color-background-secondary: #1e2024; 26 26 + --dark-color-background-warning: #bebe00; 27 27 + --dark-color-warning-text: #222; 28 28 + --dark-color-icon-background: var(--dark-color-background-secondary); 29 29 + --dark-color-accent: #9096a2; 30 30 + --dark-color-text: #f5f5f5; 31 31 + --dark-color-text-aside: #dddddd; 32 32 + --dark-color-link: #00aff4; 33 33 + --dark-color-ts: #ff6492; 34 34 + --dark-color-ts-interface: #6cff87; 35 35 + --dark-color-ts-enum: #f4d93e; 36 36 + --dark-color-ts-class: #61b0ff; 37 37 + --dark-color-ts-function: #9772ff; 38 38 + --dark-color-ts-namespace: #e14dff; 39 39 + --dark-color-ts-private: #e2e2e2; 40 40 + --dark-color-ts-variable: #4d68ff; 41 41 + --dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>"); 42 42 + --dark-color-scheme: dark; 43 43 + } 44 44 + 45 45 + @media (prefers-color-scheme: light) { 46 46 + :root { 47 47 + --color-background: var(--light-color-background); 48 48 + --color-background-secondary: var(--light-color-background-secondary); 49 49 + --color-background-warning: var(--light-color-background-warning); 50 50 + --color-warning-text: var(--light-color-warning-text); 51 51 + --color-icon-background: var(--light-color-icon-background); 52 52 + --color-accent: var(--light-color-accent); 53 53 + --color-text: var(--light-color-text); 54 54 + --color-text-aside: var(--light-color-text-aside); 55 55 + --color-link: var(--light-color-link); 56 56 + --color-ts: var(--light-color-ts); 57 57 + --color-ts-interface: var(--light-color-ts-interface); 58 58 + --color-ts-enum: var(--light-color-ts-enum); 59 59 + --color-ts-class: var(--light-color-ts-class); 60 60 + --color-ts-function: var(--light-color-ts-function); 61 61 + --color-ts-namespace: var(--light-color-ts-namespace); 62 62 + --color-ts-private: var(--light-color-ts-private); 63 63 + --color-ts-variable: var(--light-color-ts-variable); 64 64 + --external-icon: var(--light-external-icon); 65 65 + --color-scheme: var(--light-color-scheme); 66 66 + } 67 67 + } 68 68 + 69 69 + @media (prefers-color-scheme: dark) { 70 70 + :root { 71 71 + --color-background: var(--dark-color-background); 72 72 + --color-background-secondary: var(--dark-color-background-secondary); 73 73 + --color-background-warning: var(--dark-color-background-warning); 74 74 + --color-warning-text: var(--dark-color-warning-text); 75 75 + --color-icon-background: var(--dark-color-icon-background); 76 76 + --color-accent: var(--dark-color-accent); 77 77 + --color-text: var(--dark-color-text); 78 78 + --color-text-aside: var(--dark-color-text-aside); 79 79 + --color-link: var(--dark-color-link); 80 80 + --color-ts: var(--dark-color-ts); 81 81 + --color-ts-interface: var(--dark-color-ts-interface); 82 82 + --color-ts-enum: var(--dark-color-ts-enum); 83 83 + --color-ts-class: var(--dark-color-ts-class); 84 84 + --color-ts-function: var(--dark-color-ts-function); 85 85 + --color-ts-namespace: var(--dark-color-ts-namespace); 86 86 + --color-ts-private: var(--dark-color-ts-private); 87 87 + --color-ts-variable: var(--dark-color-ts-variable); 88 88 + --external-icon: var(--dark-external-icon); 89 89 + --color-scheme: var(--dark-color-scheme); 90 90 + } 91 91 + } 92 92 + 93 93 + html { 94 94 + color-scheme: var(--color-scheme); 95 95 + } 96 96 + 97 97 + body { 98 98 + margin: 0; 99 99 + } 100 100 + 101 101 + :root[data-theme="light"] { 102 102 + --color-background: var(--light-color-background); 103 103 + --color-background-secondary: var(--light-color-background-secondary); 104 104 + --color-background-warning: var(--light-color-background-warning); 105 105 + --color-warning-text: var(--light-color-warning-text); 106 106 + --color-icon-background: var(--light-color-icon-background); 107 107 + --color-accent: var(--light-color-accent); 108 108 + --color-text: var(--light-color-text); 109 109 + --color-text-aside: var(--light-color-text-aside); 110 110 + --color-link: var(--light-color-link); 111 111 + --color-ts: var(--light-color-ts); 112 112 + --color-ts-interface: var(--light-color-ts-interface); 113 113 + --color-ts-enum: var(--light-color-ts-enum); 114 114 + --color-ts-class: var(--light-color-ts-class); 115 115 + --color-ts-function: var(--light-color-ts-function); 116 116 + --color-ts-namespace: var(--light-color-ts-namespace); 117 117 + --color-ts-private: var(--light-color-ts-private); 118 118 + --color-ts-variable: var(--light-color-ts-variable); 119 119 + --external-icon: var(--light-external-icon); 120 120 + --color-scheme: var(--light-color-scheme); 121 121 + } 122 122 + 123 123 + :root[data-theme="dark"] { 124 124 + --color-background: var(--dark-color-background); 125 125 + --color-background-secondary: var(--dark-color-background-secondary); 126 126 + --color-background-warning: var(--dark-color-background-warning); 127 127 + --color-warning-text: var(--dark-color-warning-text); 128 128 + --color-icon-background: var(--dark-color-icon-background); 129 129 + --color-accent: var(--dark-color-accent); 130 130 + --color-text: var(--dark-color-text); 131 131 + --color-text-aside: var(--dark-color-text-aside); 132 132 + --color-link: var(--dark-color-link); 133 133 + --color-ts: var(--dark-color-ts); 134 134 + --color-ts-interface: var(--dark-color-ts-interface); 135 135 + --color-ts-enum: var(--dark-color-ts-enum); 136 136 + --color-ts-class: var(--dark-color-ts-class); 137 137 + --color-ts-function: var(--dark-color-ts-function); 138 138 + --color-ts-namespace: var(--dark-color-ts-namespace); 139 139 + --color-ts-private: var(--dark-color-ts-private); 140 140 + --color-ts-variable: var(--dark-color-ts-variable); 141 141 + --external-icon: var(--dark-external-icon); 142 142 + --color-scheme: var(--dark-color-scheme); 143 143 + } 144 144 + 145 145 + .always-visible, 146 146 + .always-visible .tsd-signatures { 147 147 + display: inherit !important; 148 148 + } 149 149 + 150 150 + h1, 151 151 + h2, 152 152 + h3, 153 153 + h4, 154 154 + h5, 155 155 + h6 { 156 156 + line-height: 1.2; 157 157 + } 158 158 + 159 159 + h1 { 160 160 + font-size: 1.875rem; 161 161 + margin: 0.67rem 0; 162 162 + } 163 163 + 164 164 + h2 { 165 165 + font-size: 1.5rem; 166 166 + margin: 0.83rem 0; 167 167 + } 168 168 + 169 169 + h3 { 170 170 + font-size: 1.25rem; 171 171 + margin: 1rem 0; 172 172 + } 173 173 + 174 174 + h4 { 175 175 + font-size: 1.05rem; 176 176 + margin: 1.33rem 0; 177 177 + } 178 178 + 179 179 + h5 { 180 180 + font-size: 1rem; 181 181 + margin: 1.5rem 0; 182 182 + } 183 183 + 184 184 + h6 { 185 185 + font-size: 0.875rem; 186 186 + margin: 2.33rem 0; 187 187 + } 188 188 + 189 189 + .uppercase { 190 190 + text-transform: uppercase; 191 191 + } 192 192 + 193 193 + pre { 194 194 + white-space: pre; 195 195 + white-space: pre-wrap; 196 196 + word-wrap: break-word; 197 197 + } 198 198 + 199 199 + dl, 200 200 + menu, 201 201 + ol, 202 202 + ul { 203 203 + margin: 1em 0; 204 204 + } 205 205 + 206 206 + dd { 207 207 + margin: 0 0 0 40px; 208 208 + } 209 209 + 210 210 + .container { 211 211 + max-width: 1600px; 212 212 + padding: 0 2rem; 213 213 + } 214 214 + 215 215 + @media (min-width: 640px) { 216 216 + .container { 217 217 + padding: 0 4rem; 218 218 + } 219 219 + } 220 220 + @media (min-width: 1200px) { 221 221 + .container { 222 222 + padding: 0 8rem; 223 223 + } 224 224 + } 225 225 + @media (min-width: 1600px) { 226 226 + .container { 227 227 + padding: 0 12rem; 228 228 + } 229 229 + } 230 230 + 231 231 + /* Footer */ 232 232 + .tsd-generator { 233 233 + border-top: 1px solid var(--color-accent); 234 234 + padding-top: 1rem; 235 235 + padding-bottom: 1rem; 236 236 + max-height: 3.5rem; 237 237 + } 238 238 + 239 239 + .tsd-generator > p { 240 240 + margin-top: 0; 241 241 + margin-bottom: 0; 242 242 + padding: 0 1rem; 243 243 + } 244 244 + 245 245 + .container-main { 246 246 + display: flex; 247 247 + justify-content: space-between; 248 248 + position: relative; 249 249 + margin: 0 auto; 250 250 + } 251 251 + 252 252 + .col-4, 253 253 + .col-8 { 254 254 + box-sizing: border-box; 255 255 + float: left; 256 256 + padding: 2rem 1rem; 257 257 + } 258 258 + 259 259 + .col-4 { 260 260 + flex: 0 0 25%; 261 261 + } 262 262 + .col-8 { 263 263 + flex: 1 0; 264 264 + flex-wrap: wrap; 265 265 + padding-left: 0; 266 266 + } 267 267 + 268 268 + @keyframes fade-in { 269 269 + from { 270 270 + opacity: 0; 271 271 + } 272 272 + to { 273 273 + opacity: 1; 274 274 + } 275 275 + } 276 276 + @keyframes fade-out { 277 277 + from { 278 278 + opacity: 1; 279 279 + visibility: visible; 280 280 + } 281 281 + to { 282 282 + opacity: 0; 283 283 + } 284 284 + } 285 285 + @keyframes fade-in-delayed { 286 286 + 0% { 287 287 + opacity: 0; 288 288 + } 289 289 + 33% { 290 290 + opacity: 0; 291 291 + } 292 292 + 100% { 293 293 + opacity: 1; 294 294 + } 295 295 + } 296 296 + @keyframes fade-out-delayed { 297 297 + 0% { 298 298 + opacity: 1; 299 299 + visibility: visible; 300 300 + } 301 301 + 66% { 302 302 + opacity: 0; 303 303 + } 304 304 + 100% { 305 305 + opacity: 0; 306 306 + } 307 307 + } 308 308 + @keyframes shift-to-left { 309 309 + from { 310 310 + transform: translate(0, 0); 311 311 + } 312 312 + to { 313 313 + transform: translate(-25%, 0); 314 314 + } 315 315 + } 316 316 + @keyframes unshift-to-left { 317 317 + from { 318 318 + transform: translate(-25%, 0); 319 319 + } 320 320 + to { 321 321 + transform: translate(0, 0); 322 322 + } 323 323 + } 324 324 + @keyframes pop-in-from-right { 325 325 + from { 326 326 + transform: translate(100%, 0); 327 327 + } 328 328 + to { 329 329 + transform: translate(0, 0); 330 330 + } 331 331 + } 332 332 + @keyframes pop-out-to-right { 333 333 + from { 334 334 + transform: translate(0, 0); 335 335 + visibility: visible; 336 336 + } 337 337 + to { 338 338 + transform: translate(100%, 0); 339 339 + } 340 340 + } 341 341 + body { 342 342 + background: var(--color-background); 343 343 + font-family: "Segoe UI", sans-serif; 344 344 + font-size: 16px; 345 345 + color: var(--color-text); 346 346 + } 347 347 + 348 348 + a { 349 349 + color: var(--color-link); 350 350 + text-decoration: none; 351 351 + } 352 352 + a:hover { 353 353 + text-decoration: underline; 354 354 + } 355 355 + a.external[target="_blank"] { 356 356 + background-image: var(--external-icon); 357 357 + background-position: top 3px right; 358 358 + background-repeat: no-repeat; 359 359 + padding-right: 13px; 360 360 + } 361 361 + 362 362 + code, 363 363 + pre { 364 364 + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; 365 365 + padding: 0.2em; 366 366 + margin: 0; 367 367 + font-size: 0.875rem; 368 368 + border-radius: 0.8em; 369 369 + } 370 370 + 371 371 + pre { 372 372 + padding: 10px; 373 373 + border: 0.1em solid var(--color-accent); 374 374 + } 375 375 + pre code { 376 376 + padding: 0; 377 377 + font-size: 100%; 378 378 + } 379 379 + 380 380 + blockquote { 381 381 + margin: 1em 0; 382 382 + padding-left: 1em; 383 383 + border-left: 4px solid gray; 384 384 + } 385 385 + 386 386 + .tsd-typography { 387 387 + line-height: 1.333em; 388 388 + } 389 389 + .tsd-typography ul { 390 390 + list-style: square; 391 391 + padding: 0 0 0 20px; 392 392 + margin: 0; 393 393 + } 394 394 + .tsd-typography h4, 395 395 + .tsd-typography .tsd-index-panel h3, 396 396 + .tsd-index-panel .tsd-typography h3, 397 397 + .tsd-typography h5, 398 398 + .tsd-typography h6 { 399 399 + font-size: 1em; 400 400 + margin: 0; 401 401 + } 402 402 + .tsd-typography h5, 403 403 + .tsd-typography h6 { 404 404 + font-weight: normal; 405 405 + } 406 406 + .tsd-typography p, 407 407 + .tsd-typography ul, 408 408 + .tsd-typography ol { 409 409 + margin: 1em 0; 410 410 + } 411 411 + 412 412 + @media (max-width: 1024px) { 413 413 + html .col-content { 414 414 + float: none; 415 415 + max-width: 100%; 416 416 + width: 100%; 417 417 + padding-top: 3rem; 418 418 + } 419 419 + html .col-menu { 420 420 + position: fixed !important; 421 421 + overflow-y: auto; 422 422 + -webkit-overflow-scrolling: touch; 423 423 + z-index: 1024; 424 424 + top: 0 !important; 425 425 + bottom: 0 !important; 426 426 + left: auto !important; 427 427 + right: 0 !important; 428 428 + padding: 1.5rem 1.5rem 0 0; 429 429 + max-width: 25rem; 430 430 + visibility: hidden; 431 431 + background-color: var(--color-background); 432 432 + transform: translate(100%, 0); 433 433 + } 434 434 + html .col-menu > *:last-child { 435 435 + padding-bottom: 20px; 436 436 + } 437 437 + html .overlay { 438 438 + content: ""; 439 439 + display: block; 440 440 + position: fixed; 441 441 + z-index: 1023; 442 442 + top: 0; 443 443 + left: 0; 444 444 + right: 0; 445 445 + bottom: 0; 446 446 + background-color: rgba(0, 0, 0, 0.75); 447 447 + visibility: hidden; 448 448 + } 449 449 + 450 450 + .to-has-menu .overlay { 451 451 + animation: fade-in 0.4s; 452 452 + } 453 453 + 454 454 + .to-has-menu :is(header, footer, .col-content) { 455 455 + animation: shift-to-left 0.4s; 456 456 + } 457 457 + 458 458 + .to-has-menu .col-menu { 459 459 + animation: pop-in-from-right 0.4s; 460 460 + } 461 461 + 462 462 + .from-has-menu .overlay { 463 463 + animation: fade-out 0.4s; 464 464 + } 465 465 + 466 466 + .from-has-menu :is(header, footer, .col-content) { 467 467 + animation: unshift-to-left 0.4s; 468 468 + } 469 469 + 470 470 + .from-has-menu .col-menu { 471 471 + animation: pop-out-to-right 0.4s; 472 472 + } 473 473 + 474 474 + .has-menu body { 475 475 + overflow: hidden; 476 476 + } 477 477 + .has-menu .overlay { 478 478 + visibility: visible; 479 479 + } 480 480 + .has-menu :is(header, footer, .col-content) { 481 481 + transform: translate(-25%, 0); 482 482 + } 483 483 + .has-menu .col-menu { 484 484 + visibility: visible; 485 485 + transform: translate(0, 0); 486 486 + display: flex; 487 487 + flex-direction: column; 488 488 + gap: 1.5rem; 489 489 + max-height: 100vh; 490 490 + padding: 1rem 2rem; 491 491 + } 492 492 + .has-menu .tsd-navigation { 493 493 + max-height: 100%; 494 494 + } 495 495 + } 496 496 + 497 497 + .tsd-breadcrumb { 498 498 + margin: 0; 499 499 + padding: 0; 500 500 + color: var(--color-text-aside); 501 501 + } 502 502 + .tsd-breadcrumb a { 503 503 + color: var(--color-text-aside); 504 504 + text-decoration: none; 505 505 + } 506 506 + .tsd-breadcrumb a:hover { 507 507 + text-decoration: underline; 508 508 + } 509 509 + .tsd-breadcrumb li { 510 510 + display: inline; 511 511 + } 512 512 + .tsd-breadcrumb li:after { 513 513 + content: " / "; 514 514 + } 515 515 + 516 516 + .tsd-comment-tags { 517 517 + display: flex; 518 518 + flex-direction: column; 519 519 + } 520 520 + dl.tsd-comment-tag-group { 521 521 + display: flex; 522 522 + align-items: center; 523 523 + overflow: hidden; 524 524 + margin: 0.5em 0; 525 525 + } 526 526 + dl.tsd-comment-tag-group dt { 527 527 + display: flex; 528 528 + margin-right: 0.5em; 529 529 + font-size: 0.875em; 530 530 + font-weight: normal; 531 531 + } 532 532 + dl.tsd-comment-tag-group dd { 533 533 + margin: 0; 534 534 + } 535 535 + code.tsd-tag { 536 536 + padding: 0.25em 0.4em; 537 537 + border: 0.1em solid var(--color-accent); 538 538 + margin-right: 0.25em; 539 539 + font-size: 70%; 540 540 + } 541 541 + h1 code.tsd-tag:first-of-type { 542 542 + margin-left: 0.25em; 543 543 + } 544 544 + 545 545 + dl.tsd-comment-tag-group dd:before, 546 546 + dl.tsd-comment-tag-group dd:after { 547 547 + content: " "; 548 548 + } 549 549 + dl.tsd-comment-tag-group dd pre, 550 550 + dl.tsd-comment-tag-group dd:after { 551 551 + clear: both; 552 552 + } 553 553 + dl.tsd-comment-tag-group p { 554 554 + margin: 0; 555 555 + } 556 556 + 557 557 + .tsd-panel.tsd-comment .lead { 558 558 + font-size: 1.1em; 559 559 + line-height: 1.333em; 560 560 + margin-bottom: 2em; 561 561 + } 562 562 + .tsd-panel.tsd-comment .lead:last-child { 563 563 + margin-bottom: 0; 564 564 + } 565 565 + 566 566 + .tsd-filter-visibility h4 { 567 567 + font-size: 1rem; 568 568 + padding-top: 0.75rem; 569 569 + padding-bottom: 0.5rem; 570 570 + margin: 0; 571 571 + } 572 572 + .tsd-filter-item:not(:last-child) { 573 573 + margin-bottom: 0.5rem; 574 574 + } 575 575 + .tsd-filter-input { 576 576 + display: flex; 577 577 + width: fit-content; 578 578 + width: -moz-fit-content; 579 579 + align-items: center; 580 580 + user-select: none; 581 581 + -webkit-user-select: none; 582 582 + -moz-user-select: none; 583 583 + -ms-user-select: none; 584 584 + cursor: pointer; 585 585 + } 586 586 + .tsd-filter-input input[type="checkbox"] { 587 587 + cursor: pointer; 588 588 + position: absolute; 589 589 + width: 1.5em; 590 590 + height: 1.5em; 591 591 + opacity: 0; 592 592 + } 593 593 + .tsd-filter-input input[type="checkbox"]:disabled { 594 594 + pointer-events: none; 595 595 + } 596 596 + .tsd-filter-input svg { 597 597 + cursor: pointer; 598 598 + width: 1.5em; 599 599 + height: 1.5em; 600 600 + margin-right: 0.5em; 601 601 + border-radius: 0.33em; 602 602 + /* Leaving this at full opacity breaks event listeners on Firefox. 603 603 + Don't remove unless you know what you're doing. */ 604 604 + opacity: 0.99; 605 605 + } 606 606 + .tsd-filter-input input[type="checkbox"]:focus + svg { 607 607 + transform: scale(0.95); 608 608 + } 609 609 + .tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { 610 610 + transform: scale(1); 611 611 + } 612 612 + .tsd-checkbox-background { 613 613 + fill: var(--color-accent); 614 614 + } 615 615 + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { 616 616 + stroke: var(--color-text); 617 617 + } 618 618 + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { 619 619 + fill: var(--color-background); 620 620 + stroke: var(--color-accent); 621 621 + stroke-width: 0.25rem; 622 622 + } 623 623 + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { 624 624 + stroke: var(--color-accent); 625 625 + } 626 626 + 627 627 + .tsd-theme-toggle { 628 628 + padding-top: 0.75rem; 629 629 + } 630 630 + .tsd-theme-toggle > h4 { 631 631 + display: inline; 632 632 + vertical-align: middle; 633 633 + margin-right: 0.75rem; 634 634 + } 635 635 + 636 636 + .tsd-hierarchy { 637 637 + list-style: square; 638 638 + margin: 0; 639 639 + } 640 640 + .tsd-hierarchy .target { 641 641 + font-weight: bold; 642 642 + } 643 643 + 644 644 + .tsd-panel-group.tsd-index-group { 645 645 + margin-bottom: 0; 646 646 + } 647 647 + .tsd-index-panel .tsd-index-list { 648 648 + list-style: none; 649 649 + line-height: 1.333em; 650 650 + margin: 0; 651 651 + padding: 0.25rem 0 0 0; 652 652 + overflow: hidden; 653 653 + display: grid; 654 654 + grid-template-columns: repeat(3, 1fr); 655 655 + column-gap: 1rem; 656 656 + grid-template-rows: auto; 657 657 + } 658 658 + @media (max-width: 1024px) { 659 659 + .tsd-index-panel .tsd-index-list { 660 660 + grid-template-columns: repeat(2, 1fr); 661 661 + } 662 662 + } 663 663 + @media (max-width: 768px) { 664 664 + .tsd-index-panel .tsd-index-list { 665 665 + grid-template-columns: repeat(1, 1fr); 666 666 + } 667 667 + } 668 668 + .tsd-index-panel .tsd-index-list li { 669 669 + -webkit-page-break-inside: avoid; 670 670 + -moz-page-break-inside: avoid; 671 671 + -ms-page-break-inside: avoid; 672 672 + -o-page-break-inside: avoid; 673 673 + page-break-inside: avoid; 674 674 + } 675 675 + .tsd-index-panel a, 676 676 + .tsd-index-panel a.tsd-parent-kind-module { 677 677 + color: var(--color-ts); 678 678 + } 679 679 + .tsd-index-panel a.tsd-parent-kind-interface { 680 680 + color: var(--color-ts-interface); 681 681 + } 682 682 + .tsd-index-panel a.tsd-parent-kind-enum { 683 683 + color: var(--color-ts-enum); 684 684 + } 685 685 + .tsd-index-panel a.tsd-parent-kind-class { 686 686 + color: var(--color-ts-class); 687 687 + } 688 688 + .tsd-index-panel a.tsd-kind-module { 689 689 + color: var(--color-ts-namespace); 690 690 + } 691 691 + .tsd-index-panel a.tsd-kind-interface { 692 692 + color: var(--color-ts-interface); 693 693 + } 694 694 + .tsd-index-panel a.tsd-kind-enum { 695 695 + color: var(--color-ts-enum); 696 696 + } 697 697 + .tsd-index-panel a.tsd-kind-class { 698 698 + color: var(--color-ts-class); 699 699 + } 700 700 + .tsd-index-panel a.tsd-kind-function { 701 701 + color: var(--color-ts-function); 702 702 + } 703 703 + .tsd-index-panel a.tsd-kind-namespace { 704 704 + color: var(--color-ts-namespace); 705 705 + } 706 706 + .tsd-index-panel a.tsd-kind-variable { 707 707 + color: var(--color-ts-variable); 708 708 + } 709 709 + .tsd-index-panel a.tsd-is-private { 710 710 + color: var(--color-ts-private); 711 711 + } 712 712 + 713 713 + .tsd-flag { 714 714 + display: inline-block; 715 715 + padding: 0.25em 0.4em; 716 716 + border-radius: 4px; 717 717 + color: var(--color-comment-tag-text); 718 718 + background-color: var(--color-comment-tag); 719 719 + text-indent: 0; 720 720 + font-size: 75%; 721 721 + line-height: 1; 722 722 + font-weight: normal; 723 723 + } 724 724 + 725 725 + .tsd-anchor { 726 726 + position: absolute; 727 727 + top: -100px; 728 728 + } 729 729 + 730 730 + .tsd-member { 731 731 + position: relative; 732 732 + } 733 733 + .tsd-member .tsd-anchor + h3 { 734 734 + display: flex; 735 735 + align-items: center; 736 736 + margin-top: 0; 737 737 + margin-bottom: 0; 738 738 + border-bottom: none; 739 739 + } 740 740 + .tsd-member [data-tsd-kind] { 741 741 + color: var(--color-ts); 742 742 + } 743 743 + .tsd-member [data-tsd-kind="Interface"] { 744 744 + color: var(--color-ts-interface); 745 745 + } 746 746 + .tsd-member [data-tsd-kind="Enum"] { 747 747 + color: var(--color-ts-enum); 748 748 + } 749 749 + .tsd-member [data-tsd-kind="Class"] { 750 750 + color: var(--color-ts-class); 751 751 + } 752 752 + .tsd-member [data-tsd-kind="Private"] { 753 753 + color: var(--color-ts-private); 754 754 + } 755 755 + 756 756 + .tsd-navigation a { 757 757 + display: block; 758 758 + margin: 0.4rem 0; 759 759 + border-left: 2px solid transparent; 760 760 + color: var(--color-text); 761 761 + text-decoration: none; 762 762 + transition: border-left-color 0.1s; 763 763 + } 764 764 + .tsd-navigation a:hover { 765 765 + text-decoration: underline; 766 766 + } 767 767 + .tsd-navigation ul { 768 768 + margin: 0; 769 769 + padding: 0; 770 770 + list-style: none; 771 771 + } 772 772 + .tsd-navigation li { 773 773 + padding: 0; 774 774 + } 775 775 + 776 776 + .tsd-navigation.primary .tsd-accordion-details > ul { 777 777 + margin-top: 0.75rem; 778 778 + } 779 779 + .tsd-navigation.primary a { 780 780 + padding: 0.75rem 0.5rem; 781 781 + margin: 0; 782 782 + } 783 783 + .tsd-navigation.primary ul li a { 784 784 + margin-left: 0.5rem; 785 785 + } 786 786 + .tsd-navigation.primary ul li li a { 787 787 + margin-left: 1.5rem; 788 788 + } 789 789 + .tsd-navigation.primary ul li li li a { 790 790 + margin-left: 2.5rem; 791 791 + } 792 792 + .tsd-navigation.primary ul li li li li a { 793 793 + margin-left: 3.5rem; 794 794 + } 795 795 + .tsd-navigation.primary ul li li li li li a { 796 796 + margin-left: 4.5rem; 797 797 + } 798 798 + .tsd-navigation.primary ul li li li li li li a { 799 799 + margin-left: 5.5rem; 800 800 + } 801 801 + .tsd-navigation.primary li.current > a { 802 802 + border-left: 0.15rem var(--color-text) solid; 803 803 + } 804 804 + .tsd-navigation.primary li.selected > a { 805 805 + font-weight: bold; 806 806 + border-left: 0.2rem var(--color-text) solid; 807 807 + } 808 808 + .tsd-navigation.primary ul li a:hover { 809 809 + border-left: 0.2rem var(--color-text-aside) solid; 810 810 + } 811 811 + .tsd-navigation.primary li.globals + li > span, 812 812 + .tsd-navigation.primary li.globals + li > a { 813 813 + padding-top: 20px; 814 814 + } 815 815 + 816 816 + .tsd-navigation.secondary.tsd-navigation--toolbar-hide { 817 817 + max-height: calc(100vh - 1rem); 818 818 + top: 0.5rem; 819 819 + } 820 820 + .tsd-navigation.secondary > ul { 821 821 + display: inline; 822 822 + padding-right: 0.5rem; 823 823 + transition: opacity 0.2s; 824 824 + } 825 825 + .tsd-navigation.secondary ul li a { 826 826 + padding-left: 0; 827 827 + } 828 828 + .tsd-navigation.secondary ul li li a { 829 829 + padding-left: 1.1rem; 830 830 + } 831 831 + .tsd-navigation.secondary ul li li li a { 832 832 + padding-left: 2.2rem; 833 833 + } 834 834 + .tsd-navigation.secondary ul li li li li a { 835 835 + padding-left: 3.3rem; 836 836 + } 837 837 + .tsd-navigation.secondary ul li li li li li a { 838 838 + padding-left: 4.4rem; 839 839 + } 840 840 + .tsd-navigation.secondary ul li li li li li li a { 841 841 + padding-left: 5.5rem; 842 842 + } 843 843 + 844 844 + #tsd-sidebar-links a { 845 845 + margin-top: 0; 846 846 + margin-bottom: 0.5rem; 847 847 + line-height: 1.25rem; 848 848 + } 849 849 + #tsd-sidebar-links a:last-of-type { 850 850 + margin-bottom: 0; 851 851 + } 852 852 + 853 853 + a.tsd-index-link { 854 854 + margin: 0.25rem 0; 855 855 + font-size: 1rem; 856 856 + line-height: 1.25rem; 857 857 + display: inline-flex; 858 858 + align-items: center; 859 859 + } 860 860 + .tsd-accordion-summary > h1, 861 861 + .tsd-accordion-summary > h2, 862 862 + .tsd-accordion-summary > h3, 863 863 + .tsd-accordion-summary > h4, 864 864 + .tsd-accordion-summary > h5 { 865 865 + display: inline-flex; 866 866 + align-items: center; 867 867 + vertical-align: middle; 868 868 + margin-bottom: 0; 869 869 + user-select: none; 870 870 + -moz-user-select: none; 871 871 + -webkit-user-select: none; 872 872 + -ms-user-select: none; 873 873 + } 874 874 + .tsd-accordion-summary { 875 875 + display: block; 876 876 + cursor: pointer; 877 877 + } 878 878 + .tsd-accordion-summary > * { 879 879 + margin-top: 0; 880 880 + margin-bottom: 0; 881 881 + padding-top: 0; 882 882 + padding-bottom: 0; 883 883 + } 884 884 + .tsd-accordion-summary::-webkit-details-marker { 885 885 + display: none; 886 886 + } 887 887 + .tsd-index-accordion .tsd-accordion-summary svg { 888 888 + margin-right: 0.25rem; 889 889 + } 890 890 + .tsd-index-content > :not(:first-child) { 891 891 + margin-top: 0.75rem; 892 892 + } 893 893 + .tsd-index-heading { 894 894 + margin-top: 1.5rem; 895 895 + margin-bottom: 0.75rem; 896 896 + } 897 897 + 898 898 + .tsd-kind-icon { 899 899 + margin-right: 0.5rem; 900 900 + width: 1.25rem; 901 901 + height: 1.25rem; 902 902 + min-width: 1.25rem; 903 903 + min-height: 1.25rem; 904 904 + } 905 905 + .tsd-kind-icon path { 906 906 + transform-origin: center; 907 907 + transform: scale(1.1); 908 908 + } 909 909 + .tsd-signature > .tsd-kind-icon { 910 910 + margin-right: 0.8rem; 911 911 + } 912 912 + 913 913 + @media (min-width: 1025px) { 914 914 + .col-content { 915 915 + margin: 2rem auto; 916 916 + } 917 917 + 918 918 + .menu-sticky-wrap { 919 919 + position: sticky; 920 920 + height: calc(100vh - 2rem); 921 921 + top: 4rem; 922 922 + right: 0; 923 923 + padding: 0 1.5rem; 924 924 + padding-top: 1rem; 925 925 + margin-top: 3rem; 926 926 + transition: 0.3s ease-in-out; 927 927 + transition-property: top, padding-top, padding, height; 928 928 + overflow-y: auto; 929 929 + } 930 930 + .col-menu { 931 931 + border-left: 1px solid var(--color-accent); 932 932 + } 933 933 + .col-menu--hide { 934 934 + top: 1rem; 935 935 + } 936 936 + .col-menu .tsd-navigation:not(:last-child) { 937 937 + padding-bottom: 1.75rem; 938 938 + } 939 939 + } 940 940 + 941 941 + .tsd-panel { 942 942 + margin-bottom: 2.5rem; 943 943 + } 944 944 + .tsd-panel.tsd-member { 945 945 + margin-bottom: 4rem; 946 946 + } 947 947 + .tsd-panel:empty { 948 948 + display: none; 949 949 + } 950 950 + .tsd-panel > h1, 951 951 + .tsd-panel > h2, 952 952 + .tsd-panel > h3 { 953 953 + margin: 1.5rem -1.5rem 0.75rem -1.5rem; 954 954 + padding: 0 1.5rem 0.75rem 1.5rem; 955 955 + } 956 956 + .tsd-panel > h1.tsd-before-signature, 957 957 + .tsd-panel > h2.tsd-before-signature, 958 958 + .tsd-panel > h3.tsd-before-signature { 959 959 + margin-bottom: 0; 960 960 + border-bottom: none; 961 961 + } 962 962 + 963 963 + .tsd-panel-group { 964 964 + margin: 4rem 0; 965 965 + } 966 966 + .tsd-panel-group.tsd-index-group { 967 967 + margin: 2rem 0; 968 968 + } 969 969 + .tsd-panel-group.tsd-index-group details { 970 970 + margin: 2rem 0; 971 971 + } 972 972 + 973 973 + #tsd-search { 974 974 + transition: background-color 0.2s; 975 975 + } 976 976 + #tsd-search .title { 977 977 + position: relative; 978 978 + z-index: 2; 979 979 + } 980 980 + #tsd-search .field { 981 981 + position: absolute; 982 982 + left: 0; 983 983 + top: 0; 984 984 + right: 2.5rem; 985 985 + height: 100%; 986 986 + } 987 987 + #tsd-search .field input { 988 988 + box-sizing: border-box; 989 989 + position: relative; 990 990 + top: -50px; 991 991 + z-index: 1; 992 992 + width: 100%; 993 993 + padding: 0 10px; 994 994 + opacity: 0; 995 995 + outline: 0; 996 996 + border: 0; 997 997 + background: transparent; 998 998 + color: var(--color-text); 999 999 + } 1000 1000 + #tsd-search .field label { 1001 1001 + position: absolute; 1002 1002 + overflow: hidden; 1003 1003 + right: -40px; 1004 1004 + } 1005 1005 + #tsd-search .field input, 1006 1006 + #tsd-search .title, 1007 1007 + #tsd-toolbar-links a { 1008 1008 + transition: opacity 0.2s; 1009 1009 + } 1010 1010 + #tsd-search .results { 1011 1011 + position: absolute; 1012 1012 + visibility: hidden; 1013 1013 + top: 40px; 1014 1014 + width: 100%; 1015 1015 + margin: 0; 1016 1016 + padding: 0; 1017 1017 + list-style: none; 1018 1018 + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); 1019 1019 + } 1020 1020 + #tsd-search .results li { 1021 1021 + padding: 0 10px; 1022 1022 + background-color: var(--color-background); 1023 1023 + } 1024 1024 + #tsd-search .results li:nth-child(even) { 1025 1025 + background-color: var(--color-background-secondary); 1026 1026 + } 1027 1027 + #tsd-search .results li.state { 1028 1028 + display: none; 1029 1029 + } 1030 1030 + #tsd-search .results li.current, 1031 1031 + #tsd-search .results li:hover { 1032 1032 + background-color: var(--color-accent); 1033 1033 + } 1034 1034 + #tsd-search .results a { 1035 1035 + display: block; 1036 1036 + } 1037 1037 + #tsd-search .results a:before { 1038 1038 + top: 10px; 1039 1039 + } 1040 1040 + #tsd-search .results span.parent { 1041 1041 + color: var(--color-text-aside); 1042 1042 + font-weight: normal; 1043 1043 + } 1044 1044 + #tsd-search.has-focus { 1045 1045 + background-color: var(--color-accent); 1046 1046 + } 1047 1047 + #tsd-search.has-focus .field input { 1048 1048 + top: 0; 1049 1049 + opacity: 1; 1050 1050 + } 1051 1051 + #tsd-search.has-focus .title, 1052 1052 + #tsd-search.has-focus #tsd-toolbar-links a { 1053 1053 + z-index: 0; 1054 1054 + opacity: 0; 1055 1055 + } 1056 1056 + #tsd-search.has-focus .results { 1057 1057 + visibility: visible; 1058 1058 + } 1059 1059 + #tsd-search.loading .results li.state.loading { 1060 1060 + display: block; 1061 1061 + } 1062 1062 + #tsd-search.failure .results li.state.failure { 1063 1063 + display: block; 1064 1064 + } 1065 1065 + 1066 1066 + #tsd-toolbar-links { 1067 1067 + position: absolute; 1068 1068 + top: 0; 1069 1069 + right: 2rem; 1070 1070 + height: 100%; 1071 1071 + display: flex; 1072 1072 + align-items: center; 1073 1073 + justify-content: flex-end; 1074 1074 + } 1075 1075 + #tsd-toolbar-links a { 1076 1076 + margin-left: 1.5rem; 1077 1077 + } 1078 1078 + #tsd-toolbar-links a:hover { 1079 1079 + text-decoration: underline; 1080 1080 + } 1081 1081 + 1082 1082 + .tsd-signature { 1083 1083 + margin: 0 0 1rem 0; 1084 1084 + padding: 1rem 0.5rem; 1085 1085 + border: 1px solid var(--color-accent); 1086 1086 + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; 1087 1087 + font-size: 14px; 1088 1088 + overflow-x: auto; 1089 1089 + } 1090 1090 + 1091 1091 + .tsd-signature-symbol { 1092 1092 + color: var(--color-text-aside); 1093 1093 + font-weight: normal; 1094 1094 + } 1095 1095 + 1096 1096 + .tsd-signature-type { 1097 1097 + font-style: italic; 1098 1098 + font-weight: normal; 1099 1099 + } 1100 1100 + 1101 1101 + .tsd-signatures { 1102 1102 + padding: 0; 1103 1103 + margin: 0 0 1em 0; 1104 1104 + list-style-type: none; 1105 1105 + } 1106 1106 + .tsd-signatures .tsd-signature { 1107 1107 + margin: 0; 1108 1108 + border-color: var(--color-accent); 1109 1109 + border-width: 1px 0; 1110 1110 + transition: background-color 0.1s; 1111 1111 + } 1112 1112 + .tsd-description .tsd-signatures .tsd-signature { 1113 1113 + border-width: 1px; 1114 1114 + } 1115 1115 + 1116 1116 + ul.tsd-parameter-list, 1117 1117 + ul.tsd-type-parameter-list { 1118 1118 + list-style: square; 1119 1119 + margin: 0; 1120 1120 + padding-left: 20px; 1121 1121 + } 1122 1122 + ul.tsd-parameter-list > li.tsd-parameter-signature, 1123 1123 + ul.tsd-type-parameter-list > li.tsd-parameter-signature { 1124 1124 + list-style: none; 1125 1125 + margin-left: -20px; 1126 1126 + } 1127 1127 + ul.tsd-parameter-list h5, 1128 1128 + ul.tsd-type-parameter-list h5 { 1129 1129 + font-size: 16px; 1130 1130 + margin: 1em 0 0.5em 0; 1131 1131 + } 1132 1132 + .tsd-sources { 1133 1133 + margin-top: 1rem; 1134 1134 + font-size: 0.875em; 1135 1135 + } 1136 1136 + .tsd-sources a { 1137 1137 + color: var(--color-text-aside); 1138 1138 + text-decoration: underline; 1139 1139 + } 1140 1140 + .tsd-sources ul { 1141 1141 + list-style: none; 1142 1142 + padding: 0; 1143 1143 + } 1144 1144 + 1145 1145 + .tsd-page-toolbar { 1146 1146 + position: fixed; 1147 1147 + z-index: 1; 1148 1148 + top: 0; 1149 1149 + left: 0; 1150 1150 + width: 100%; 1151 1151 + color: var(--color-text); 1152 1152 + background: var(--color-background-secondary); 1153 1153 + border-bottom: 1px var(--color-accent) solid; 1154 1154 + transition: transform 0.3s ease-in-out; 1155 1155 + } 1156 1156 + .tsd-page-toolbar a { 1157 1157 + color: var(--color-text); 1158 1158 + text-decoration: none; 1159 1159 + } 1160 1160 + .tsd-page-toolbar a.title { 1161 1161 + font-weight: bold; 1162 1162 + } 1163 1163 + .tsd-page-toolbar a.title:hover { 1164 1164 + text-decoration: underline; 1165 1165 + } 1166 1166 + .tsd-page-toolbar .tsd-toolbar-contents { 1167 1167 + display: flex; 1168 1168 + justify-content: space-between; 1169 1169 + height: 2.5rem; 1170 1170 + margin: 0 auto; 1171 1171 + } 1172 1172 + .tsd-page-toolbar .table-cell { 1173 1173 + position: relative; 1174 1174 + white-space: nowrap; 1175 1175 + line-height: 40px; 1176 1176 + } 1177 1177 + .tsd-page-toolbar .table-cell:first-child { 1178 1178 + width: 100%; 1179 1179 + } 1180 1180 + .tsd-page-toolbar .tsd-toolbar-icon { 1181 1181 + box-sizing: border-box; 1182 1182 + line-height: 0; 1183 1183 + padding: 12px 0; 1184 1184 + } 1185 1185 + 1186 1186 + .tsd-page-toolbar--hide { 1187 1187 + transform: translateY(-100%); 1188 1188 + } 1189 1189 + 1190 1190 + .tsd-widget { 1191 1191 + display: inline-block; 1192 1192 + overflow: hidden; 1193 1193 + opacity: 0.8; 1194 1194 + height: 40px; 1195 1195 + transition: opacity 0.1s, background-color 0.2s; 1196 1196 + vertical-align: bottom; 1197 1197 + cursor: pointer; 1198 1198 + } 1199 1199 + .tsd-widget:hover { 1200 1200 + opacity: 0.9; 1201 1201 + } 1202 1202 + .tsd-widget.active { 1203 1203 + opacity: 1; 1204 1204 + background-color: var(--color-accent); 1205 1205 + } 1206 1206 + .tsd-widget.no-caption { 1207 1207 + width: 40px; 1208 1208 + } 1209 1209 + .tsd-widget.no-caption:before { 1210 1210 + margin: 0; 1211 1211 + } 1212 1212 + 1213 1213 + .tsd-widget.options, 1214 1214 + .tsd-widget.menu { 1215 1215 + display: none; 1216 1216 + } 1217 1217 + @media (max-width: 1024px) { 1218 1218 + .tsd-widget.options, 1219 1219 + .tsd-widget.menu { 1220 1220 + display: inline-block; 1221 1221 + } 1222 1222 + } 1223 1223 + input[type="checkbox"] + .tsd-widget:before { 1224 1224 + background-position: -120px 0; 1225 1225 + } 1226 1226 + input[type="checkbox"]:checked + .tsd-widget:before { 1227 1227 + background-position: -160px 0; 1228 1228 + } 1229 1229 + 1230 1230 + img { 1231 1231 + max-width: 100%; 1232 1232 + } 1233 1233 + 1234 1234 + .tsd-anchor-icon { 1235 1235 + display: inline-flex; 1236 1236 + align-items: center; 1237 1237 + margin-left: 0.5rem; 1238 1238 + vertical-align: middle; 1239 1239 + color: var(--color-text); 1240 1240 + } 1241 1241 + 1242 1242 + .tsd-anchor-icon svg { 1243 1243 + width: 1em; 1244 1244 + height: 1em; 1245 1245 + visibility: hidden; 1246 1246 + } 1247 1247 + 1248 1248 + .tsd-anchor-link:hover > .tsd-anchor-icon svg { 1249 1249 + visibility: visible; 1250 1250 + } 1251 1251 + 1252 1252 + .deprecated { 1253 1253 + text-decoration: line-through; 1254 1254 + } 1255 1255 + 1256 1256 + .warning { 1257 1257 + padding: 1rem; 1258 1258 + color: var(--color-warning-text); 1259 1259 + background: var(--color-background-warning); 1260 1260 + } 1261 1261 + 1262 1262 + * { 1263 1263 + scrollbar-width: thin; 1264 1264 + scrollbar-color: var(--color-accent) var(--color-icon-background); 1265 1265 + } 1266 1266 + 1267 1267 + *::-webkit-scrollbar { 1268 1268 + width: 0.75rem; 1269 1269 + } 1270 1270 + 1271 1271 + *::-webkit-scrollbar-track { 1272 1272 + background: var(--color-icon-background); 1273 1273 + } 1274 1274 + 1275 1275 + *::-webkit-scrollbar-thumb { 1276 1276 + background-color: var(--color-accent); 1277 1277 + border-radius: 999rem; 1278 1278 + border: 0.25rem solid var(--color-icon-background); 1279 1279 + }

+62

functions/redactString.html

Reviewed

··· 1 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>redactString | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 2 + <div class="tsd-toolbar-contents container"> 3 3 + <div class="table-cell" id="tsd-search" data-base=".."> 4 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 5 + <div class="field"> 6 6 + <div id="tsd-toolbar-links"><a href="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">GitHub</a></div></div> 7 7 + <ul class="results"> 8 8 + <li class="state loading">Preparing search index...</li> 9 9 + <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">string-sameness Docs</a></div> 10 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 11 + <div class="container container-main"> 12 12 + <div class="col-8 col-content"> 13 13 + <div class="tsd-page-title"> 14 14 + <ul class="tsd-breadcrumb"> 15 15 + <li><a href="../modules.html">string-sameness Docs</a></li> 16 16 + <li><a href="redactString.html">redactString</a></li></ul> 17 17 + <h1>Function redactString</h1></div> 18 18 + <section class="tsd-panel"> 19 19 + <ul class="tsd-signatures tsd-kind-function"> 20 20 + <li class="tsd-signature tsd-anchor-link" id="redactString">redact<wbr/>String<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, visibleCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/RedactOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedactOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#redactString" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li> 21 21 + <li class="tsd-description"> 22 22 + <div class="tsd-parameters"> 23 23 + <h4 class="tsd-parameters-title">Parameters</h4> 24 24 + <ul class="tsd-parameter-list"> 25 25 + <li> 26 26 + <h5>str: <span class="tsd-signature-type">string</span></h5></li> 27 27 + <li> 28 28 + <h5>visibleCount: <span class="tsd-signature-type">number</span></h5></li> 29 29 + <li> 30 30 + <h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/RedactOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedactOptions</a></h5></li></ul></div> 31 31 + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"> 32 32 + <ul> 33 33 + <li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/90214b7/src/index.ts#L7">index.ts:7</a></li></ul></aside></li></ul></section></div> 34 34 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 35 35 + <div class="tsd-navigation settings"> 36 36 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 37 37 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 38 38 + <div class="tsd-accordion-details"> 39 39 + <div class="tsd-filter-visibility"> 40 40 + <h4 class="uppercase">Member Visibility</h4><form> 41 41 + <ul id="tsd-filter-options"> 42 42 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 43 43 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 44 44 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 45 45 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 46 46 + <div class="tsd-theme-toggle"> 47 47 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 48 48 + <nav class="tsd-navigation primary"> 49 49 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 50 50 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 51 51 + <div class="tsd-accordion-details"> 52 52 + <ul> 53 53 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 54 54 + <ul></ul></li></ul></div></details></nav> 55 55 + <nav class="tsd-navigation secondary menu-sticky"> 56 56 + <ul> 57 57 + <li class="tsd-kind-interface"><a href="../interfaces/RedactOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Redact<wbr/>Options</a></li> 58 58 + <li class="current tsd-kind-function"><a href="redactString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>redact<wbr/>String</a></li> 59 59 + <li class="tsd-kind-reference"><a href="../modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>default</a></li></ul></nav></div></div> 60 60 + <div class="container tsd-generator"> 61 61 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 62 62 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+80

index.html

Reviewed

··· 1 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 2 + <div class="tsd-toolbar-contents container"> 3 3 + <div class="table-cell" id="tsd-search" data-base="."> 4 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 5 + <div class="field"> 6 6 + <div id="tsd-toolbar-links"><a href="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">GitHub</a></div></div> 7 7 + <ul class="results"> 8 8 + <li class="state loading">Preparing search index...</li> 9 9 + <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">string-sameness Docs</a></div> 10 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 11 + <div class="container container-main"> 12 12 + <div class="col-8 col-content"> 13 13 + <div class="tsd-page-title"> 14 14 + <h2>string-sameness Docs</h2></div> 15 15 + <div class="tsd-panel tsd-typography"> 16 16 + <a href="#redact-string" id="redact-string" style="color: inherit; text-decoration: none;"> 17 17 + <h1>redact-string</h1> 18 18 + </a> 19 19 + <p>Redact (replace) part or all of a string with a character.</p> 20 20 + 21 21 + <a href="#why-another-react-package" id="why-another-react-package" style="color: inherit; text-decoration: none;"> 22 22 + <h2>Why another react package?</h2> 23 23 + </a> 24 24 + <p>The other popular packages seem to be restricted to a certain behavior:</p> 25 25 + <ul> 26 26 + <li>Redaction of objects/json (instead of plain variables/values you control)</li> 27 27 + <li>Redaction <strong>entirely</strong> replaces value leaving no structure or hint of what it was</li> 28 28 + </ul> 29 29 + <p>This didn&#39;t fit my needs. I wanted to be able to control how many characters were replaced as well as leave part of the structure intact for hinting in logging. A prime example being replacing <em>part</em> of an IP address so users can view/post logs which confirm correct settings but don&#39;t give away full addresses IE <code>192.168.1.105</code> -&gt; <code>**********105</code></p> 30 30 + 31 31 + <a href="#installusage" id="installusage" style="color: inherit; text-decoration: none;"> 32 32 + <h1>Install/Usage</h1> 33 33 + </a> 34 34 + <pre><code><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> @</span><span class="hl-0">foxxmd</span><span class="hl-1">/</span><span class="hl-0">react</span><span class="hl-1">-</span><span class="hl-0">string</span> 35 35 + </code></pre> 36 36 + <pre><code class="language-js"><span class="hl-2">import</span><span class="hl-1"> {</span><span class="hl-0">reactString</span><span class="hl-1">} </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@foxxmd/redact-string&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">reactString</span><span class="hl-1">(</span><span class="hl-3">&#39;192.168.1.105&#39;</span><span class="hl-1">, </span><span class="hl-5">3</span><span class="hl-1">)); </span><span class="hl-6">// 3 is the number of character to leave visible</span><br/><span class="hl-6">// *********105</span> 37 37 + </code></pre> 38 38 + 39 39 + <a href="#options" id="options" style="color: inherit; text-decoration: none;"> 40 40 + <h1>Options</h1> 41 41 + </a> 42 42 + <p>An optional, third argument can be passed that defines how the redact occurs:</p> 43 43 + <pre><code class="language-ts"><span class="hl-2">export</span><span class="hl-1"> </span><span class="hl-7">interface</span><span class="hl-1"> </span><span class="hl-8">RedactOptions</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">/**</span><br/><span class="hl-6"> * Replace characters starting at the start or end of string (default start)</span><br/><span class="hl-6"> * */</span><br/><span class="hl-1"> </span><span class="hl-0">replaceFrom</span><span class="hl-1">?: </span><span class="hl-3">&#39;start&#39;</span><span class="hl-1"> | </span><span class="hl-3">&#39;end&#39;</span><br/><span class="hl-1"> </span><span class="hl-6">/**</span><br/><span class="hl-6"> * The character/string that characters are replaced with (default &#39;*&#39;)</span><br/><span class="hl-6"> * */</span><br/><span class="hl-1"> </span><span class="hl-0">replaceWith</span><span class="hl-1">?: </span><span class="hl-8">string</span><br/><span class="hl-1"> </span><span class="hl-6">/**</span><br/><span class="hl-6"> * Which type of characters to replace in the string (default any)</span><br/><span class="hl-6"> * */</span><br/><span class="hl-1"> </span><span class="hl-0">replace</span><span class="hl-1">?: </span><span class="hl-3">&#39;any&#39;</span><span class="hl-1"> | </span><span class="hl-3">&#39;alphanumeric&#39;</span><span class="hl-1"> | </span><span class="hl-3">&#39;alpha&#39;</span><span class="hl-1"> | </span><span class="hl-3">&#39;numeric&#39;</span><br/><span class="hl-1">}</span> 44 44 + </code></pre> 45 45 + 46 46 + <a href="#examples" id="examples" style="color: inherit; text-decoration: none;"> 47 47 + <h1>Examples</h1> 48 48 + </a> 49 49 + <pre><code class="language-js"><br/><span class="hl-6">// replace all but last 3 characters</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">reactString</span><span class="hl-1">(</span><span class="hl-3">&#39;192.168.1.105&#39;</span><span class="hl-1">, </span><span class="hl-5">3</span><span class="hl-1">));</span><br/><span class="hl-6">// *********105</span><br/><br/><span class="hl-6">// replace all but first 3 characters</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">reactString</span><span class="hl-1">(</span><span class="hl-3">&#39;192.168.1.105&#39;</span><span class="hl-1">, </span><span class="hl-5">3</span><span class="hl-1">, {</span><span class="hl-0">replaceFrom:</span><span class="hl-1"> </span><span class="hl-3">&#39;end&#39;</span><span class="hl-1">}));</span><br/><span class="hl-6">// 192**********</span><br/><br/><span class="hl-6">// replace all but last 3 characters, numeric only</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">reactString</span><span class="hl-1">(</span><span class="hl-3">&#39;192.168.1.105&#39;</span><span class="hl-1">, </span><span class="hl-5">3</span><span class="hl-1">, {</span><span class="hl-0">replace:</span><span class="hl-1"> </span><span class="hl-3">&#39;numeric&#39;</span><span class="hl-1">}));</span><br/><span class="hl-6">// ***.***.*.105</span><br/><br/><span class="hl-6">// replace all but last 5 characters with &#39;X&#39;</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-4">log</span><span class="hl-1">(</span><span class="hl-4">reactString</span><span class="hl-1">(</span><span class="hl-3">&#39;superSecretPassword&#39;</span><span class="hl-1">, </span><span class="hl-5">5</span><span class="hl-1">, {</span><span class="hl-0">replaceWith:</span><span class="hl-1"> </span><span class="hl-3">&#39;X&#39;</span><span class="hl-1">}));</span><br/><span class="hl-6">// XXXXXXXXXXXXXXsword</span> 50 50 + </code></pre> 51 51 + </div></div> 52 52 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 53 53 + <div class="tsd-navigation settings"> 54 54 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 55 55 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 56 56 + <div class="tsd-accordion-details"> 57 57 + <div class="tsd-filter-visibility"> 58 58 + <h4 class="uppercase">Member Visibility</h4><form> 59 59 + <ul id="tsd-filter-options"> 60 60 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 61 61 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 62 62 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 63 63 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 64 64 + <div class="tsd-theme-toggle"> 65 65 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 66 66 + <nav class="tsd-navigation primary"> 67 67 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 68 68 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 69 69 + <div class="tsd-accordion-details"> 70 70 + <ul> 71 71 + <li class="current selected"><a href="modules.html">string-<wbr/>sameness <wbr/>Docs</a> 72 72 + <ul></ul></li></ul></div></details></nav> 73 73 + <nav class="tsd-navigation secondary menu-sticky"> 74 74 + <ul> 75 75 + <li class="tsd-kind-interface"><a href="interfaces/RedactOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Redact<wbr/>Options</a></li> 76 76 + <li class="tsd-kind-function"><a href="functions/redactString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>redact<wbr/>String</a></li> 77 77 + <li class="tsd-kind-reference"><a href="modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg>default</a></li></ul></nav></div></div> 78 78 + <div class="container tsd-generator"> 79 79 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 80 80 + <div class="overlay"></div><script src="assets/main.js"></script></body></html>

+82

interfaces/RedactOptions.html

Reviewed

··· 1 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RedactOptions | string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 2 + <div class="tsd-toolbar-contents container"> 3 3 + <div class="table-cell" id="tsd-search" data-base=".."> 4 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 5 + <div class="field"> 6 6 + <div id="tsd-toolbar-links"><a href="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">GitHub</a></div></div> 7 7 + <ul class="results"> 8 8 + <li class="state loading">Preparing search index...</li> 9 9 + <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">string-sameness Docs</a></div> 10 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 11 + <div class="container container-main"> 12 12 + <div class="col-8 col-content"> 13 13 + <div class="tsd-page-title"> 14 14 + <ul class="tsd-breadcrumb"> 15 15 + <li><a href="../modules.html">string-sameness Docs</a></li> 16 16 + <li><a href="RedactOptions.html">RedactOptions</a></li></ul> 17 17 + <h1>Interface RedactOptions</h1></div> 18 18 + <section class="tsd-panel tsd-hierarchy"> 19 19 + <h4>Hierarchy</h4> 20 20 + <ul class="tsd-hierarchy"> 21 21 + <li><span class="target">RedactOptions</span></li></ul></section><aside class="tsd-sources"> 22 22 + <ul> 23 23 + <li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/90214b7/src/index.ts#L1">index.ts:1</a></li></ul></aside> 24 24 + <section class="tsd-panel-group tsd-index-group"> 25 25 + <section class="tsd-panel tsd-index-panel"> 26 26 + <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> 27 27 + <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> 28 28 + <div class="tsd-accordion-details"> 29 29 + <section class="tsd-index-section"> 30 30 + <h3 class="tsd-index-heading">Properties</h3> 31 31 + <div class="tsd-index-list"><a href="RedactOptions.html#replaceFrom" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>replace<wbr/>From?</span></a> 32 32 + <a href="RedactOptions.html#replaceWith" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>replace<wbr/>With?</span></a> 33 33 + <a href="RedactOptions.html#replace" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>replace?</span></a> 34 34 + </div></section></div></details></section></section> 35 35 + <section class="tsd-panel-group tsd-member-group"> 36 36 + <h2>Properties</h2> 37 37 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replaceFrom" class="tsd-anchor"></a> 38 38 + <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace<wbr/>From</span><a href="#replaceFrom" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3> 39 39 + <div class="tsd-signature">replace<wbr/>From<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;start&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;end&quot;</span></div><aside class="tsd-sources"> 40 40 + <ul> 41 41 + <li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/90214b7/src/index.ts#L2">index.ts:2</a></li></ul></aside></section> 42 42 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replaceWith" class="tsd-anchor"></a> 43 43 + <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace<wbr/>With</span><a href="#replaceWith" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 44 44 + <div class="tsd-signature">replace<wbr/>With<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"> 45 45 + <ul> 46 46 + <li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/90214b7/src/index.ts#L3">index.ts:3</a></li></ul></aside></section> 47 47 + <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replace" class="tsd-anchor"></a> 48 48 + <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>replace</span><a href="#replace" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> 49 49 + <div class="tsd-signature">replace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;any&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;alphanumeric&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;alpha&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;numeric&quot;</span></div><aside class="tsd-sources"> 50 50 + <ul> 51 51 + <li>Defined in <a href="https://github.com/FoxxMD/redact-string/blob/90214b7/src/index.ts#L4">index.ts:4</a></li></ul></aside></section></section></div> 52 52 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 53 53 + <div class="tsd-navigation settings"> 54 54 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 55 55 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 56 56 + <div class="tsd-accordion-details"> 57 57 + <div class="tsd-filter-visibility"> 58 58 + <h4 class="uppercase">Member Visibility</h4><form> 59 59 + <ul id="tsd-filter-options"> 60 60 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 61 61 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 62 62 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 63 63 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 64 64 + <div class="tsd-theme-toggle"> 65 65 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 66 66 + <nav class="tsd-navigation primary"> 67 67 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 68 68 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 69 69 + <div class="tsd-accordion-details"> 70 70 + <ul> 71 71 + <li><a href="../modules.html">string-<wbr/>sameness <wbr/>Docs</a> 72 72 + <ul></ul></li></ul></div></details></nav> 73 73 + <nav class="tsd-navigation secondary menu-sticky"> 74 74 + <ul> 75 75 + <li class="current tsd-kind-interface"><a href="RedactOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Redact<wbr/>Options</span></a> 76 76 + <ul> 77 77 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RedactOptions.html#replaceFrom" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>replace<wbr/>From?</a></li> 78 78 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RedactOptions.html#replaceWith" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>replace<wbr/>With?</a></li> 79 79 + <li class="tsd-kind-property tsd-parent-kind-interface"><a href="RedactOptions.html#replace" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>replace?</a></li></ul></li></ul></nav></div></div> 80 80 + <div class="container tsd-generator"> 81 81 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 82 82 + <div class="overlay"></div><script src="../assets/main.js"></script></body></html>

+64

modules.html

Reviewed

··· 1 1 + <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>string-sameness Docs</title><meta name="description" content="Documentation for string-sameness Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> 2 2 + <div class="tsd-toolbar-contents container"> 3 3 + <div class="table-cell" id="tsd-search" data-base="."> 4 4 + <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> 5 5 + <div class="field"> 6 6 + <div id="tsd-toolbar-links"><a href="http://foxxmd.github.io/string-sameness">Docs</a><a href="https://github.com/foxxmd/string-sameness">GitHub</a></div></div> 7 7 + <ul class="results"> 8 8 + <li class="state loading">Preparing search index...</li> 9 9 + <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">string-sameness Docs</a></div> 10 10 + <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> 11 11 + <div class="container container-main"> 12 12 + <div class="col-8 col-content"> 13 13 + <div class="tsd-page-title"> 14 14 + <h2>string-sameness Docs</h2></div> 15 15 + <section class="tsd-panel-group tsd-index-group"> 16 16 + <section class="tsd-panel tsd-index-panel"> 17 17 + <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> 18 18 + <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> 19 19 + <div class="tsd-accordion-details"> 20 20 + <section class="tsd-index-section"> 21 21 + <h3 class="tsd-index-heading">Interfaces</h3> 22 22 + <div class="tsd-index-list"><a href="interfaces/RedactOptions.html" class="tsd-index-link tsd-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Redact<wbr/>Options</span></a> 23 23 + </div></section> 24 24 + <section class="tsd-index-section"> 25 25 + <h3 class="tsd-index-heading">Functions</h3> 26 26 + <div class="tsd-index-list"><a href="functions/redactString.html" class="tsd-index-link tsd-kind-function"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg><span>redact<wbr/>String</span></a> 27 27 + </div></section> 28 28 + <section class="tsd-index-section"> 29 29 + <h3 class="tsd-index-heading">References</h3> 30 30 + <div class="tsd-index-list"><a href="modules.html#default" class="tsd-index-link tsd-kind-reference"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg><span>default</span></a> 31 31 + </div></section></div></details></section></section> 32 32 + <section class="tsd-panel-group tsd-member-group"> 33 33 + <h2>References</h2> 34 34 + <section class="tsd-panel tsd-member tsd-kind-reference"><a id="default" class="tsd-anchor"></a> 35 35 + <h3 class="tsd-anchor-link"><span>default</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>Renames and re-exports <a href="functions/redactString.html">redactString</a></section></section></div> 36 36 + <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> 37 37 + <div class="tsd-navigation settings"> 38 38 + <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> 39 39 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> 40 40 + <div class="tsd-accordion-details"> 41 41 + <div class="tsd-filter-visibility"> 42 42 + <h4 class="uppercase">Member Visibility</h4><form> 43 43 + <ul id="tsd-filter-options"> 44 44 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> 45 45 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> 46 46 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> 47 47 + <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> 48 48 + <div class="tsd-theme-toggle"> 49 49 + <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> 50 50 + <nav class="tsd-navigation primary"> 51 51 + <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> 52 52 + <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> 53 53 + <div class="tsd-accordion-details"> 54 54 + <ul> 55 55 + <li class="current selected"><a href="modules.html">string-<wbr/>sameness <wbr/>Docs</a> 56 56 + <ul></ul></li></ul></div></details></nav> 57 57 + <nav class="tsd-navigation secondary menu-sticky"> 58 58 + <ul> 59 59 + <li class="tsd-kind-interface"><a href="interfaces/RedactOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Redact<wbr/>Options</a></li> 60 60 + <li class="tsd-kind-function"><a href="functions/redactString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>redact<wbr/>String</a></li> 61 61 + <li class="tsd-kind-reference"><a href="modules.html#default" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>default</a></li></ul></nav></div></div> 62 62 + <div class="container tsd-generator"> 63 63 + <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> 64 64 + <div class="overlay"></div><script src="assets/main.js"></script></body></html>