diff --git a/assets/highlight.css b/assets/highlight.css index 736d0ce..8f00172 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -7,28 +7,16 @@ --dark-hl-2: #9CDCFE; --light-hl-3: #A31515; --dark-hl-3: #CE9178; - --light-hl-4: #CD3131; - --dark-hl-4: #F44747; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #795E26; - --dark-hl-7: #DCDCAA; - --light-hl-8: #008000; - --dark-hl-8: #6A9955; - --light-hl-9: #098658; - --dark-hl-9: #B5CEA8; - --light-hl-10: #800000; - --dark-hl-10: #808080; - --light-hl-11: #800000; - --dark-hl-11: #569CD6; - --light-hl-12: #000000FF; - --dark-hl-12: #D4D4D4; - --light-hl-13: #E50000; - --dark-hl-13: #9CDCFE; - --light-hl-14: #0000FF; - --dark-hl-14: #CE9178; + --light-hl-4: #0000FF; + --dark-hl-4: #569CD6; + --light-hl-5: #0070C1; + --dark-hl-5: #4FC1FF; + --light-hl-6: #795E26; + --dark-hl-6: #DCDCAA; + --light-hl-7: #008000; + --dark-hl-7: #6A9955; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -43,12 +31,6 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } } @@ -62,12 +44,6 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } } @@ -81,12 +57,6 @@ --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --hl-14: var(--light-hl-14); --code-background: var(--light-code-background); } @@ -100,12 +70,6 @@ --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --hl-14: var(--dark-hl-14); --code-background: var(--dark-code-background); } @@ -118,10 +82,4 @@ .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } .hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } -.hl-14 { color: var(--hl-14); } pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js index f7c8366..01bcad5 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"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;i0){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. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ou?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;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var 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=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;u1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof 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{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;ii.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-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;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${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)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};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; } -`}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});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 0000000..d10ae67 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5WUy27CMBBF/8XdkhZooIItrapuaESkblAWIRmIVceObAdRVfx7nZAHMcFxl/Zcnzsej2f7iyScJFoiTGM4oRHKQpmoZcrinIB4KrcfE5kSFftWK7ScjlCUYBJzoGi5bQAf3trfsFxiejBhHrq6C9KdLNznsXsedWgtBlMJfB9GDakIa1nN5trxFUszRoFKMQBqhSakl+8IFslnJjGjJmRXaEJuILOF6lIzVjByhNe1b8PVtBZga6oFsiqWx9mBgxBvx+57yZ9Mr2tXqrHHi5fJbNpXYhuHO+Jhj/K2dg490iE+zq6Lvc9pVJa1QhZRZ9JlzF3tuA8EIsm4GVOrdJj68CQUoriLiB0sHAUGTkOCNJuvkOA4HPRpZP8wCq6s+L0xUwWs5tU7SFMj16hWNjRvboZfD+1KZ/4VVrm1Msvc+luzJzm7xowT2ffQNU+FDW2pvprId6bzF8UNIjgHf5nrFU23BgAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 73cece1..ecb8b7b 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"64\":\"Function\",\"256\":\"Interface\",\"1024\":\"Property\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":2,\"name\":\"@helia/ipns-interop\",\"url\":\"modules/_helia_ipns_interop.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":2,\"name\":\"@helia/ipns\",\"url\":\"modules/_helia_ipns.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":64,\"name\":\"ipns\",\"url\":\"functions/_helia_ipns.ipns-1.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":4194304,\"name\":\"PublishProgressEvents\",\"url\":\"types/_helia_ipns.PublishProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":4194304,\"name\":\"ResolveProgressEvents\",\"url\":\"types/_helia_ipns.ResolveProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":4194304,\"name\":\"RepublishProgressEvents\",\"url\":\"types/_helia_ipns.RepublishProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":256,\"name\":\"PublishOptions\",\"url\":\"interfaces/_helia_ipns.PublishOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"lifetime\",\"url\":\"interfaces/_helia_ipns.PublishOptions.html#lifetime\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.PublishOptions\"},{\"kind\":1024,\"name\":\"offline\",\"url\":\"interfaces/_helia_ipns.PublishOptions.html#offline\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.PublishOptions\"},{\"kind\":256,\"name\":\"ResolveOptions\",\"url\":\"interfaces/_helia_ipns.ResolveOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"offline\",\"url\":\"interfaces/_helia_ipns.ResolveOptions.html#offline\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.ResolveOptions\"},{\"kind\":256,\"name\":\"ResolveDNSOptions\",\"url\":\"interfaces/_helia_ipns.ResolveDNSOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"nocache\",\"url\":\"interfaces/_helia_ipns.ResolveDNSOptions.html#nocache\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.ResolveDNSOptions\"},{\"kind\":1024,\"name\":\"offline\",\"url\":\"interfaces/_helia_ipns.ResolveDNSOptions.html#offline\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"@helia/ipns.ResolveDNSOptions\"},{\"kind\":256,\"name\":\"RepublishOptions\",\"url\":\"interfaces/_helia_ipns.RepublishOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"interval\",\"url\":\"interfaces/_helia_ipns.RepublishOptions.html#interval\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.RepublishOptions\"},{\"kind\":256,\"name\":\"IPNS\",\"url\":\"interfaces/_helia_ipns.IPNS.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"publish\",\"url\":\"interfaces/_helia_ipns.IPNS.html#publish\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNS\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNS.html#publish.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNS.publish\"},{\"kind\":1024,\"name\":\"resolve\",\"url\":\"interfaces/_helia_ipns.IPNS.html#resolve\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNS\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNS.html#resolve.__type-4\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNS.resolve\"},{\"kind\":1024,\"name\":\"resolveDns\",\"url\":\"interfaces/_helia_ipns.IPNS.html#resolveDns\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNS\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNS.html#resolveDns.__type-6\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNS.resolveDns\"},{\"kind\":1024,\"name\":\"republish\",\"url\":\"interfaces/_helia_ipns.IPNS.html#republish\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNS\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNS.html#republish.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNS.republish\"},{\"kind\":256,\"name\":\"IPNSComponents\",\"url\":\"interfaces/_helia_ipns.IPNSComponents.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"datastore\",\"url\":\"interfaces/_helia_ipns.IPNSComponents.html#datastore\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNSComponents\"},{\"kind\":256,\"name\":\"IPNSRouting\",\"url\":\"interfaces/_helia_ipns.IPNSRouting.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":1024,\"name\":\"put\",\"url\":\"interfaces/_helia_ipns.IPNSRouting.html#put\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNSRouting\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNSRouting.html#put.__type-2\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNSRouting.put\"},{\"kind\":1024,\"name\":\"get\",\"url\":\"interfaces/_helia_ipns.IPNSRouting.html#get\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"@helia/ipns.IPNSRouting\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/_helia_ipns.IPNSRouting.html#get.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"@helia/ipns.IPNSRouting.get\"},{\"kind\":2,\"name\":\"\",\"url\":\"modules/_helia_ipns._internal_.html\",\"classes\":\"tsd-kind-module tsd-parent-kind-module\",\"parent\":\"@helia/ipns\"},{\"kind\":4194304,\"name\":\"IPNSRoutingEvents\",\"url\":\"types/_helia_ipns._internal_.IPNSRoutingEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"},{\"kind\":256,\"name\":\"PutOptions\",\"url\":\"interfaces/_helia_ipns._internal_.PutOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"},{\"kind\":256,\"name\":\"GetOptions\",\"url\":\"interfaces/_helia_ipns._internal_.GetOptions.html\",\"classes\":\"tsd-kind-interface tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"},{\"kind\":4194304,\"name\":\"DatastoreProgressEvents\",\"url\":\"types/_helia_ipns._internal_.DatastoreProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"},{\"kind\":4194304,\"name\":\"DHTProgressEvents\",\"url\":\"types/_helia_ipns._internal_.DHTProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"},{\"kind\":4194304,\"name\":\"PubSubProgressEvents\",\"url\":\"types/_helia_ipns._internal_.PubSubProgressEvents.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"@helia/ipns.\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,19.966,1,23.645]],[\"comment/0\",[]],[\"name/1\",[0,28.012]],[\"comment/1\",[]],[\"name/2\",[2,28.012]],[\"comment/2\",[]],[\"name/3\",[3,33.173]],[\"comment/3\",[]],[\"name/4\",[4,33.173]],[\"comment/4\",[]],[\"name/5\",[5,33.173]],[\"comment/5\",[]],[\"name/6\",[6,33.173]],[\"comment/6\",[]],[\"name/7\",[7,33.173]],[\"comment/7\",[]],[\"name/8\",[8,24.613]],[\"comment/8\",[]],[\"name/9\",[9,33.173]],[\"comment/9\",[]],[\"name/10\",[8,24.613]],[\"comment/10\",[]],[\"name/11\",[10,33.173]],[\"comment/11\",[]],[\"name/12\",[11,33.173]],[\"comment/12\",[]],[\"name/13\",[8,24.613]],[\"comment/13\",[]],[\"name/14\",[12,33.173]],[\"comment/14\",[]],[\"name/15\",[13,33.173]],[\"comment/15\",[]],[\"name/16\",[2,28.012]],[\"comment/16\",[]],[\"name/17\",[14,33.173]],[\"comment/17\",[]],[\"name/18\",[15,18.359]],[\"comment/18\",[]],[\"name/19\",[16,33.173]],[\"comment/19\",[]],[\"name/20\",[15,18.359]],[\"comment/20\",[]],[\"name/21\",[17,33.173]],[\"comment/21\",[]],[\"name/22\",[15,18.359]],[\"comment/22\",[]],[\"name/23\",[18,33.173]],[\"comment/23\",[]],[\"name/24\",[15,18.359]],[\"comment/24\",[]],[\"name/25\",[19,33.173]],[\"comment/25\",[]],[\"name/26\",[20,33.173]],[\"comment/26\",[]],[\"name/27\",[21,33.173]],[\"comment/27\",[]],[\"name/28\",[22,33.173]],[\"comment/28\",[]],[\"name/29\",[15,18.359]],[\"comment/29\",[]],[\"name/30\",[23,33.173]],[\"comment/30\",[]],[\"name/31\",[15,18.359]],[\"comment/31\",[]],[\"name/32\",[24,33.173]],[\"comment/32\",[]],[\"name/33\",[25,33.173]],[\"comment/33\",[]],[\"name/34\",[26,33.173]],[\"comment/34\",[]],[\"name/35\",[27,33.173]],[\"comment/35\",[]],[\"name/36\",[28,33.173]],[\"comment/36\",[]],[\"name/37\",[29,33.173]],[\"comment/37\",[]],[\"name/38\",[30,33.173]],[\"comment/38\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":15,\"name\":{\"18\":{},\"20\":{},\"22\":{},\"24\":{},\"29\":{},\"31\":{}},\"comment\":{}}],[\"datastore\",{\"_index\":20,\"name\":{\"26\":{}},\"comment\":{}}],[\"datastoreprogressevents\",{\"_index\":28,\"name\":{\"36\":{}},\"comment\":{}}],[\"dhtprogressevents\",{\"_index\":29,\"name\":{\"37\":{}},\"comment\":{}}],[\"get\",{\"_index\":23,\"name\":{\"30\":{}},\"comment\":{}}],[\"getoptions\",{\"_index\":27,\"name\":{\"35\":{}},\"comment\":{}}],[\"helia/ipns\",{\"_index\":0,\"name\":{\"0\":{},\"1\":{}},\"comment\":{}}],[\"internal\",{\"_index\":24,\"name\":{\"32\":{}},\"comment\":{}}],[\"interop\",{\"_index\":1,\"name\":{\"0\":{}},\"comment\":{}}],[\"interval\",{\"_index\":13,\"name\":{\"15\":{}},\"comment\":{}}],[\"ipns\",{\"_index\":2,\"name\":{\"2\":{},\"16\":{}},\"comment\":{}}],[\"ipnscomponents\",{\"_index\":19,\"name\":{\"25\":{}},\"comment\":{}}],[\"ipnsrouting\",{\"_index\":21,\"name\":{\"27\":{}},\"comment\":{}}],[\"ipnsroutingevents\",{\"_index\":25,\"name\":{\"33\":{}},\"comment\":{}}],[\"lifetime\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"nocache\",{\"_index\":11,\"name\":{\"12\":{}},\"comment\":{}}],[\"offline\",{\"_index\":8,\"name\":{\"8\":{},\"10\":{},\"13\":{}},\"comment\":{}}],[\"publish\",{\"_index\":14,\"name\":{\"17\":{}},\"comment\":{}}],[\"publishoptions\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"publishprogressevents\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"pubsubprogressevents\",{\"_index\":30,\"name\":{\"38\":{}},\"comment\":{}}],[\"put\",{\"_index\":22,\"name\":{\"28\":{}},\"comment\":{}}],[\"putoptions\",{\"_index\":26,\"name\":{\"34\":{}},\"comment\":{}}],[\"republish\",{\"_index\":18,\"name\":{\"23\":{}},\"comment\":{}}],[\"republishoptions\",{\"_index\":12,\"name\":{\"14\":{}},\"comment\":{}}],[\"republishprogressevents\",{\"_index\":5,\"name\":{\"5\":{}},\"comment\":{}}],[\"resolve\",{\"_index\":16,\"name\":{\"19\":{}},\"comment\":{}}],[\"resolvedns\",{\"_index\":17,\"name\":{\"21\":{}},\"comment\":{}}],[\"resolvednsoptions\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"resolveoptions\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}],[\"resolveprogressevents\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA8VZTW/jRgz9L/JV8ZocSf64tkWxl22wC/RiBIHXlhOhtmRYctoiyH/vjL6Go5CyFAPpJYIiPpKPj8PRyK/eOfs791brV++vJN15K/S9dHOMvZWnb+N/PN+7nA/67pjtLoc4/1L+d/pcHA/60fawyfNYwz3vzW88BLAM1Cxo/Xy9//bje3YpkvSpx9vENSOefe+0Ocdp0aZkQ2EYOWFa/0laxOf9ZtuGME+ZrHt8wwwth9Pl5yHJnwf4n1jTnjilPQkWhaGyVB4fi39P8Yhg0xZxLea0SU8geo5HUKXGn0C2DVfTvcMhhG2SIuU8O7wMzKAx/RS6ZbCGbDCMbJVgP9Vf03xEApX15xHW8RrO0QjOJk15MvySHU9ZqrFXmFu7G6bFblNs8iI7X2HdiTWhsGusCR+e9H3V9H+ciiTrk9u1u4H0IdnHRXLs4cyEmhBUH+UOGyGFbL8/JOnIDCzoQwnQmn9vRs3Vqnctb6h76ftlcxgZbEJwfcTfcZKoV4vw248B3DumN5BPs+1m+9yjOB9sYnH93LukPtp4Qhpc7xX57i7J75L0OT4nRbwblxajyVBBbldjaBk+sP46XAjh2XIOIXbn3v05e9IbQ/7bizPzza7SGQau5Tj23eDtYhkQXrC9NYGyTIPCM5bjgkdkCJ1Ig+0v6baUqQ5lHt7BSGL2nUU4OtT/7z2K0NXwe1z0rITGm7Xqz7fJSn7j6B55mGDEbGw0Z909xcWYMJPKvjcUBX3g1a4v9LXDCoc1GYtHs3HkK/v/hbwOff3owqFNztJr3pCutlaju7ozYEhW7HBhsh8yWt4HJsNl91wws6WJpJ/e4FvP4Pzys8d9ZTAwwoNfD7LVq/cSn3PtST/GqZoutf0+iQ87862lCq69Zcej8fBQP/sz3urXf2NRmXyZef565iuchgt4ePDXDaJ8UP6jNAN9Bz7Op8FcOWbgmOmeWyNnho6Z0neKC6ocM30eXQc+zKdLWDhmgWMW6ruQ8xY6ZpHkLXLM5vou4rzNHbOF5G3hmGlR1nPO29It70xyBx0dTL0XnENwlQBT8SVr6GoBpubAtgC4coApOwBr6SoCpvKgGyGYwqzDxxUFTPGB7QVwdQFTfwhYS1caMBIA2xHgqgNGBWDVBlcgnImM0FUIy6XCao6dxYKyT1cjLDViZUdXIyw1YnVHVyM0QiCrO7oaYSSualciNDog2yDoSoRGB0TW0pUIl9LkQVchZWRAfqq4CimQFptyBVLlOGNbTnUGmhJduvooIwKyvalcfVSpD9ubytVHlfqwHadcgVQpENtHqhKo3F70vqJPhV+rbUZvFM17yKv3WO897e726gX6z5vvRdVlUV301CqvuqDVVZnrm92PzJ0JTz5IWe9L610PKwFodmwL0fRbjIoETPlSSjCKYGYyJmvefggULRQXArT+dcOiZhYkhbOfTCwMSLX1qBOAp06GJMFKA5TKYqBb8vHSOlmQwNCDbg9QJGkCreMvr3uIX7opYERECgUP9hMfSYBmEAjA9iMNwZGAIKXcflEgOFJxCGvK9TJAqYvbHzesH9qU/SimL4G0GFyBn+pz+fuaA9Ede7yUr7VEKgJTUp+WZyOCIb2t5CqxazAkUElg8vuRRRKg1FEtjisykQikRdU66CkzmXMoE6h/D7I40qBSlWvUzk2czEipsS2QI04KB9LUqz1wcBIfpXFSw+WqIWlxFOV7P5CQzANk66b3vlNyisuFvVo/vL39B88vIi66HgAA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 496e66f..108428c 100644 --- a/assets/style.css +++ b/assets/style.css @@ -6,17 +6,35 @@ --light-color-background-warning: #e6e600; --light-color-icon-background: var(--light-color-background); --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-ts: #db1373; - --light-color-ts-interface: #139d2c; - --light-color-ts-enum: #9c891a; - --light-color-ts-class: #2484e5; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; --light-color-ts-function: #572be7; - --light-color-ts-namespace: #b111c9; - --light-color-ts-private: #707070; - --light-color-ts-variable: #4d68ff; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: var(--light-color-ts-type-alias); + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; @@ -27,17 +45,35 @@ --dark-color-warning-text: #222; --dark-color-icon-background: var(--dark-color-background-secondary); --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; - --dark-color-ts: #ff6492; - --dark-color-ts-interface: #6cff87; + + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); --dark-color-ts-enum: #f4d93e; - --dark-color-ts-class: #61b0ff; - --dark-color-ts-function: #9772ff; - --dark-color-ts-namespace: #e14dff; - --dark-color-ts-private: #e2e2e2; - --dark-color-ts-variable: #4d68ff; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: var(--dark-color-ts-type-alias); + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; } @@ -50,17 +86,34 @@ --color-warning-text: var(--light-color-warning-text); --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } @@ -74,17 +127,34 @@ --color-warning-text: var(--dark-color-warning-text); --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } @@ -105,17 +175,34 @@ body { --color-warning-text: var(--light-color-warning-text); --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } @@ -127,17 +214,34 @@ body { --color-warning-text: var(--dark-color-warning-text); --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } @@ -156,6 +260,16 @@ h6 { line-height: 1.2; } +h1 > a, +h2 > a, +h3 > a, +h4 > a, +h5 > a, +h6 > a { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -190,12 +304,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -208,26 +316,10 @@ dd { } .container { - max-width: 1600px; + max-width: 1700px; padding: 0 2rem; } -@media (min-width: 640px) { - .container { - padding: 0 4rem; - } -} -@media (min-width: 1200px) { - .container { - padding: 0 8rem; - } -} -@media (min-width: 1600px) { - .container { - padding: 0 12rem; - } -} - /* Footer */ .tsd-generator { border-top: 1px solid var(--color-accent); @@ -243,26 +335,9 @@ dd { } .container-main { - display: flex; - justify-content: space-between; - position: relative; margin: 0 auto; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 2rem 1rem; -} - -.col-4 { - flex: 0 0 25%; -} -.col-8 { - flex: 1 0; - flex-wrap: wrap; - padding-left: 0; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { @@ -305,22 +380,6 @@ dd { opacity: 0; } } -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -369,13 +428,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + border: 1px solid var(--color-accent); } pre code { padding: 0; font-size: 100%; } +pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; +} +pre:hover > button, +pre > button.visible { + opacity: 1; +} blockquote { margin: 1em 0; @@ -391,13 +466,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -408,90 +482,18 @@ blockquote { .tsd-typography ol { margin: 1em 0; } - -@media (max-width: 1024px) { - html .col-content { - float: none; - max-width: 100%; - width: 100%; - padding-top: 3rem; - } - html .col-menu { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - max-width: 25rem; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-menu > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } .tsd-breadcrumb { @@ -672,43 +674,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { -o-page-break-inside: avoid; page-break-inside: avoid; } -.tsd-index-panel a, -.tsd-index-panel a.tsd-parent-kind-module { - color: var(--color-ts); -} -.tsd-index-panel a.tsd-parent-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-parent-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-parent-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-module { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-index-panel a.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-index-panel a.tsd-is-private { - color: var(--color-ts-private); -} .tsd-flag { display: inline-block; @@ -723,7 +688,7 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-anchor { - position: absolute; + position: relative; top: -100px; } @@ -737,108 +702,64 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-bottom: 0; border-bottom: none; } -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); + +.tsd-navigation.settings { + margin: 1rem 0; } -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.5rem); } - -.tsd-navigation a { - display: block; - margin: 0.4rem 0; - border-left: 2px solid transparent; +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: inline-flex; + align-items: center; + padding: 0.25rem; color: var(--color-text); text-decoration: none; - transition: border-left-color 0.1s; + box-sizing: border-box; } -.tsd-navigation a:hover { +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); +} +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { text-decoration: underline; } -.tsd-navigation ul { - margin: 0; +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } -.tsd-navigation li { +.tsd-navigation li, +.tsd-page-navigation li { padding: 0; + max-width: 100%; } - -.tsd-navigation.primary .tsd-accordion-details > ul { - margin-top: 0.75rem; -} -.tsd-navigation.primary a { - padding: 0.75rem 0.5rem; - margin: 0; +.tsd-nested-navigation { + margin-left: 3rem; } -.tsd-navigation.primary ul li a { - margin-left: 0.5rem; +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.primary ul li li a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } -.tsd-navigation.primary ul li li li a { - margin-left: 2.5rem; -} -.tsd-navigation.primary ul li li li li a { - margin-left: 3.5rem; -} -.tsd-navigation.primary ul li li li li li a { - margin-left: 4.5rem; -} -.tsd-navigation.primary ul li li li li li li a { - margin-left: 5.5rem; -} -.tsd-navigation.primary li.current > a { - border-left: 0.15rem var(--color-text) solid; -} -.tsd-navigation.primary li.selected > a { - font-weight: bold; - border-left: 0.2rem var(--color-text) solid; -} -.tsd-navigation.primary ul li a:hover { - border-left: 0.2rem var(--color-text-aside) solid; -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary > ul { - display: inline; - padding-right: 0.5rem; - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 0; +.tsd-nested-navigation > li > a, +.tsd-nested-navigation > li > span { + width: calc(100% - 1.75rem - 0.5rem); } -.tsd-navigation.secondary ul li li a { - padding-left: 1.1rem; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 2.2rem; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 3.3rem; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 4.4rem; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 5.5rem; + +.tsd-page-navigation ul { + padding-left: 1.75rem; } #tsd-sidebar-links a { @@ -851,41 +772,40 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } a.tsd-index-link { - margin: 0.25rem 0; + padding: 0.25rem 0 !important; font-size: 1rem; line-height: 1.25rem; display: inline-flex; align-items: center; + color: var(--color-text); } -.tsd-accordion-summary > h1, -.tsd-accordion-summary > h2, -.tsd-accordion-summary > h3, -.tsd-accordion-summary > h4, -.tsd-accordion-summary > h5 { - display: inline-flex; - align-items: center; - vertical-align: middle; - margin-bottom: 0; +.tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ +} +.tsd-accordion-summary, +.tsd-accordion-summary a { user-select: none; -moz-user-select: none; -webkit-user-select: none; -ms-user-select: none; -} -.tsd-accordion-summary { - display: block; + cursor: pointer; } +.tsd-accordion-summary a { + width: calc(100% - 1.5rem); +} .tsd-accordion-summary > * { margin-top: 0; margin-bottom: 0; padding-top: 0; padding-bottom: 0; } -.tsd-accordion-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -910,34 +830,6 @@ a.tsd-index-link { margin-right: 0.8rem; } -@media (min-width: 1025px) { - .col-content { - margin: 2rem auto; - } - - .menu-sticky-wrap { - position: sticky; - height: calc(100vh - 2rem); - top: 4rem; - right: 0; - padding: 0 1.5rem; - padding-top: 1rem; - margin-top: 3rem; - transition: 0.3s ease-in-out; - transition-property: top, padding-top, padding, height; - overflow-y: auto; - } - .col-menu { - border-left: 1px solid var(--color-accent); - } - .col-menu--hide { - top: 1rem; - } - .col-menu .tsd-navigation:not(:last-child) { - padding-bottom: 1.75rem; - } -} - .tsd-panel { margin-bottom: 2.5rem; } @@ -1018,8 +910,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -1027,12 +920,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -1143,7 +1039,7 @@ ul.tsd-type-parameter-list h5 { } .tsd-page-toolbar { - position: fixed; + position: sticky; z-index: 1; top: 0; left: 0; @@ -1183,16 +1079,14 @@ ul.tsd-type-parameter-list h5 { padding: 12px 0; } -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - .tsd-widget { display: inline-block; overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1214,12 +1108,6 @@ ul.tsd-type-parameter-list h5 { .tsd-widget.menu { display: none; } -@media (max-width: 1024px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} input[type="checkbox"] + .tsd-widget:before { background-position: -120px 0; } @@ -1250,7 +1138,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { @@ -1259,6 +1147,78 @@ img { background: var(--color-background-warning); } +.tsd-kind-project { + color: var(--color-ts-project); +} +.tsd-kind-module { + color: var(--color-ts-module); +} +.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-kind-enum-member { + color: var(--color-ts-enum-member); +} +.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-kind-constructor { + color: var(--color-ts-constructor); +} +.tsd-kind-property { + color: var(--color-ts-property); +} +.tsd-kind-method { + color: var(--color-ts-method); +} +.tsd-kind-call-signature { + color: var(--color-ts-call-signature); +} +.tsd-kind-index-signature { + color: var(--color-ts-index-signature); +} +.tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); +} +.tsd-kind-parameter { + color: var(--color-ts-parameter); +} +.tsd-kind-type-literal { + color: var(--color-ts-type-literal); +} +.tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); +} +.tsd-kind-accessor { + color: var(--color-ts-accessor); +} +.tsd-kind-get-signature { + color: var(--color-ts-get-signature); +} +.tsd-kind-set-signature { + color: var(--color-ts-set-signature); +} +.tsd-kind-type-alias { + color: var(--color-ts-type-alias); +} + +/* if we have a kind icon, don't color the text by kind */ +.tsd-kind-icon ~ span { + color: var(--color-text); +} + * { scrollbar-width: thin; scrollbar-color: var(--color-accent) var(--color-icon-background); @@ -1277,3 +1237,147 @@ img { border-radius: 999rem; border: 0.25rem solid var(--color-icon-background); } + +/* mobile */ +@media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +/* one sidebar */ +@media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } +} +@media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } +} + +/* two sidebars */ +@media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } +} diff --git a/functions/_helia_ipns.ipns-1.html b/functions/_helia_ipns.ipns-1.html deleted file mode 100644 index 8aa05b2..0000000 --- a/functions/_helia_ipns.ipns-1.html +++ /dev/null @@ -1,71 +0,0 @@ -ipns | Documentation
-
- -
-
-
-
- -

