From e0c5e05fb7500344b7b89c13cb5d305d42292e8d Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Wed, 11 Sep 2024 11:29:03 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/main.js | 4 ++-- assets/style.css | 9 +++------ functions/index.create.html | 6 +++--- functions/index.createWithExpiration.html | 6 +++--- functions/index.extractPublicKey.html | 4 ++-- functions/index.getLocalKey.html | 2 +- functions/index.marshal.html | 2 +- functions/index.peerIdFromRoutingKey.html | 2 +- functions/index.peerIdToRoutingKey.html | 2 +- functions/index.unmarshal.html | 2 +- functions/selector.ipnsSelector.html | 2 +- functions/validator.ipnsValidator.html | 2 +- functions/validator.validate.html | 2 +- index.html | 2 +- interfaces/index.CreateOptions.html | 4 ++-- interfaces/index.CreateV2Options.html | 4 ++-- interfaces/index.CreateV2OrV1Options.html | 4 ++-- interfaces/index.IDKeys.html | 4 ++-- interfaces/index.IPNSRecordData.html | 4 ++-- interfaces/index.IPNSRecordV1V2.html | 20 ++++++++++---------- interfaces/index.IPNSRecordV2.html | 18 +++++++++--------- modules/index.html | 4 ++-- modules/selector.html | 4 ++-- modules/validator.html | 4 ++-- types/index.IPNSRecord.html | 2 +- variables/index.namespace.html | 2 +- variables/index.namespaceLength.html | 2 +- 27 files changed, 60 insertions(+), 63 deletions(-) diff --git a/assets/main.js b/assets/main.js index 1daeb69..d6f1388 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,7 +1,7 @@ "use strict"; "use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function 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 He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } `,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: diff --git a/assets/style.css b/assets/style.css index 072daed..778b949 100644 --- a/assets/style.css +++ b/assets/style.css @@ -327,17 +327,14 @@ dd { } /* Footer */ -.tsd-generator { +footer { border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; max-height: 3.5rem; } - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; +.tsd-generator { + margin: 0 1em; } .container-main { diff --git a/functions/index.create.html b/functions/index.create.html index 54a0210..f7de6f4 100644 --- a/functions/index.create.html +++ b/functions/index.create.html @@ -7,9 +7,9 @@
  • PeerIDs will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
  • String paths will be stored in the record as-is, but they must start with "/"
    • -

    Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<IPNSRecordV1V2>

  • create(peerId, value, seq, lifetime, options): Promise<IPNSRecordV2>

  • Parameters

    Returns Promise<IPNSRecordV2>

  • create(peerId, value, seq, lifetime, options): Promise<IPNSRecordV1V2>

  • Parameters

    Returns Promise<IPNSRecordV1V2>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.createWithExpiration.html b/functions/index.createWithExpiration.html index 96abfca..1de18bd 100644 --- a/functions/index.createWithExpiration.html +++ b/functions/index.createWithExpiration.html @@ -6,9 +6,9 @@
  • PeerIDs will create recursive records, eg. the record value will be /ipns/${cidV1Libp2pKey}
  • String paths will be stored in the record as-is, but they must start with "/"
    • -

    Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<IPNSRecordV1V2>

  • createWithExpiration(peerId, value, seq, expiration, options): Promise<IPNSRecordV2>

  • Parameters

    Returns Promise<IPNSRecordV2>

  • createWithExpiration(peerId, value, seq, expiration, options): Promise<IPNSRecordV1V2>

  • Parameters

    Returns Promise<IPNSRecordV1V2>

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.extractPublicKey.html b/functions/index.extractPublicKey.html index 4917f12..6199e80 100644 --- a/functions/index.extractPublicKey.html +++ b/functions/index.extractPublicKey.html @@ -1,3 +1,3 @@ -extractPublicKey | ipns

    Function extractPublicKey

    • extractPublicKey(peerId, record): Promise<PublicKey>

    • Extracts a public key from the passed PeerId, falling +extractPublicKey | ipns

      Function extractPublicKey

      Settings

      Member Visibility

      Theme

      Generated using TypeDoc

      \ No newline at end of file +

      Parameters

      Returns Promise<PublicKey<"Ed25519">>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.getLocalKey.html b/functions/index.getLocalKey.html index 13e4cd9..9e9284c 100644 --- a/functions/index.getLocalKey.html +++ b/functions/index.getLocalKey.html @@ -1,4 +1,4 @@ getLocalKey | ipns

    Function getLocalKey

    • getLocalKey(key): Key

    • Get key for storing the record locally. Format: /ipns/${base32()}

      Parameters

      Returns Key

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Key

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.marshal.html b/functions/index.marshal.html index 2c64959..7f3bc2b 100644 --- a/functions/index.marshal.html +++ b/functions/index.marshal.html @@ -1 +1 @@ -marshal | ipns

    Function marshal

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +marshal | ipns

    Function marshal

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.peerIdFromRoutingKey.html b/functions/index.peerIdFromRoutingKey.html index 91d9b55..e708306 100644 --- a/functions/index.peerIdFromRoutingKey.html +++ b/functions/index.peerIdFromRoutingKey.html @@ -1 +1 @@ -peerIdFromRoutingKey | ipns

    Function peerIdFromRoutingKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +peerIdFromRoutingKey | ipns

    Function peerIdFromRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.peerIdToRoutingKey.html b/functions/index.peerIdToRoutingKey.html index ee0b1b1..5ed9c21 100644 --- a/functions/index.peerIdToRoutingKey.html +++ b/functions/index.peerIdToRoutingKey.html @@ -1 +1 @@ -peerIdToRoutingKey | ipns

    Function peerIdToRoutingKey

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +peerIdToRoutingKey | ipns

    Function peerIdToRoutingKey

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/index.unmarshal.html b/functions/index.unmarshal.html index f7c520f..118eee1 100644 --- a/functions/index.unmarshal.html +++ b/functions/index.unmarshal.html @@ -1 +1 @@ -unmarshal | ipns

    Function unmarshal

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +unmarshal | ipns

    Function unmarshal

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/selector.ipnsSelector.html b/functions/selector.ipnsSelector.html index a34e438..6df9051 100644 --- a/functions/selector.ipnsSelector.html +++ b/functions/selector.ipnsSelector.html @@ -1 +1 @@ -ipnsSelector | ipns

    Function ipnsSelector

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ipnsSelector | ipns

    Function ipnsSelector

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validator.ipnsValidator.html b/functions/validator.ipnsValidator.html index 7a94f94..41cadae 100644 --- a/functions/validator.ipnsValidator.html +++ b/functions/validator.ipnsValidator.html @@ -1 +1 @@ -ipnsValidator | ipns

    Function ipnsValidator

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ipnsValidator | ipns

    Function ipnsValidator

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/validator.validate.html b/functions/validator.validate.html index ff170c5..692d2ea 100644 --- a/functions/validator.validate.html +++ b/functions/validator.validate.html @@ -1,3 +1,3 @@ validate | ipns

    Function validate

    • validate(publicKey, buf): Promise<void>

    • Validates the given IPNS Record against the given public key. We need a "raw" record in order to be able to access to all of its fields.

      -

      Parameters

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/index.html b/index.html index b1c0920..67ef816 100644 --- a/index.html +++ b/index.html @@ -121,4 +121,4 @@

    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.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    ipns

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    ipns
    \ No newline at end of file diff --git a/interfaces/index.CreateOptions.html b/interfaces/index.CreateOptions.html index baa65b8..88524a3 100644 --- a/interfaces/index.CreateOptions.html +++ b/interfaces/index.CreateOptions.html @@ -1,3 +1,3 @@ -CreateOptions | ipns

    Interface CreateOptions

    interface CreateOptions {
        ttlNs?: number | bigint;
        v1Compatible?: boolean;
    }

    Properties

    ttlNs? +CreateOptions | ipns

    Interface CreateOptions

    interface CreateOptions {
        ttlNs?: number | bigint;
        v1Compatible?: boolean;
    }

    Properties

    ttlNs? v1Compatible? -

    Properties

    Optional ttlNs

    ttlNs?: number | bigint

    Optional v1Compatible

    v1Compatible?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    ttlNsv1Compatible

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional ttlNs

    ttlNs?: number | bigint

    Optional v1Compatible

    v1Compatible?: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    ttlNsv1Compatible
    \ No newline at end of file diff --git a/interfaces/index.CreateV2Options.html b/interfaces/index.CreateV2Options.html index 1ada466..f421ea9 100644 --- a/interfaces/index.CreateV2Options.html +++ b/interfaces/index.CreateV2Options.html @@ -1,2 +1,2 @@ -CreateV2Options | ipns

    Interface CreateV2Options

    interface CreateV2Options {
        v1Compatible: false;
    }

    Properties

    v1Compatible -

    Properties

    v1Compatible

    v1Compatible: false

    Settings

    Member Visibility

    Theme

    On This Page

    v1Compatible

    Generated using TypeDoc

    \ No newline at end of file +CreateV2Options | ipns

    Interface CreateV2Options

    interface CreateV2Options {
        v1Compatible: false;
    }

    Properties

    v1Compatible +

    Properties

    v1Compatible

    v1Compatible: false

    Settings

    Member Visibility

    Theme

    On This Page

    v1Compatible
    \ No newline at end of file diff --git a/interfaces/index.CreateV2OrV1Options.html b/interfaces/index.CreateV2OrV1Options.html index 8428d81..c83eb2c 100644 --- a/interfaces/index.CreateV2OrV1Options.html +++ b/interfaces/index.CreateV2OrV1Options.html @@ -1,2 +1,2 @@ -CreateV2OrV1Options | ipns

    Interface CreateV2OrV1Options

    interface CreateV2OrV1Options {
        v1Compatible: true;
    }

    Properties

    v1Compatible -

    Properties

    v1Compatible

    v1Compatible: true

    Settings

    Member Visibility

    Theme

    On This Page

    v1Compatible

    Generated using TypeDoc

    \ No newline at end of file +CreateV2OrV1Options | ipns

    Interface CreateV2OrV1Options

    interface CreateV2OrV1Options {
        v1Compatible: true;
    }

    Properties

    v1Compatible +

    Properties

    v1Compatible

    v1Compatible: true

    Settings

    Member Visibility

    Theme

    On This Page

    v1Compatible
    \ No newline at end of file diff --git a/interfaces/index.IDKeys.html b/interfaces/index.IDKeys.html index 107b341..d87d10f 100644 --- a/interfaces/index.IDKeys.html +++ b/interfaces/index.IDKeys.html @@ -1,5 +1,5 @@ -IDKeys | ipns

    Interface IDKeys

    interface IDKeys {
        ipnsKey: Key;
        pkKey: Key;
        routingKey: Key;
        routingPubKey: Key;
    }

    Properties

    ipnsKey +IDKeys | ipns

    Interface IDKeys

    interface IDKeys {
        ipnsKey: Key;
        pkKey: Key;
        routingKey: Key;
        routingPubKey: Key;
    }

    Properties

    ipnsKey pkKey routingKey routingPubKey -

    Properties

    ipnsKey

    ipnsKey: Key

    pkKey

    pkKey: Key

    routingKey

    routingKey: Key

    routingPubKey

    routingPubKey: Key

    Settings

    Member Visibility

    Theme

    On This Page

    ipnsKeypkKeyroutingKeyroutingPubKey

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    ipnsKey

    ipnsKey: Key

    pkKey

    pkKey: Key

    routingKey

    routingKey: Key

    routingPubKey

    routingPubKey: Key

    Settings

    Member Visibility

    Theme

    On This Page

    ipnsKeypkKeyroutingKeyroutingPubKey
    \ No newline at end of file diff --git a/interfaces/index.IPNSRecordData.html b/interfaces/index.IPNSRecordData.html index dcf837e..01a3969 100644 --- a/interfaces/index.IPNSRecordData.html +++ b/interfaces/index.IPNSRecordData.html @@ -1,6 +1,6 @@ -IPNSRecordData | ipns

    Interface IPNSRecordData

    interface IPNSRecordData {
        Sequence: bigint;
        TTL: bigint;
        Validity: Uint8Array;
        ValidityType: EOL;
        Value: Uint8Array;
    }

    Properties

    Sequence +IPNSRecordData | ipns

    Interface IPNSRecordData

    interface IPNSRecordData {
        Sequence: bigint;
        TTL: bigint;
        Validity: Uint8Array;
        ValidityType: EOL;
        Value: Uint8Array;
    }

    Properties

    Sequence TTL Validity ValidityType Value -

    Properties

    Sequence

    Sequence: bigint

    TTL

    TTL: bigint

    Validity

    Validity: Uint8Array

    ValidityType

    ValidityType: EOL

    Value

    Value: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    SequenceTTLValidityValidityTypeValue

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Sequence

    Sequence: bigint

    TTL

    TTL: bigint

    Validity

    Validity: Uint8Array

    ValidityType

    ValidityType: EOL

    Value

    Value: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    SequenceTTLValidityValidityTypeValue
    \ No newline at end of file diff --git a/interfaces/index.IPNSRecordV1V2.html b/interfaces/index.IPNSRecordV1V2.html index 4725473..8721c53 100644 --- a/interfaces/index.IPNSRecordV1V2.html +++ b/interfaces/index.IPNSRecordV1V2.html @@ -1,4 +1,4 @@ -IPNSRecordV1V2 | ipns

    Interface IPNSRecordV1V2

    interface IPNSRecordV1V2 {
        data: Uint8Array;
        pubKey?: Uint8Array;
        sequence: bigint;
        signatureV1: Uint8Array;
        signatureV2: Uint8Array;
        ttl?: bigint;
        validity: string;
        validityType: EOL;
        value: string;
    }

    Properties

    data +IPNSRecordV1V2 | ipns

    Interface IPNSRecordV1V2

    interface IPNSRecordV1V2 {
        data: Uint8Array;
        pubKey?: Uint8Array;
        sequence: bigint;
        signatureV1: Uint8Array;
        signatureV2: Uint8Array;
        ttl?: bigint;
        validity: string;
        validityType: EOL;
        value: string;
    }

    Properties

    data pubKey? sequence signatureV1 @@ -8,12 +8,12 @@ validityType value

    Properties

    data

    data: Uint8Array

    extensible data

    -

    Optional pubKey

    pubKey?: Uint8Array

    the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)

    -

    sequence

    sequence: bigint

    number representing the version of the record

    -

    signatureV1

    signatureV1: Uint8Array

    signature of the record

    -

    signatureV2

    signatureV2: Uint8Array

    the v2 signature of the record

    -

    Optional ttl

    ttl?: bigint

    ttl in nanoseconds

    -

    validity

    validity: string

    expiration datetime for the record in RFC3339 format

    -

    validityType

    validityType: EOL

    Type of validation being used

    -

    value

    value: string

    value of the record

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datapubKeysequencesignatureV1signatureV2ttlvalidityvalidityTypevalue

    Generated using TypeDoc

    \ No newline at end of file +

    Optional pubKey

    pubKey?: Uint8Array

    the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)

    +

    sequence

    sequence: bigint

    number representing the version of the record

    +

    signatureV1

    signatureV1: Uint8Array

    signature of the record

    +

    signatureV2

    signatureV2: Uint8Array

    the v2 signature of the record

    +

    Optional ttl

    ttl?: bigint

    ttl in nanoseconds

    +

    validity

    validity: string

    expiration datetime for the record in RFC3339 format

    +

    validityType

    validityType: EOL

    Type of validation being used

    +

    value

    value: string

    value of the record

    +

    Settings

    Member Visibility

    Theme

    On This Page

    datapubKeysequencesignatureV1signatureV2ttlvalidityvalidityTypevalue
    \ No newline at end of file diff --git a/interfaces/index.IPNSRecordV2.html b/interfaces/index.IPNSRecordV2.html index a294e9f..7ce5579 100644 --- a/interfaces/index.IPNSRecordV2.html +++ b/interfaces/index.IPNSRecordV2.html @@ -1,4 +1,4 @@ -IPNSRecordV2 | ipns

    Interface IPNSRecordV2

    interface IPNSRecordV2 {
        data: Uint8Array;
        pubKey?: Uint8Array;
        sequence: bigint;
        signatureV2: Uint8Array;
        ttl?: bigint;
        validity: string;
        validityType: EOL;
        value: string;
    }

    Properties

    data +IPNSRecordV2 | ipns

    Interface IPNSRecordV2

    interface IPNSRecordV2 {
        data: Uint8Array;
        pubKey?: Uint8Array;
        sequence: bigint;
        signatureV2: Uint8Array;
        ttl?: bigint;
        validity: string;
        validityType: EOL;
        value: string;
    }

    Properties

    data pubKey? sequence signatureV2 @@ -7,12 +7,12 @@ validityType value

    Properties

    data

    data: Uint8Array

    extensible data

    -

    Optional pubKey

    pubKey?: Uint8Array

    the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)

    -

    sequence

    sequence: bigint

    number representing the version of the record

    -

    signatureV2

    signatureV2: Uint8Array

    the v2 signature of the record

    -

    Optional ttl

    ttl?: bigint

    ttl in nanoseconds

    -

    validity

    validity: string

    If the validity type is EOL, this is the expiration datetime for the record +

    Optional pubKey

    pubKey?: Uint8Array

    the public portion of the key that signed this record (only present if it was not embedded in the IPNS key)

    +

    sequence

    sequence: bigint

    number representing the version of the record

    +

    signatureV2

    signatureV2: Uint8Array

    the v2 signature of the record

    +

    Optional ttl

    ttl?: bigint

    ttl in nanoseconds

    +

    validity

    validity: string

    If the validity type is EOL, this is the expiration datetime for the record in RFC3339 format

    -

    validityType

    validityType: EOL

    Type of validation being used

    -

    value

    value: string

    value of the record

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datapubKeysequencesignatureV2ttlvalidityvalidityTypevalue

    Generated using TypeDoc

    \ No newline at end of file +

    validityType

    validityType: EOL

    Type of validation being used

    +

    value

    value: string

    value of the record

    +

    Settings

    Member Visibility

    Theme

    On This Page

    datapubKeysequencesignatureV2ttlvalidityvalidityTypevalue
    \ No newline at end of file diff --git a/modules/index.html b/modules/index.html index 9ddcf58..7ae21da 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,4 +1,4 @@ -index | ipns

    Module index

    Index

    Interfaces

    CreateOptions +index | ipns

    Module index

    Index

    Interfaces

    CreateOptions CreateV2Options CreateV2OrV1Options IDKeys @@ -16,4 +16,4 @@ peerIdFromRoutingKey peerIdToRoutingKey unmarshal -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/selector.html b/modules/selector.html index 4cb8145..fa8a152 100644 --- a/modules/selector.html +++ b/modules/selector.html @@ -1,2 +1,2 @@ -selector | ipns

    Module selector

    Index

    Functions

    ipnsSelector -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +selector | ipns

    Module selector

    Index

    Functions

    ipnsSelector +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/modules/validator.html b/modules/validator.html index 3de057f..d25805f 100644 --- a/modules/validator.html +++ b/modules/validator.html @@ -1,3 +1,3 @@ -validator | ipns

    Module validator

    Index

    Functions

    ipnsValidator +validator | ipns

    Module validator

    Index

    Functions

    ipnsValidator validate -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/index.IPNSRecord.html b/types/index.IPNSRecord.html index 54261a5..db1ba59 100644 --- a/types/index.IPNSRecord.html +++ b/types/index.IPNSRecord.html @@ -1 +1 @@ -IPNSRecord | ipns

    Type alias IPNSRecord

    IPNSRecord: IPNSRecordV1V2 | IPNSRecordV2

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IPNSRecord | ipns

    Type alias IPNSRecord

    IPNSRecord: IPNSRecordV1V2 | IPNSRecordV2

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/index.namespace.html b/variables/index.namespace.html index 4927c8a..f60fb5c 100644 --- a/variables/index.namespace.html +++ b/variables/index.namespace.html @@ -1 +1 @@ -namespace | ipns

    Variable namespaceConst

    namespace: "/ipns/" = '/ipns/'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +namespace | ipns

    Variable namespaceConst

    namespace: "/ipns/" = '/ipns/'

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/index.namespaceLength.html b/variables/index.namespaceLength.html index 1ce2d97..a5faba3 100644 --- a/variables/index.namespaceLength.html +++ b/variables/index.namespaceLength.html @@ -1 +1 @@ -namespaceLength | ipns

    Variable namespaceLengthConst

    namespaceLength: number = namespace.length

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +namespaceLength | ipns

    Variable namespaceLengthConst

    namespaceLength: number = namespace.length

    Settings

    Member Visibility

    Theme

    \ No newline at end of file