Function ipns

-
-
-
-
\ No newline at end of file diff --git a/functions/index.ipns-1.html b/functions/index.ipns-1.html new file mode 100644 index 0000000..12beba4 --- /dev/null +++ b/functions/index.ipns-1.html @@ -0,0 +1,53 @@ +ipns | @helia/ipns - v0.0.0
+
+ +
+
+
+
+ +

Function ipns

+
+
+
+ +
+
\ No newline at end of file diff --git a/functions/index.ipnsSelector.html b/functions/index.ipnsSelector.html new file mode 100644 index 0000000..e7a6d43 --- /dev/null +++ b/functions/index.ipnsSelector.html @@ -0,0 +1,53 @@ +ipnsSelector | @helia/ipns - v0.0.0
+
+ +
+
+
+
+ +

Function ipnsSelector

+
+
    + +
  • +
    +

    Parameters

    +
    +

    Returns number

+
+ +
+
\ No newline at end of file diff --git a/functions/index.ipnsValidator.html b/functions/index.ipnsValidator.html new file mode 100644 index 0000000..73ff139 --- /dev/null +++ b/functions/index.ipnsValidator.html @@ -0,0 +1,53 @@ +ipnsValidator | @helia/ipns - v0.0.0
+
+ +
+
+
+
+ +

Function ipnsValidator

+
+
    + +
  • +
    +

    Parameters

    +
    +

    Returns Promise<void>

+
+ +
+
\ No newline at end of file diff --git a/functions/routing.dht.html b/functions/routing.dht.html new file mode 100644 index 0000000..91b3ceb --- /dev/null +++ b/functions/routing.dht.html @@ -0,0 +1,51 @@ +dht | @helia/ipns - v0.0.0
+
+ +
+
+
+
+ +

Function dht

+
+
+
+ +
+
\ No newline at end of file diff --git a/functions/routing.pubsub.html b/functions/routing.pubsub.html new file mode 100644 index 0000000..8aaf662 --- /dev/null +++ b/functions/routing.pubsub.html @@ -0,0 +1,51 @@ +pubsub | @helia/ipns - v0.0.0
+
+ +
+
+
+
+ +

Function pubsub

+
+
+
+ +
+
\ No newline at end of file diff --git a/index.html b/index.html index 8d7bfc3..0eebaaf 100644 --- a/index.html +++ b/index.html @@ -1,41 +1,86 @@ -Documentation
+@helia/ipns - v0.0.0
-
+
  • The search index is not available
  • @helia/ipns - v0.0.0 +
    -
    +
    -

    Documentation

    -
    - +

    + + Helia logo + +

    + +

    @helia/ipns

    ipfs.tech +Discuss +codecov +CI

    +
    +

    An implementation of IPNS for Helia

    +
    +

    Table of contents

    +

    Structure

    +

    API Docs

    +

    License

    Licensed under either of

    + +

    Contribute

    Contributions welcome! Please check out the issues.

    +

    Also see our contributing document for more information on how we work, and about contributing in general.

    +

    Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

    +

    Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

    +

    +
    +
    + -
    +
    +

    On This Page

    -
    \ No newline at end of file +
  • Table of contents
  • +
  • Structure
  • +
  • API Docs
  • +
  • License
  • +
  • Contribute
  • + +
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.IPNS.html b/interfaces/_helia_ipns.IPNS.html deleted file mode 100644 index 486ed6c..0000000 --- a/interfaces/_helia_ipns.IPNS.html +++ /dev/null @@ -1,162 +0,0 @@ -IPNS | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface IPNS

    -
    -

    Hierarchy

    -
      -
    • IPNS
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    publish: ((key: PeerId, value: PeerId | CID<unknown, number, number, Version>, options?: PublishOptions) => Promise<IPNSEntry>)
    -
    -

    Type declaration

    -
    -
    - -
    republish: ((options?: RepublishOptions) => void)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (options?: RepublishOptions): void
      • -
      • -

        Periodically republish all IPNS records found in the datastore

        -
        -
        -

        Parameters

        -
        -

        Returns void

    -
    - -
    resolve: ((key: PeerId, options?: ResolveOptions) => Promise<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
    -
    - -
    resolveDns: ((domain: string, options?: ResolveDNSOptions) => Promise<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.IPNSComponents.html b/interfaces/_helia_ipns.IPNSComponents.html deleted file mode 100644 index ff2b316..0000000 --- a/interfaces/_helia_ipns.IPNSComponents.html +++ /dev/null @@ -1,71 +0,0 @@ -IPNSComponents | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface IPNSComponents

    -
    -

    Hierarchy

    -
      -
    • IPNSComponents
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.IPNSRouting.html b/interfaces/_helia_ipns.IPNSRouting.html deleted file mode 100644 index 87f08f6..0000000 --- a/interfaces/_helia_ipns.IPNSRouting.html +++ /dev/null @@ -1,110 +0,0 @@ -IPNSRouting | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface IPNSRouting

    -
    -

    Hierarchy

    -
      -
    • IPNSRouting
    -
    -
    -
    - -
    -
    -

    Properties

    -
    get -put -
    -
    -

    Properties

    -
    - -
    get: ((routingKey: Uint8Array, options?: GetOptions) => Promise<Uint8Array>)
    -
    -

    Type declaration

    -
    -
    - -
    put: ((routingKey: Uint8Array, marshaledRecord: Uint8Array, options?: PutOptions) => Promise<void>)
    -
    -

    Type declaration

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.PublishOptions.html b/interfaces/_helia_ipns.PublishOptions.html deleted file mode 100644 index 301ee24..0000000 --- a/interfaces/_helia_ipns.PublishOptions.html +++ /dev/null @@ -1,85 +0,0 @@ -PublishOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface PublishOptions

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    lifetime?: number
    -

    Time duration of the record in ms (default: 24hrs)

    -
    -
    - -
    offline?: boolean
    -

    Only publish to a local datastore (default: false)

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.RepublishOptions.html b/interfaces/_helia_ipns.RepublishOptions.html deleted file mode 100644 index 120ae64..0000000 --- a/interfaces/_helia_ipns.RepublishOptions.html +++ /dev/null @@ -1,76 +0,0 @@ -RepublishOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface RepublishOptions

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    interval?: number
    -

    The republish interval in ms (default: 23hrs)

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.ResolveDNSOptions.html b/interfaces/_helia_ipns.ResolveDNSOptions.html deleted file mode 100644 index 7c373b4..0000000 --- a/interfaces/_helia_ipns.ResolveDNSOptions.html +++ /dev/null @@ -1,85 +0,0 @@ -ResolveDNSOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface ResolveDNSOptions

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    nocache?: boolean
    -

    Do not use cached DNS entries (default: false)

    -
    -
    - -
    offline?: boolean
    -

    Do not query the network for the IPNS record (default: false)

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns.ResolveOptions.html b/interfaces/_helia_ipns.ResolveOptions.html deleted file mode 100644 index d995ea5..0000000 --- a/interfaces/_helia_ipns.ResolveOptions.html +++ /dev/null @@ -1,78 +0,0 @@ -ResolveOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface ResolveOptions

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    offline?: boolean
    -

    Do not query the network for the IPNS record (default: false)

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns._internal_.GetOptions.html b/interfaces/_helia_ipns._internal_.GetOptions.html deleted file mode 100644 index 511c3aa..0000000 --- a/interfaces/_helia_ipns._internal_.GetOptions.html +++ /dev/null @@ -1,62 +0,0 @@ -GetOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface GetOptions

    -
    -

    Hierarchy

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/_helia_ipns._internal_.PutOptions.html b/interfaces/_helia_ipns._internal_.PutOptions.html deleted file mode 100644 index 709143a..0000000 --- a/interfaces/_helia_ipns._internal_.PutOptions.html +++ /dev/null @@ -1,62 +0,0 @@ -PutOptions | Documentation
    -
    - -
    -
    -
    -
    - -

    Interface PutOptions

    -
    -

    Hierarchy

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/index.IPNS.html b/interfaces/index.IPNS.html new file mode 100644 index 0000000..9981984 --- /dev/null +++ b/interfaces/index.IPNS.html @@ -0,0 +1,161 @@ +IPNS | @helia/ipns - v0.0.0
    +
    + +
    +
    +
    +
    + +

    Interface IPNS

    +
    +

    Hierarchy

    +
      +
    • IPNS
    +
    +
    +
    + +
    +
    +

    Properties

    +
    +
    +

    Properties

    +
    + +
    publish: ((key, value, options?) => Promise<IPNSEntry>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (key, value, options?): Promise<IPNSEntry>
      • +
      • +

        Creates an IPNS record signed by the passed PeerId that will resolve to the passed value

        +

        If the valid is a PeerId, a recursive IPNS record will be created.

        +
        +
        +

        Parameters

        +
        +

        Returns Promise<IPNSEntry>

        +
    +
    + +
    republish: ((options?) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (options?): void
      • +
      • +

        Periodically republish all IPNS records found in the datastore

        +
        +
        +

        Parameters

        +
        +

        Returns void

        +
    +
    + +
    resolve: ((key, options?) => Promise<CID<unknown, number, number, Version>>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (key, options?): Promise<CID<unknown, number, number, Version>>
      • +
      • +

        Accepts a public key formatted as a libp2p PeerID and resolves the IPNS record +corresponding to that public key until a value is found

        +
        +
        +

        Parameters

        +
        +

        Returns Promise<CID<unknown, number, number, Version>>

        +
    +
    + +
    resolveDns: ((domain, options?) => Promise<CID<unknown, number, number, Version>>)
    +
    +

    Type declaration

    +
      +
    • +
    +
    + +
    +
    \ No newline at end of file diff --git a/interfaces/index.IPNSComponents.html b/interfaces/index.IPNSComponents.html new file mode 100644 index 0000000..8cb67db --- /dev/null +++ b/interfaces/index.IPNSComponents.html @@ -0,0 +1,96 @@ +IPNSComponents | @helia/ipns - v0.0.0
    +
    + +
    +
    +
    +
    + +

    Interface IPNSComponents

    +
    +

    Hierarchy

    +
      +
    • IPNSComponents
    +
    +
    +
    + +
    +
    +

    Properties

    +
    +
    +

    Properties

    +
    + +
    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>
    +
    +

    Type declaration

    +
      +
      +

      Type declaration

      +
        +
        +

        Type declaration

        +
          +
          +

          Type declaration

          +
            +
            +

            Type declaration

            +
              +
              +

              Type declaration

              +
                +
                +

                Type declaration

                +
                  +
                  +

                  Type declaration

                  +
                    +
                    +

                    Type declaration

                    +
                      +
                      +

                      Type declaration

                      +
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/index.PublishOptions.html b/interfaces/index.PublishOptions.html new file mode 100644 index 0000000..b59cee4 --- /dev/null +++ b/interfaces/index.PublishOptions.html @@ -0,0 +1,111 @@ +PublishOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface PublishOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        lifetime?: number
                        +

                        Time duration of the record in ms (default: 24hrs)

                        +
                        +
                        +
                        + +
                        offline?: boolean
                        +

                        Only publish to a local datastore (default: false)

                        +
                        +
                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/index.RepublishOptions.html b/interfaces/index.RepublishOptions.html new file mode 100644 index 0000000..a6f0713 --- /dev/null +++ b/interfaces/index.RepublishOptions.html @@ -0,0 +1,101 @@ +RepublishOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface RepublishOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        interval?: number
                        +

                        The republish interval in ms (default: 23hrs)

                        +
                        +
                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/index.ResolveDNSOptions.html b/interfaces/index.ResolveDNSOptions.html new file mode 100644 index 0000000..92c8f83 --- /dev/null +++ b/interfaces/index.ResolveDNSOptions.html @@ -0,0 +1,111 @@ +ResolveDNSOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface ResolveDNSOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        nocache?: boolean
                        +

                        Do not use cached DNS entries (default: false)

                        +
                        +
                        +
                        + +
                        offline?: boolean
                        +

                        Do not query the network for the IPNS record (default: false)

                        +
                        +
                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/index.ResolveOptions.html b/interfaces/index.ResolveOptions.html new file mode 100644 index 0000000..6b3458b --- /dev/null +++ b/interfaces/index.ResolveOptions.html @@ -0,0 +1,103 @@ +ResolveOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface ResolveOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        offline?: boolean
                        +

                        Do not query the network for the IPNS record (default: false)

                        +
                        +
                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/routing.GetOptions.html b/interfaces/routing.GetOptions.html new file mode 100644 index 0000000..b72e6ce --- /dev/null +++ b/interfaces/routing.GetOptions.html @@ -0,0 +1,91 @@ +GetOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface GetOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                          +
                        • +
                            +
                          • (evt): void
                          • +
                          • +
                            +

                            Parameters

                            +
                              +
                            • +
                              evt: any
                            +

                            Returns void

                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/routing.IPNSRouting.html b/interfaces/routing.IPNSRouting.html new file mode 100644 index 0000000..c8c7d57 --- /dev/null +++ b/interfaces/routing.IPNSRouting.html @@ -0,0 +1,105 @@ +IPNSRouting | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface IPNSRouting

                        +
                        +

                        Hierarchy

                        +
                          +
                        • IPNSRouting
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        get +put +
                        +
                        +

                        Properties

                        +
                        + +
                        get: ((routingKey, options?) => Promise<Uint8Array>)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        put: ((routingKey, marshaledRecord, options?) => Promise<void>)
                        +
                        +

                        Type declaration

                        +
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/interfaces/routing.PutOptions.html b/interfaces/routing.PutOptions.html new file mode 100644 index 0000000..95c95ba --- /dev/null +++ b/interfaces/routing.PutOptions.html @@ -0,0 +1,91 @@ +PutOptions | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Interface PutOptions

                        +
                        +

                        Hierarchy

                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        Properties

                        +
                        +
                        +

                        Properties

                        +
                        + +
                        onProgress?: ((evt) => void)
                        +
                        +

                        Type declaration

                        +
                          +
                        • +
                            +
                          • (evt): void
                          • +
                          • +
                            +

                            Parameters

                            +
                              +
                            • +
                              evt: any
                            +

                            Returns void

                        +
                        + +
                        signal?: AbortSignal
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/modules.html b/modules.html deleted file mode 100644 index fa3f45e..0000000 --- a/modules.html +++ /dev/null @@ -1,48 +0,0 @@ -Documentation
                        -
                        - -
                        -
                        -
                        -
                        -

                        Documentation

                        -
                        -
                        -

                        Index

                        -
                        -

                        Modules

                        -
                        -
                        -
                        \ No newline at end of file diff --git a/modules/_helia_ipns._internal_.html b/modules/_helia_ipns._internal_.html deleted file mode 100644 index 6618f02..0000000 --- a/modules/_helia_ipns._internal_.html +++ /dev/null @@ -1,69 +0,0 @@ -<internal> | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Module <internal>

                        -
                        -
                        -
                        -
                        -

                        Index

                        -
                        -

                        Interfaces

                        -
                        -
                        -

                        Type Aliases

                        -
                        -
                        -
                        \ No newline at end of file diff --git a/modules/_helia_ipns.html b/modules/_helia_ipns.html deleted file mode 100644 index be9f5f3..0000000 --- a/modules/_helia_ipns.html +++ /dev/null @@ -1,164 +0,0 @@ -@helia/ipns | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Module @helia/ipns - v1.1.3

                        -
                        -

                        IPNS operations using a Helia node

                        - -

                        Example

                        import { gossipsub } from '@chainsafe/libp2p-gossipsub'
                        import { kadDHT } from '@libp2p/kad-dht'
                        import { createLibp2p } from 'libp2p'
                        import { createHelia } from 'helia'
                        import { ipns, ipnsValidator, ipnsSelector } from '@helia/ipns'
                        import { dht, pubsub } from '@helia/ipns/routing'
                        import { unixfs } from '@helia/unixfs

                        const libp2p = await createLibp2p({
                        dht: kadDHT({
                        validators: {
                        ipns: ipnsValidator
                        },
                        selectors: {
                        ipns: ipnsSelector
                        }
                        }),
                        pubsub: gossipsub()
                        })

                        const helia = await createHelia({
                        libp2p,
                        //.. other options
                        })
                        const name = ipns(helia, [
                        dht(helia),
                        pubsub(helia)
                        ])

                        // create a public key to publish as an IPNS name
                        const keyInfo = await helia.libp2p.keychain.createKey('my-key')
                        const peerId = await helia.libp2p.keychain.exportPeerId(keyInfo.name)

                        // store some data to publish
                        const fs = unixfs(helia)
                        const cid = await fs.add(Uint8Array.from([0, 1, 2, 3, 4]))

                        // publish the name
                        await name.publish(peerId, cid)

                        // resolve the name
                        const cid = name.resolve(peerId) -
                        - -

                        Example

                        // resolve a CID from a TXT record in a DNS zone file, eg:
                        // > dig ipfs.io TXT
                        // ;; ANSWER SECTION:
                        // ipfs.io. 435 IN TXT "dnslink=/ipfs/Qmfoo"

                        const cid = name.resolveDns('ipfs.io') -
                        -
                        -
                        -

                        - - Helia logo - -

                        - - - -

                        @helia/ipns

                        -
                        -

                        ipfs.tech -Discuss -codecov -CI

                        -
                        -

                        An implementation of IPNS for Helia

                        -
                        - - -

                        Table of contents

                        -
                        - - - -

                        Install

                        -
                        -
                        $ npm i @helia/ipns
                        -
                        - - -

                        Browser <script> tag

                        -
                        -

                        Loading this module through a script tag will make it's exports available as HeliaIpns in the global namespace.

                        -
                        <script src="https://unpkg.com/@helia/ipns/dist/index.min.js"></script>
                        -
                        - - -

                        API Docs

                        -
                        - - - -

                        License

                        -
                        -

                        Licensed under either of

                        - - - -

                        Contribute

                        -
                        -

                        Contributions welcome! Please check out the issues.

                        -

                        Also see our contributing document for more information on how we work, and about contributing in general.

                        -

                        Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

                        -

                        Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

                        -

                        -
                        -
                        -
                        -

                        Index

                        -
                        -

                        Modules

                        -
                        -
                        -

                        Interfaces

                        -
                        -
                        -

                        Type Aliases

                        -
                        -
                        -

                        Functions

                        -
                        -
                        -
                        \ No newline at end of file diff --git a/modules/_helia_ipns_interop.html b/modules/_helia_ipns_interop.html deleted file mode 100644 index 674b753..0000000 --- a/modules/_helia_ipns_interop.html +++ /dev/null @@ -1,46 +0,0 @@ -@helia/ipns-interop | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Module @helia/ipns-interop - v0.0.0

                        -
                        -
                        \ No newline at end of file diff --git a/modules/index.html b/modules/index.html new file mode 100644 index 0000000..643240a --- /dev/null +++ b/modules/index.html @@ -0,0 +1,89 @@ +index | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Module index

                        +
                        +

                        IPNS operations using a Helia node

                        +
                        +
                        +

                        Example

                        import { gossipsub } from '@chainsafe/libp2p-gossipsub'
                        import { kadDHT } from '@libp2p/kad-dht'
                        import { createLibp2p } from 'libp2p'
                        import { createHelia } from 'helia'
                        import { ipns, ipnsValidator, ipnsSelector } from '@helia/ipns'
                        import { dht, pubsub } from '@helia/ipns/routing'
                        import { unixfs } from '@helia/unixfs'

                        const libp2p = await createLibp2p({
                        dht: kadDHT({
                        validators: {
                        ipns: ipnsValidator
                        },
                        selectors: {
                        ipns: ipnsSelector
                        }
                        }),
                        pubsub: gossipsub()
                        })

                        const helia = await createHelia({
                        libp2p,
                        //.. other options
                        })
                        const name = ipns(helia, [
                        dht(helia),
                        pubsub(helia)
                        ])

                        // create a public key to publish as an IPNS name
                        const keyInfo = await helia.libp2p.keychain.createKey('my-key')
                        const peerId = await helia.libp2p.keychain.exportPeerId(keyInfo.name)

                        // store some data to publish
                        const fs = unixfs(helia)
                        const cid = await fs.add(Uint8Array.from([0, 1, 2, 3, 4]))

                        // publish the name
                        await name.publish(peerId, cid)

                        // resolve the name
                        const cid = name.resolve(peerId) +
                        + +

                        Example

                        // resolve a CID from a TXT record in a DNS zone file, eg:
                        // > dig ipfs.io TXT
                        // ;; ANSWER SECTION:
                        // ipfs.io. 435 IN TXT "dnslink=/ipfs/Qmfoo"

                        const cid = name.resolveDns('ipfs.io') +
                        +
                        +
                        +
                        +
                        + +
                        +
                        +

                        References

                        +
                        +Re-exports IPNSRouting
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/modules/routing.html b/modules/routing.html new file mode 100644 index 0000000..b4b1f6a --- /dev/null +++ b/modules/routing.html @@ -0,0 +1,58 @@ +routing | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Module routing

                        +
                        +
                        +

                        Index

                        +
                        +

                        Interfaces

                        +
                        +
                        +

                        Type Aliases

                        +
                        +
                        +

                        Functions

                        +
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/types/_helia_ipns.PublishProgressEvents.html b/types/_helia_ipns.PublishProgressEvents.html deleted file mode 100644 index 3f2ea1e..0000000 --- a/types/_helia_ipns.PublishProgressEvents.html +++ /dev/null @@ -1,60 +0,0 @@ -PublishProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias PublishProgressEvents

                        -
                        PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSEntry> | ProgressEvent<"ipns:publish:error", Error>
                        -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns.RepublishProgressEvents.html b/types/_helia_ipns.RepublishProgressEvents.html deleted file mode 100644 index d8110e9..0000000 --- a/types/_helia_ipns.RepublishProgressEvents.html +++ /dev/null @@ -1,60 +0,0 @@ -RepublishProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias RepublishProgressEvents

                        -
                        RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSEntry> | ProgressEvent<"ipns:republish:error", {
                            err: Error;
                            record: IPNSEntry;
                        }>
                        -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns.ResolveProgressEvents.html b/types/_helia_ipns.ResolveProgressEvents.html deleted file mode 100644 index 0c3869d..0000000 --- a/types/_helia_ipns.ResolveProgressEvents.html +++ /dev/null @@ -1,60 +0,0 @@ -ResolveProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias ResolveProgressEvents

                        -
                        ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSEntry> | ProgressEvent<"ipns:resolve:error", Error>
                        -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns._internal_.DHTProgressEvents.html b/types/_helia_ipns._internal_.DHTProgressEvents.html deleted file mode 100644 index 78c081f..0000000 --- a/types/_helia_ipns._internal_.DHTProgressEvents.html +++ /dev/null @@ -1,56 +0,0 @@ -DHTProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias DHTProgressEvents

                        -
                        DHTProgressEvents: ProgressEvent<"ipns:routing:dht:error", Error>
                        -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns._internal_.DatastoreProgressEvents.html b/types/_helia_ipns._internal_.DatastoreProgressEvents.html deleted file mode 100644 index 5b87764..0000000 --- a/types/_helia_ipns._internal_.DatastoreProgressEvents.html +++ /dev/null @@ -1,56 +0,0 @@ -DatastoreProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias DatastoreProgressEvents

                        -
                        DatastoreProgressEvents: ProgressEvent<"ipns:routing:datastore:put"> | ProgressEvent<"ipns:routing:datastore:get"> | ProgressEvent<"ipns:routing:datastore:error", Error>
                        -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns._internal_.IPNSRoutingEvents.html b/types/_helia_ipns._internal_.IPNSRoutingEvents.html deleted file mode 100644 index fe13d0b..0000000 --- a/types/_helia_ipns._internal_.IPNSRoutingEvents.html +++ /dev/null @@ -1,56 +0,0 @@ -IPNSRoutingEvents | Documentation
                        -
                        - -
                        -
                        - -
                        -
                        \ No newline at end of file diff --git a/types/_helia_ipns._internal_.PubSubProgressEvents.html b/types/_helia_ipns._internal_.PubSubProgressEvents.html deleted file mode 100644 index 0ec0353..0000000 --- a/types/_helia_ipns._internal_.PubSubProgressEvents.html +++ /dev/null @@ -1,56 +0,0 @@ -PubSubProgressEvents | Documentation
                        -
                        - -
                        -
                        -
                        -
                        - -

                        Type alias PubSubProgressEvents

                        -
                        PubSubProgressEvents: ProgressEvent<"ipns:pubsub:publish", {
                            result: PublishResult;
                            topic: string;
                        }> | ProgressEvent<"ipns:pubsub:subscribe", {
                            topic: string;
                        }> | ProgressEvent<"ipns:pubsub:error", Error>
                        -
                        -
                        \ No newline at end of file diff --git a/types/index.PublishProgressEvents.html b/types/index.PublishProgressEvents.html new file mode 100644 index 0000000..ca25bce --- /dev/null +++ b/types/index.PublishProgressEvents.html @@ -0,0 +1,42 @@ +PublishProgressEvents | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Type alias PublishProgressEvents

                        +
                        PublishProgressEvents: ProgressEvent<"ipns:publish:start"> | ProgressEvent<"ipns:publish:success", IPNSEntry> | ProgressEvent<"ipns:publish:error", Error>
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/types/index.RepublishProgressEvents.html b/types/index.RepublishProgressEvents.html new file mode 100644 index 0000000..480d21c --- /dev/null +++ b/types/index.RepublishProgressEvents.html @@ -0,0 +1,42 @@ +RepublishProgressEvents | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Type alias RepublishProgressEvents

                        +
                        RepublishProgressEvents: ProgressEvent<"ipns:republish:start", unknown> | ProgressEvent<"ipns:republish:success", IPNSEntry> | ProgressEvent<"ipns:republish:error", {
                            err: Error;
                            record: IPNSEntry;
                        }>
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/types/index.ResolveProgressEvents.html b/types/index.ResolveProgressEvents.html new file mode 100644 index 0000000..7693adc --- /dev/null +++ b/types/index.ResolveProgressEvents.html @@ -0,0 +1,42 @@ +ResolveProgressEvents | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        +
                        +
                        + +

                        Type alias ResolveProgressEvents

                        +
                        ResolveProgressEvents: ProgressEvent<"ipns:resolve:start", unknown> | ProgressEvent<"ipns:resolve:success", IPNSEntry> | ProgressEvent<"ipns:resolve:error", Error>
                        +
                        + +
                        +
                        \ No newline at end of file diff --git a/types/routing.IPNSRoutingEvents.html b/types/routing.IPNSRoutingEvents.html new file mode 100644 index 0000000..f70edad --- /dev/null +++ b/types/routing.IPNSRoutingEvents.html @@ -0,0 +1,42 @@ +IPNSRoutingEvents | @helia/ipns - v0.0.0
                        +
                        + +
                        +
                        + +
                        + +
                        +
                        \ No newline at end of file