diff --git a/assets/highlight.css b/assets/highlight.css index 3ace617..2db395a 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -15,14 +15,6 @@ --dark-hl-6: #DCDCAA; --light-hl-7: #008000; --dark-hl-7: #6A9955; - --light-hl-8: #000000FF; - --dark-hl-8: #D4D4D4; - --light-hl-9: #CD3131; - --dark-hl-9: #F44747; - --light-hl-10: #098658; - --dark-hl-10: #B5CEA8; - --light-hl-11: #267F99; - --dark-hl-11: #4EC9B0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -36,10 +28,6 @@ --hl-5: var(--light-hl-5); --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); --code-background: var(--light-code-background); } } @@ -52,10 +40,6 @@ --hl-5: var(--dark-hl-5); --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); --code-background: var(--dark-code-background); } } @@ -68,10 +52,6 @@ --hl-5: var(--light-hl-5); --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); --code-background: var(--light-code-background); } @@ -84,10 +64,6 @@ --hl-5: var(--dark-hl-5); --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); --code-background: var(--dark-code-background); } @@ -99,8 +75,4 @@ .hl-5 { color: var(--hl-5); } .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); } pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js index 4c8fa61..01bcad5 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=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..f63b8e7 --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA4uuVipJrShRslJyTEnxLyjJzM8rVtJRKkgsyQCKZeaVpBalJSanFusjpPUySnJzgGqyM/NSlKyMTM1qdeCGuDi6ewX7+2E1ASpHhHbn/NyC/LzUvBLsTsFQhc9I99QSfN5CSOMzJCUx3as4Pw9hQlppXjJYlz5UStcQVb+ZSW0sADhjOHlcAQAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index abdf877..c19082e 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":2,\"name\":\"unknown\",\"url\":\"modules/unknown.html\",\"classes\":\"\"},{\"kind\":256,\"name\":\"AddOptions\",\"url\":\"interfaces/AddOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"hasher\",\"url\":\"interfaces/AddOptions.html#hasher\",\"classes\":\"\",\"parent\":\"AddOptions\"},{\"kind\":256,\"name\":\"DAGJSON\",\"url\":\"interfaces/DAGJSON.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"add\",\"url\":\"interfaces/DAGJSON.html#add\",\"classes\":\"\",\"parent\":\"DAGJSON\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/DAGJSON.html#add.__type\",\"classes\":\"\",\"parent\":\"DAGJSON.add\"},{\"kind\":1024,\"name\":\"get\",\"url\":\"interfaces/DAGJSON.html#get\",\"classes\":\"\",\"parent\":\"DAGJSON\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/DAGJSON.html#get.__type-2\",\"classes\":\"\",\"parent\":\"DAGJSON.get\"},{\"kind\":256,\"name\":\"DAGJSONComponents\",\"url\":\"interfaces/DAGJSONComponents.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"blockstore\",\"url\":\"interfaces/DAGJSONComponents.html#blockstore\",\"classes\":\"\",\"parent\":\"DAGJSONComponents\"},{\"kind\":256,\"name\":\"GetOptions\",\"url\":\"interfaces/GetOptions.html\",\"classes\":\"\"},{\"kind\":1024,\"name\":\"codec\",\"url\":\"interfaces/GetOptions.html#codec\",\"classes\":\"\",\"parent\":\"GetOptions\"},{\"kind\":64,\"name\":\"dagJson\",\"url\":\"functions/dagJson-1.html\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,22.336]],[\"comment/0\",[]],[\"name/1\",[1,22.336]],[\"comment/1\",[]],[\"name/2\",[2,22.336]],[\"comment/2\",[]],[\"name/3\",[3,17.228]],[\"comment/3\",[]],[\"name/4\",[4,22.336]],[\"comment/4\",[]],[\"name/5\",[5,17.228]],[\"comment/5\",[]],[\"name/6\",[6,22.336]],[\"comment/6\",[]],[\"name/7\",[5,17.228]],[\"comment/7\",[]],[\"name/8\",[7,22.336]],[\"comment/8\",[]],[\"name/9\",[8,22.336]],[\"comment/9\",[]],[\"name/10\",[9,22.336]],[\"comment/10\",[]],[\"name/11\",[10,22.336]],[\"comment/11\",[]],[\"name/12\",[3,17.228]],[\"comment/12\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":5,\"name\":{\"5\":{},\"7\":{}},\"comment\":{}}],[\"add\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"addoptions\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"blockstore\",{\"_index\":8,\"name\":{\"9\":{}},\"comment\":{}}],[\"codec\",{\"_index\":10,\"name\":{\"11\":{}},\"comment\":{}}],[\"dagjson\",{\"_index\":3,\"name\":{\"3\":{},\"12\":{}},\"comment\":{}}],[\"dagjsoncomponents\",{\"_index\":7,\"name\":{\"8\":{}},\"comment\":{}}],[\"get\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"getoptions\",{\"_index\":9,\"name\":{\"10\":{}},\"comment\":{}}],[\"hasher\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"unknown\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42VS4+bMBRG/4uzdQk27+xGrTTqLDqLSt1EqKLYmdABjIBpKyH+ey+vXKwxGTaRLj7n8/UD0pFa/W3I6dyR16wU5MQ9n5IyKSQ5kQchnqs2U2VDKHmrc3iUla2sL0kqmyOOWte2yAFJ86RpJKQR0tMlkNncvSVek+Yq6x1phxu5CqWkSmpZtnprONW69y8Pj0/fn7+ZppqH7nbNbTe8ZSVCfJRzmBhzs0svG/Evsv0wfmJ2x7/fiM+qqFQJgvEs30H7j/RXrtLXplW13B980KS7q1r1bV7fo2zvXFIc3b+iVAmZ7gg7LKB5AavGcCIfpxHJy1OjyttEl7cyHfHjPPKJmXqOKbQk5D9y6sgfWTdgwHNuOVYE5CWTuRje52kWUFVRDP3E89gPmcK2D8SEHG1CzzZlkRVxN47peTHGgfHBiDGomAljGsah4pS5Vsh8DeMa5kDlmNIcDXOhck2Yq2EeVJ4J8zTMh8o3Yb6GBVAFJizQsBCq0ISFGhZtbUg0YuNpwjG2UnydThXOZfyWdOTnfM7OcmU64sBP3+OpDtUQCoZaXgIUbRTtDXH9IqLoo+hviPPdRydEJ9xw4F7/Hm88WhwtPnCURPfldPUdwxgPY7wNf/yCouGi4W4bhk0NUAw2xOW/CyWGEjNJcA2qrJJ5VgJzjvv+P7gGwImYBwAA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 18b4f8f..108428c 100644 --- a/assets/style.css +++ b/assets/style.css @@ -32,7 +32,6 @@ --light-color-ts-accessor: var(--light-color-ts-property); --light-color-ts-get-signature: var(--light-color-ts-accessor); --light-color-ts-set-signature: var(--light-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -72,7 +71,6 @@ --dark-color-ts-accessor: var(--dark-color-ts-property); --dark-color-ts-get-signature: var(--dark-color-ts-accessor); --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -468,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 { @@ -485,6 +482,19 @@ blockquote { .tsd-typography ol { margin: 1em 0; } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} .tsd-breadcrumb { margin: 0; @@ -900,8 +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); @@ -909,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; @@ -1070,7 +1084,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1122,7 +1138,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/classes/unknown.CID-1.html b/classes/unknown.CID-1.html deleted file mode 100644 index 549c054..0000000 --- a/classes/unknown.CID-1.html +++ /dev/null @@ -1,690 +0,0 @@ -CID | @helia/dag-json - v0.0.0
-
- -
-
-
-
- -

Class CID<Data, Format, Alg, Version>

-
-
-

Implements

-
-

Type Parameters

-
    -
  • -

    Data extends unknown = unknown

  • -
  • -

    Format extends number = number

  • -
  • -

    Alg extends number = number

  • -
  • -

    Version extends Version = Version

-
-

Hierarchy

-
    -
  • CID
-
-

Implements

-
    -
  • Link<Data, Format, Alg, Version>
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data extends unknown = unknown

    • -
    • -

      Format extends number = number

    • -
    • -

      Alg extends number = number

    • -
    • -

      Version extends Version = Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data, Format, Alg, Version>

-
-

Properties

-
- -
-
- -
bytes: Uint8Array
-
- -
code: Format
-
- -
multihash: MultihashDigest<Alg>
-
- -
version: Version
-
-

Accessors

-
- -
    -
  • get [toStringTag](): string
  • -
  • -

    Returns string

-
- -
    -
  • get asCID(): CID<Data, Format, Alg, Version>
  • -
  • -

    Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes -please either use CID.asCID(cid) or switch to new signalling mechanism

    -
    -

    Returns CID<Data, Format, Alg, Version>

    -
    -

    Deprecated

-
- -
    -
  • get byteLength(): number
  • -
  • -

    Returns number

-
- -
    -
  • get byteOffset(): number
  • -
  • -

    Returns number

-
-

Methods

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      other: unknown
    -

    Returns other is CID<Data, Format, Alg, Version>

    -
-
- -
    - -
  • -

    Returns CID<Data, Format, Alg, Version>

-
- -
    - -
  • -

    Returns {
        /: ToString<CID<Data, Format, Alg, Version>, string>;
    }

    -
      -
    • -
      /: ToString<CID<Data, Format, Alg, Version>, string>
-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Returns CID<Data, 112, 18, 0>

    -
-
- -
    - -
  • -

    Returns CID<Data, Format, Alg, 1>

    -
-
- -
    - -
  • -

    Takes any input value and returns a CID instance if it was -a CID otherwise returns null. If value is instanceof CID -it will return value back. If value is not instance of this CID -class, but is compatible CID it will return new instance of this -CID class. Otherwise returns null.

    -

    This allows two different incompatible versions of CID library to -co-exist and interop as long as binary interface is compatible.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_2 extends unknown

    • -
    • -

      Format_2 extends number

    • -
    • -

      Alg_2 extends number

    • -
    • -

      Version_2 extends Version

    • -
    • -

      U extends unknown

    -
    -

    Parameters

    -
      -
    • -
      input: U | Link<Data_2, Format_2, Alg_2, Version_2>
    -

    Returns null | CID<Data_2, Format_2, Alg_2, Version_2>

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data_3 extends unknown

    • -
    • -

      Format_3 extends number

    • -
    • -

      Alg_3 extends number

    • -
    • -

      Version_3 extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_3, Format_3, Alg_3, Version_3>

    -
-
- -
    - -
  • -

    Simplified version of create for CIDv0.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends unknown = unknown

    -
    -

    Parameters

    -
    -

    Returns CID<T, 112, 18, 0>

    -
-
- -
    - -
  • -

    Simplified version of create for CIDv1.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_4 extends unknown

    • -
    • -

      Code extends number

    • -
    • -

      Alg_4 extends number

    -
    -

    Parameters

    -
      -
    • -
      code: Code
      -

      Content encoding format code.

      -
      -
    • -
    • -
      digest: MultihashDigest<Alg_4>
      -

      Miltihash of the content.

      -
      -
    -

    Returns CID<Data_4, Code, Alg_4, 1>

    -
-
- -
    - -
  • -

    Decoded a CID from its binary representation. The byte array must contain -only the CID with no additional bytes.

    -

    An error will be thrown if the bytes provided do not contain a valid -binary representation of a CID.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_5 extends unknown

    • -
    • -

      Code_1 extends number

    • -
    • -

      Alg_5 extends number

    • -
    • -

      Ver extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_5, Code_1, Alg_5, Ver>

    -
-
- -
    - -
  • -

    Decoded a CID from its binary representation at the beginning of a byte -array.

    -

    Returns an array with the first element containing the CID and the second -element containing the remainder of the original byte array. The remainder -will be a zero-length byte array if the provided bytes only contained a -binary CID representation.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T_1 extends unknown

    • -
    • -

      C extends number

    • -
    • -

      A extends number

    • -
    • -

      V extends Version

    -
    -

    Parameters

    -
    -

    Returns [CID<T_1, C, A, V>, Uint8Array]

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data_1 extends unknown

    • -
    • -

      Format_1 extends number

    • -
    • -

      Alg_1 extends number

    • -
    • -

      Version_1 extends Version

    -
    -

    Parameters

    -
      -
    • -
      self: Link<Data_1, Format_1, Alg_1, Version_1>
    • -
    • -
      other: unknown
    -

    Returns other is CID<any, number, number, Version>

    -
-
- -
    - -
  • -

    Inspect the initial bytes of a CID to determine its properties.

    -

    Involves decoding up to 4 varints. Typically this will require only 4 to 6 -bytes but for larger multicodec code values and larger multihash digest -lengths these varints can be quite large. It is recommended that at least -10 bytes be made available in the initialBytes argument for a complete -inspection.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T_2 extends unknown

    • -
    • -

      C_1 extends number

    • -
    • -

      A_1 extends number

    • -
    • -

      V_1 extends Version

    -
    -

    Parameters

    -
    -

    Returns {
        codec: C_1;
        digestSize: number;
        multihashCode: A_1;
        multihashSize: number;
        size: number;
        version: V_1;
    }

    -
      -
    • -
      codec: C_1
    • -
    • -
      digestSize: number
    • -
    • -
      multihashCode: A_1
    • -
    • -
      multihashSize: number
    • -
    • -
      size: number
    • -
    • -
      version: V_1
    -
-
- -
    - -
  • -

    Takes cid in a string representation and creates an instance. If base -decoder is not provided will use a default from the configuration. It will -throw an error if encoding of the CID is not compatible with supplied (or -a default decoder).

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    • -
    • -

      Data_6 extends unknown

    • -
    • -

      Code_2 extends number

    • -
    • -

      Alg_6 extends number

    • -
    • -

      Ver_1 extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_6, Code_2, Alg_6, Ver_1>

    -
-
- -
-
\ No newline at end of file diff --git a/classes/unknown.CID.html b/classes/unknown.CID.html deleted file mode 100644 index d5562eb..0000000 --- a/classes/unknown.CID.html +++ /dev/null @@ -1,690 +0,0 @@ -CID | @helia/dag-json - v0.0.0
-
- -
-
-
-
- -

Class CID<Data, Format, Alg, Version>

-
-
-

Implements

-
-

Type Parameters

-
    -
  • -

    Data extends unknown = unknown

  • -
  • -

    Format extends number = number

  • -
  • -

    Alg extends number = number

  • -
  • -

    Version extends Version = Version

-
-

Hierarchy

-
    -
  • CID
-
-

Implements

-
    -
  • Link<Data, Format, Alg, Version>
-
-
-
- -
-
-

Constructors

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data extends unknown = unknown

    • -
    • -

      Format extends number = number

    • -
    • -

      Alg extends number = number

    • -
    • -

      Version extends Version = Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data, Format, Alg, Version>

-
-

Properties

-
- -
-
- -
bytes: Uint8Array
-
- -
code: Format
-
- -
multihash: MultihashDigest<Alg>
-
- -
version: Version
-
-

Accessors

-
- -
    -
  • get [toStringTag](): string
  • -
  • -

    Returns string

-
- -
    -
  • get asCID(): CID<Data, Format, Alg, Version>
  • -
  • -

    Signalling cid.asCID === cid has been replaced with cid['/'] === cid.bytes -please either use CID.asCID(cid) or switch to new signalling mechanism

    -
    -

    Returns CID<Data, Format, Alg, Version>

    -
    -

    Deprecated

-
- -
    -
  • get byteLength(): number
  • -
  • -

    Returns number

-
- -
    -
  • get byteOffset(): number
  • -
  • -

    Returns number

-
-

Methods

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      other: unknown
    -

    Returns other is CID<Data, Format, Alg, Version>

    -
-
- -
    - -
  • -

    Returns CID<Data, Format, Alg, Version>

-
- -
    - -
  • -

    Returns {
        /: ToString<CID<Data, Format, Alg, Version>, string>;
    }

    -
      -
    • -
      /: ToString<CID<Data, Format, Alg, Version>, string>
-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns string

    -
-
- -
    - -
  • -

    Returns CID<Data, 112, 18, 0>

    -
-
- -
    - -
  • -

    Returns CID<Data, Format, Alg, 1>

    -
-
- -
    - -
  • -

    Takes any input value and returns a CID instance if it was -a CID otherwise returns null. If value is instanceof CID -it will return value back. If value is not instance of this CID -class, but is compatible CID it will return new instance of this -CID class. Otherwise returns null.

    -

    This allows two different incompatible versions of CID library to -co-exist and interop as long as binary interface is compatible.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_2 extends unknown

    • -
    • -

      Format_2 extends number

    • -
    • -

      Alg_2 extends number

    • -
    • -

      Version_2 extends Version

    • -
    • -

      U extends unknown

    -
    -

    Parameters

    -
      -
    • -
      input: U | Link<Data_2, Format_2, Alg_2, Version_2>
    -

    Returns null | CID<Data_2, Format_2, Alg_2, Version_2>

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data_3 extends unknown

    • -
    • -

      Format_3 extends number

    • -
    • -

      Alg_3 extends number

    • -
    • -

      Version_3 extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_3, Format_3, Alg_3, Version_3>

    -
-
- -
    - -
  • -

    Simplified version of create for CIDv0.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends unknown = unknown

    -
    -

    Parameters

    -
    -

    Returns CID<T, 112, 18, 0>

    -
-
- -
    - -
  • -

    Simplified version of create for CIDv1.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_4 extends unknown

    • -
    • -

      Code extends number

    • -
    • -

      Alg_4 extends number

    -
    -

    Parameters

    -
      -
    • -
      code: Code
      -

      Content encoding format code.

      -
      -
    • -
    • -
      digest: MultihashDigest<Alg_4>
      -

      Miltihash of the content.

      -
      -
    -

    Returns CID<Data_4, Code, Alg_4, 1>

    -
-
- -
    - -
  • -

    Decoded a CID from its binary representation. The byte array must contain -only the CID with no additional bytes.

    -

    An error will be thrown if the bytes provided do not contain a valid -binary representation of a CID.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data_5 extends unknown

    • -
    • -

      Code_1 extends number

    • -
    • -

      Alg_5 extends number

    • -
    • -

      Ver extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_5, Code_1, Alg_5, Ver>

    -
-
- -
    - -
  • -

    Decoded a CID from its binary representation at the beginning of a byte -array.

    -

    Returns an array with the first element containing the CID and the second -element containing the remainder of the original byte array. The remainder -will be a zero-length byte array if the provided bytes only contained a -binary CID representation.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T_1 extends unknown

    • -
    • -

      C extends number

    • -
    • -

      A extends number

    • -
    • -

      V extends Version

    -
    -

    Parameters

    -
    -

    Returns [CID<T_1, C, A, V>, Uint8Array]

    -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      Data_1 extends unknown

    • -
    • -

      Format_1 extends number

    • -
    • -

      Alg_1 extends number

    • -
    • -

      Version_1 extends Version

    -
    -

    Parameters

    -
      -
    • -
      self: Link<Data_1, Format_1, Alg_1, Version_1>
    • -
    • -
      other: unknown
    -

    Returns other is CID<any, number, number, Version>

    -
-
- -
    - -
  • -

    Inspect the initial bytes of a CID to determine its properties.

    -

    Involves decoding up to 4 varints. Typically this will require only 4 to 6 -bytes but for larger multicodec code values and larger multihash digest -lengths these varints can be quite large. It is recommended that at least -10 bytes be made available in the initialBytes argument for a complete -inspection.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T_2 extends unknown

    • -
    • -

      C_1 extends number

    • -
    • -

      A_1 extends number

    • -
    • -

      V_1 extends Version

    -
    -

    Parameters

    -
    -

    Returns {
        codec: C_1;
        digestSize: number;
        multihashCode: A_1;
        multihashSize: number;
        size: number;
        version: V_1;
    }

    -
      -
    • -
      codec: C_1
    • -
    • -
      digestSize: number
    • -
    • -
      multihashCode: A_1
    • -
    • -
      multihashSize: number
    • -
    • -
      size: number
    • -
    • -
      version: V_1
    -
-
- -
    - -
  • -

    Takes cid in a string representation and creates an instance. If base -decoder is not provided will use a default from the configuration. It will -throw an error if encoding of the CID is not compatible with supplied (or -a default decoder).

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    • -
    • -

      Data_6 extends unknown

    • -
    • -

      Code_2 extends number

    • -
    • -

      Alg_6 extends number

    • -
    • -

      Ver_1 extends Version

    -
    -

    Parameters

    -
    -

    Returns CID<Data_6, Code_2, Alg_6, Ver_1>

    -
-
- -
-
\ No newline at end of file diff --git a/functions/dagJson-1.html b/functions/dagJson-1.html index e441374..e59ff13 100644 --- a/functions/dagJson-1.html +++ b/functions/dagJson-1.html @@ -1,13 +1,13 @@ -dagJson | @helia/dag-json - v0.0.0
+dagJson | @helia/dag-json - v0.0.0
-
+
@@ -17,7 +17,7 @@

Function dagJson

    - +
  • Create a DAGJSON instance for use with Helia

    @@ -25,36 +25,34 @@

    Function dagJson

Parameters

  • -
    helia: {
        blockstore: Blocks;
    }
    +
    helia: {
        blockstore: Blocks;
    }
+
blockstore: Blocks

Returns DAGJSON

+
  • Defined in packages/dag-json/src/index.ts:118
  • -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/index.html b/index.html index 933a039..a45e306 100644 --- a/index.html +++ b/index.html @@ -1,13 +1,13 @@ -@helia/dag-json - v0.0.0
    +@helia/dag-json - v0.0.0
    -
    +
    @@ -53,15 +53,14 @@

    @helia/dag-json - v0.0.0

    @@ -79,12 +78,11 @@

    License
  • Contribute
  • -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/interfaces/AddOptions.html b/interfaces/AddOptions.html index 62ce517..fffd1b8 100644 --- a/interfaces/AddOptions.html +++ b/interfaces/AddOptions.html @@ -1,13 +1,13 @@ -AddOptions | @helia/dag-json - v0.0.0
    +AddOptions | @helia/dag-json - v0.0.0
    -
    +
    @@ -15,41 +15,33 @@
  • @helia/dag-json
  • AddOptions
  • Interface AddOptions

    -
    -

    An object that contains an AbortSignal as -the optional signal property.

    -
    -
    -

    Example

    const controller = new AbortController()

    aLongRunningOperation({
    signal: controller.signal
    })

    // later

    controller.abort() -
    -

    Hierarchy

    +
  • Defined in packages/dag-json/src/index.ts:39
  • - +

    Properties

    - -
    hasher: MultihashHasher<number>
    +
  • Defined in packages/dag-json/src/index.ts:40
  • onProgress?: ((evt) => void)
    @@ -64,30 +56,29 @@

    Type declaration

    Parameters

    +
    evt: PutBlockProgressEvents

    Returns void

    signal?: AbortSignal
    @@ -98,12 +89,11 @@

    onProgress
  • signal
  • -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/interfaces/DAGJSON.html b/interfaces/DAGJSON.html index 4d44e44..19b9d11 100644 --- a/interfaces/DAGJSON.html +++ b/interfaces/DAGJSON.html @@ -1,13 +1,13 @@ -DAGJSON | @helia/dag-json - v0.0.0
    +DAGJSON | @helia/dag-json - v0.0.0
    -
    +
    @@ -25,28 +25,23 @@

    Hierarchy

    • DAGJSON
    +
  • Defined in packages/dag-json/src/index.ts:51
  • - +
    -

    Properties

    -
    add -get +

    Methods

    +
    -

    Properties

    +

    Methods

    - -
    add: ((str, options?) => Promise<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
      -
    • +
        -
      • (str, options?): Promise<CID<unknown, number, number, Version>>
      • +
      • Add an object to your Helia node and get a CID that refers to the block the object has been stored as.

        @@ -57,23 +52,18 @@

        Parameters

      • str: unknown
      • -
        Optional options: Partial<AddOptions>
    -

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

    +
    Optional options: Partial<AddOptions>
    +

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

    Example

    import { json } from '@helia/dag-json'

    const j = json(helia)
    const cid = await str.add({ hello: 'world' })

    console.info(cid)
    // CID(baguqeerasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea)
    -
    +
  • Defined in packages/dag-json/src/index.ts:68
  • -
    get: (<T>(cid, options?) => Promise<T>)
    -
    -

    Type declaration

    -
      -
      • -
      • <T>(cid, options?): Promise<T>
      • +
      • Get an object from your Helia node, either previously added to it or to another node on the network.

        @@ -87,44 +77,42 @@

        T

    Parameters

    +
    Optional options: Partial<GetOptions>

    Returns Promise<T>

    Example

    import { json } from '@helia/dag-json'
    import { CID } from 'multiformats/cid'

    const j = json(helia)
    const cid = CID.parse('baguqeerasords4njcts6vs7qvdjfcvgnume4hqohf65zsfguprqphs3icwea')
    const obj = await j.get(cid)

    console.info(obj)
    // { hello: 'world' }
    -

    On This Page

    +
  • add
  • +
  • get
  • -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/interfaces/DAGJSONComponents.html b/interfaces/DAGJSONComponents.html index 2693503..a5b0369 100644 --- a/interfaces/DAGJSONComponents.html +++ b/interfaces/DAGJSONComponents.html @@ -1,13 +1,13 @@ -DAGJSONComponents | @helia/dag-json - v0.0.0
    +DAGJSONComponents | @helia/dag-json - v0.0.0
    -
    +
    @@ -20,36 +20,35 @@

    Hierarchy

    • DAGJSONComponents
    +
  • Defined in packages/dag-json/src/index.ts:35
  • - +

    Properties

    -

    Properties

    - -
    blockstore: Blocks
    +
  • Defined in packages/dag-json/src/index.ts:36
  • @@ -58,12 +57,11 @@

    blockstore

    -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/interfaces/GetOptions.html b/interfaces/GetOptions.html index 88d6b06..b19222d 100644 --- a/interfaces/GetOptions.html +++ b/interfaces/GetOptions.html @@ -1,13 +1,13 @@ -GetOptions | @helia/dag-json - v0.0.0
    +GetOptions | @helia/dag-json - v0.0.0
    -
    +
    @@ -15,41 +15,33 @@
  • @helia/dag-json
  • GetOptions
  • Interface GetOptions

    -
    -

    An object that contains an AbortSignal as -the optional signal property.

    -
    -
    -

    Example

    const controller = new AbortController()

    aLongRunningOperation({
    signal: controller.signal
    })

    // later

    controller.abort() -
    -

    Hierarchy

    +
  • Defined in packages/dag-json/src/index.ts:43
  • - +

    Properties

    - -
    codec: BlockCodec<any, unknown>
    +
  • Defined in packages/dag-json/src/index.ts:44
  • onProgress?: ((evt) => void)
    @@ -64,30 +56,29 @@

    Type declaration

    Parameters

    +
    evt: GetBlockProgressEvents

    Returns void

    signal?: AbortSignal
    @@ -98,12 +89,11 @@

    onProgress
  • signal
  • -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/interfaces/unknown.AbortOptions-1.html b/interfaces/unknown.AbortOptions-1.html deleted file mode 100644 index e6a3be8..0000000 --- a/interfaces/unknown.AbortOptions-1.html +++ /dev/null @@ -1,144 +0,0 @@ -AbortOptions | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface AbortOptions

    -
    -

    Options for async operations.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • AbortOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    signal?: AbortSignal
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.AbortOptions.html b/interfaces/unknown.AbortOptions.html deleted file mode 100644 index efa5700..0000000 --- a/interfaces/unknown.AbortOptions.html +++ /dev/null @@ -1,153 +0,0 @@ -AbortOptions | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface AbortOptions

    -
    -

    An object that contains an AbortSignal as -the optional signal property.

    -
    -
    -

    Example

    const controller = new AbortController()

    aLongRunningOperation({
    signal: controller.signal
    })

    // later

    controller.abort() -
    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    signal?: AbortSignal
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.ArrayLike.html b/interfaces/unknown.ArrayLike.html deleted file mode 100644 index a98044a..0000000 --- a/interfaces/unknown.ArrayLike.html +++ /dev/null @@ -1,148 +0,0 @@ -ArrayLike | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface ArrayLike<T>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
      -
    • ArrayLike
    -
    -

    Indexable

    -
    [n: number]: T
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    length: number
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.AsyncIterable.html b/interfaces/unknown.AsyncIterable.html deleted file mode 100644 index 326e7fe..0000000 --- a/interfaces/unknown.AsyncIterable.html +++ /dev/null @@ -1,148 +0,0 @@ -AsyncIterable | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface AsyncIterable<T>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
      -
    • AsyncIterable
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
      - -
    • -

      Returns AsyncIterator<T, any, undefined>

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.AsyncIterator.html b/interfaces/unknown.AsyncIterator.html deleted file mode 100644 index c09cf07..0000000 --- a/interfaces/unknown.AsyncIterator.html +++ /dev/null @@ -1,187 +0,0 @@ -AsyncIterator | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface AsyncIterator<T, TReturn, TNext>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      TReturn = any

    • -
    • -

      TNext = undefined

    -
    -

    Hierarchy

    -
      -
    • AsyncIterator
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Rest ...args: [] | [TNext]
      -

      Returns Promise<IteratorResult<T, TReturn>>

    -
    - -
    -
    - -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.BasePeerId.html b/interfaces/unknown.BasePeerId.html deleted file mode 100644 index 90fdaf8..0000000 --- a/interfaces/unknown.BasePeerId.html +++ /dev/null @@ -1,233 +0,0 @@ -BasePeerId | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface BasePeerId

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    equals: ((other) => boolean)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): boolean
      • -
      • -
        -

        Parameters

        -
        -

        Returns boolean

    -
    - -
    multihash: MultihashDigest<number>
    -
    - -
    privateKey?: Uint8Array
    -
    - -
    publicKey?: Uint8Array
    -
    - -
    toBytes: (() => Uint8Array)
    -
    -

    Type declaration

    -
    -
    - -
    toCID: (() => CID<unknown, number, number, Version>)
    -
    -

    Type declaration

    -
    -
    - -
    toString: (() => string)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): string
      • -
      • -

        Returns string

    -
    - -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.BlockCodec.html b/interfaces/unknown.BlockCodec.html deleted file mode 100644 index 0726b49..0000000 --- a/interfaces/unknown.BlockCodec.html +++ /dev/null @@ -1,205 +0,0 @@ -BlockCodec | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface BlockCodec<Code, T>

    -
    -

    An IPLD codec is a combination of both encoder and decoder.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number

    • -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    code: Code
    -
    - -
    decode: ((bytes) => T)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (bytes): T
      • -
      • -
        -

        Parameters

        -
        -

        Returns T

    -
    - -
    encode: ((data) => ByteView<T>)
    -
    -

    Type declaration

    -
    -
    - -
    name: string
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.BlockDecoder.html b/interfaces/unknown.BlockDecoder.html deleted file mode 100644 index 90cfe01..0000000 --- a/interfaces/unknown.BlockDecoder.html +++ /dev/null @@ -1,174 +0,0 @@ -BlockDecoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface BlockDecoder<Code, T>

    -
    -

    IPLD decoder part of the codec.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number

    • -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    code: Code
    -
    - -
    decode: ((bytes) => T)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (bytes): T
      • -
      • -
        -

        Parameters

        -
        -

        Returns T

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.BlockEncoder.html b/interfaces/unknown.BlockEncoder.html deleted file mode 100644 index e536aaa..0000000 --- a/interfaces/unknown.BlockEncoder.html +++ /dev/null @@ -1,181 +0,0 @@ -BlockEncoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface BlockEncoder<Code, T>

    -
    -

    IPLD encoder part of the codec.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number

    • -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    code: Code
    -
    - -
    encode: ((data) => ByteView<T>)
    -
    -

    Type declaration

    -
    -
    - -
    name: string
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Blocks.html b/interfaces/unknown.Blocks.html deleted file mode 100644 index 6497803..0000000 --- a/interfaces/unknown.Blocks.html +++ /dev/null @@ -1,367 +0,0 @@ -Blocks | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Blocks

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    delete: ((key, options?) => Await<void>)
    -
    -

    Type declaration

    -
    -
    - -
    deleteMany: ((source, options?) => AwaitIterable<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
    -
    - -
    get: ((key, options?) => Await<Uint8Array>)
    -
    -

    Type declaration

    -
    -
    - -
    getAll: ((options?) => AwaitIterable<Pair>)
    -
    -

    Type declaration

    -
    -
    - -
    getMany: ((source, options?) => AwaitIterable<Pair>)
    -
    -

    Type declaration

    -
    -
    - -
    has: ((key, options?) => Await<boolean>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<boolean>
      • -
      • -

        Check for the existence of a value for the passed key

        -
        -
        -

        Parameters

        -
        -

        Returns Await<boolean>

        -
        -

        Example

        const exists = await store.has(new Key('awesome'))

        if (exists) {
        console.log('it is there')
        } else {
        console.log('it is not there')
        } -
        -
    -
    - -
    put: ((key, val, options?) => Await<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
    -
    - -
    putMany: ((source, options?) => AwaitIterable<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Blockstore.html b/interfaces/unknown.Blockstore.html deleted file mode 100644 index e9b3285..0000000 --- a/interfaces/unknown.Blockstore.html +++ /dev/null @@ -1,388 +0,0 @@ -Blockstore | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Blockstore<HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, GetAllOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

    -
    -

    Type Parameters

    -
      -
    • -

      HasOptionsExtension = {}

    • -
    • -

      PutOptionsExtension = {}

    • -
    • -

      PutManyOptionsExtension = {}

    • -
    • -

      GetOptionsExtension = {}

    • -
    • -

      GetManyOptionsExtension = {}

    • -
    • -

      GetAllOptionsExtension = {}

    • -
    • -

      DeleteOptionsExtension = {}

    • -
    • -

      DeleteManyOptionsExtension = {}

    -
    -

    Hierarchy

    -
      -
    • Store<CID, Uint8Array, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension> -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    delete: ((key, options?) => Await<void>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<void>
      • -
      • -

        Remove the record for the passed key

        -
        -
        -

        Parameters

        -
        -

        Returns Await<void>

        -
        -

        Example

        await store.delete(new Key('awesome'))
        console.log('deleted awesome content :(') -
        -
    -
    - -
    deleteMany: ((source, options?) => AwaitIterable<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<CID<unknown, number, number, Version>>
      • -
      • -

        Remove values for the passed keys

        -
        -
        -

        Parameters

        -
        -

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

        -
        -

        Example

        const source = [new Key('awesome')]

        for await (const key of store.deleteMany(source)) {
        console.log(`deleted content with key ${key}`)
        } -
        -
    -
    - -
    get: ((key, options?) => Await<Uint8Array>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<Uint8Array>
      • -
      • -

        Retrieve the value stored under the given key

        -
        -
        -

        Parameters

        -
        -

        Returns Await<Uint8Array>

        -
        -

        Example

        const value = await store.get(new Key('awesome'))
        console.log('got content: %s', value.toString('utf8'))
        // => got content: datastore -
        -
    -
    - -
    getAll: ((options?) => AwaitIterable<Pair>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (options?): AwaitIterable<Pair>
      • -
      • -

        Retrieve all cid/block pairs from the blockstore as an unordered iterable

        -
        -
        -

        Parameters

        -
        -

        Returns AwaitIterable<Pair>

        -
        -

        Example

        for await (const { multihash, block } of store.getAll()) {
        console.log('got:', multihash, block)
        // => got MultihashDigest('Qmfoo') Uint8Array[...]
        } -
        -
    -
    - -
    getMany: ((source, options?) => AwaitIterable<Pair>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<Pair>
      • -
      • -

        Retrieve values for the passed keys

        -
        -
        -

        Parameters

        -
        -

        Returns AwaitIterable<Pair>

        -
        -

        Example

        for await (const { key, value } of store.getMany([new Key('awesome')])) {
        console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
        // => got "/awesome" = "datastore"
        } -
        -
    -
    - -
    has: ((key, options?) => Await<boolean>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<boolean>
      • -
      • -

        Check for the existence of a value for the passed key

        -
        -
        -

        Parameters

        -
        -

        Returns Await<boolean>

        -
        -

        Example

        const exists = await store.has(new Key('awesome'))

        if (exists) {
        console.log('it is there')
        } else {
        console.log('it is not there')
        } -
        -
    -
    - -
    put: ((key, val, options?) => Await<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, val, options?): Await<CID<unknown, number, number, Version>>
      • -
      • -

        Store the passed value under the passed key

        -
        -
        -

        Parameters

        -
        -

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

        -
        -

        Example

        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        -
        -
    -
    - -
    putMany: ((source, options?) => AwaitIterable<CID<unknown, number, number, Version>>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<CID<unknown, number, number, Version>>
      • -
      • -

        Store the given key/value pairs

        -
        -
        -

        Parameters

        -
        -

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

        -
        -

        Example

        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]

        for await (const { key, value } of store.putMany(source)) {
        console.info(`put content for key ${key}`)
        } -
        -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.ByteView-1.html b/interfaces/unknown.ByteView-1.html deleted file mode 100644 index dc2380c..0000000 --- a/interfaces/unknown.ByteView-1.html +++ /dev/null @@ -1,1209 +0,0 @@ -ByteView | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface ByteView<Data>

    -
    -

    A byte-encoded representation of some type of Data.

    -

    A ByteView is essentially a Uint8Array that's been "tagged" with -a Data type parameter indicating the type of encoded data.

    -

    For example, a ByteView<{ hello: "world" }> is a Uint8Array containing a -binary representation of a {hello: "world"}.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    BYTES_PER_ELEMENT: number
    -

    The size in bytes of each element in the array.

    -
    -
    -
    - -
    [Marker]?: Data
    -
    - -
    [toStringTag]: "Uint8Array"
    -
    - - -

    The ArrayBuffer instance referenced by the array.

    -
    -
    -
    - -
    byteLength: number
    -

    The length in bytes of the array.

    -
    -
    -
    - -
    byteOffset: number
    -

    The offset in bytes of the array.

    -
    -
    -
    - -
    length: number
    -

    The length of the array.

    -
    -
    -
    -

    Methods

    -
    - -
      - -
    • -

      Returns IterableIterator<number>

    -
    - -
      - -
    • -

      Returns the item located at the specified index.

      -
      -
      -

      Parameters

      -
        -
      • -
        index: number
        -

        The zero-based index of the desired code unit. A negative index will count back from the last item.

        -
        -
      -

      Returns undefined | number

      -
    -
    - -
      - -
    • -

      Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

      -
      -
      -

      Parameters

      -
        -
      • -
        target: number
        -

        If target is negative, it is treated as length+target where length is the -length of the array.

        -
        -
      • -
      • -
        Optional start: number
        -

        If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end. If start is omitted, 0 is used.

        -
        -
      • -
      • -
        Optional end: number
        -

        If not specified, length of the this object is used as its default value.

        -
        -
      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Returns an array of key, value pairs for every entry in the array

      -
      -

      Returns IterableIterator<[number, number]>

      -
    -
    - -
      - -
    • -

      Determines whether all the members of an array satisfy the specified test.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => unknown)
        -

        A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): unknown
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Changes all array elements from start to end index to a static value and returns the modified array

      -
      -
      -

      Parameters

      -
        -
      • -
        value: number
        -

        value to fill array section with

        -
        -
      • -
      • -
        Optional start: number
        -

        index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        index to stop filling the array at. If end is negative, it is treated as -length+end.

        -
        -
      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Returns the elements of an array that meet the condition specified in a callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => any)
        -

        A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): any
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns any

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, obj) => boolean)
        -

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

        -
        -
        -
          -
        • -
            -
          • (value, index, obj): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              obj: Uint8Array
            -

            Returns boolean

      • -
      • -
        Optional thisArg: any
        -

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -
        -
      -

      Returns undefined | number

      -
    -
    - -
      - -
    • -

      Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, obj) => boolean)
        -

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        -
        -
        -
          -
        • -
            -
          • (value, index, obj): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              obj: Uint8Array
            -

            Returns boolean

      • -
      • -
        Optional thisArg: any
        -

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Performs the specified action for each element in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((value, index, array) => void)
        -

        A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): void
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns void

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Determines whether an array includes a certain element, returning true or false as appropriate.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The element to search for.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The position in this array at which to begin searching for searchElement.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns the index of the first occurrence of a value in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Adds all the elements of an array separated by the specified separator string.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional separator: string
        -

        A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

        -
        -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an list of keys in the array

      -
      -

      Returns IterableIterator<number>

      -
    -
    - -
      - -
    • -

      Returns the index of the last occurrence of a value in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Calls a defined callback function on each element of an array, and returns an array that -contains the results.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((value, index, array) => number)
        -

        A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      -

      Returns number

      -
    • - -
    • -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        initialValue: number
      -

      Returns number

    • - -
    • -

      Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
        -

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): U
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns U

      • -
      • -
        initialValue: U
        -

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -
        -
      -

      Returns U

      -
    -
    - -
      - -
    • -

      Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      -

      Returns number

      -
    • - -
    • -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        initialValue: number
      -

      Returns number

    • - -
    • -

      Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
        -

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): U
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns U

      • -
      • -
        initialValue: U
        -

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -
        -
      -

      Returns U

      -
    -
    - -
      - -
    • -

      Reverses the elements in an Array.

      -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Sets a value or an array of values.

      -
      -
      -

      Parameters

      -
        -
      • -
        array: ArrayLike<number>
        -

        A typed or untyped array of values to set.

        -
        -
      • -
      • -
        Optional offset: number
        -

        The index in the current array at which the values are to be written.

        -
        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Returns a section of an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional start: number
        -

        The beginning of the specified portion of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Determines whether the specified callback function returns true for any element of an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => unknown)
        -

        A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): unknown
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Sorts an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional compareFn: ((a, b) => number)
        -

        Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending order.

        -
        [11,2,22,1].sort((a, b) => a - b)
        -
        -
        -
        -
          -
        • -
            -
          • (a, b): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              a: number
            • -
            • -
              b: number
            -

            Returns number

      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional begin: number
        -

        The index of the beginning of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        The index of the end of the array.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Converts a number to a string by using the current locale.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns a string representation of an array.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns the primitive value of the specified object.

      -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Returns an list of values in the array

      -
      -

      Returns IterableIterator<number>

      -
    -
    - -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.ByteView.html b/interfaces/unknown.ByteView.html deleted file mode 100644 index 6888b11..0000000 --- a/interfaces/unknown.ByteView.html +++ /dev/null @@ -1,1209 +0,0 @@ -ByteView | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface ByteView<Data>

    -
    -

    A byte-encoded representation of some type of Data.

    -

    A ByteView is essentially a Uint8Array that's been "tagged" with -a Data type parameter indicating the type of encoded data.

    -

    For example, a ByteView<{ hello: "world" }> is a Uint8Array containing a -binary representation of a {hello: "world"}.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    BYTES_PER_ELEMENT: number
    -

    The size in bytes of each element in the array.

    -
    -
    -
    - -
    [Marker]?: Data
    -
    - -
    [toStringTag]: "Uint8Array"
    -
    - - -

    The ArrayBuffer instance referenced by the array.

    -
    -
    -
    - -
    byteLength: number
    -

    The length in bytes of the array.

    -
    -
    -
    - -
    byteOffset: number
    -

    The offset in bytes of the array.

    -
    -
    -
    - -
    length: number
    -

    The length of the array.

    -
    -
    -
    -

    Methods

    -
    - -
      - -
    • -

      Returns IterableIterator<number>

    -
    - -
      - -
    • -

      Returns the item located at the specified index.

      -
      -
      -

      Parameters

      -
        -
      • -
        index: number
        -

        The zero-based index of the desired code unit. A negative index will count back from the last item.

        -
        -
      -

      Returns undefined | number

      -
    -
    - -
      - -
    • -

      Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

      -
      -
      -

      Parameters

      -
        -
      • -
        target: number
        -

        If target is negative, it is treated as length+target where length is the -length of the array.

        -
        -
      • -
      • -
        Optional start: number
        -

        If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end. If start is omitted, 0 is used.

        -
        -
      • -
      • -
        Optional end: number
        -

        If not specified, length of the this object is used as its default value.

        -
        -
      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Returns an array of key, value pairs for every entry in the array

      -
      -

      Returns IterableIterator<[number, number]>

      -
    -
    - -
      - -
    • -

      Determines whether all the members of an array satisfy the specified test.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => unknown)
        -

        A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): unknown
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Changes all array elements from start to end index to a static value and returns the modified array

      -
      -
      -

      Parameters

      -
        -
      • -
        value: number
        -

        value to fill array section with

        -
        -
      • -
      • -
        Optional start: number
        -

        index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        index to stop filling the array at. If end is negative, it is treated as -length+end.

        -
        -
      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Returns the elements of an array that meet the condition specified in a callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => any)
        -

        A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): any
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns any

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, obj) => boolean)
        -

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

        -
        -
        -
          -
        • -
            -
          • (value, index, obj): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              obj: Uint8Array
            -

            Returns boolean

      • -
      • -
        Optional thisArg: any
        -

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -
        -
      -

      Returns undefined | number

      -
    -
    - -
      - -
    • -

      Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, obj) => boolean)
        -

        find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        -
        -
        -
          -
        • -
            -
          • (value, index, obj): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              obj: Uint8Array
            -

            Returns boolean

      • -
      • -
        Optional thisArg: any
        -

        If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Performs the specified action for each element in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((value, index, array) => void)
        -

        A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): void
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns void

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Determines whether an array includes a certain element, returning true or false as appropriate.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The element to search for.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The position in this array at which to begin searching for searchElement.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns the index of the first occurrence of a value in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Adds all the elements of an array separated by the specified separator string.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional separator: string
        -

        A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

        -
        -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an list of keys in the array

      -
      -

      Returns IterableIterator<number>

      -
    -
    - -
      - -
    • -

      Returns the index of the last occurrence of a value in an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: number
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Calls a defined callback function on each element of an array, and returns an array that -contains the results.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((value, index, array) => number)
        -

        A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      -

      Returns number

      -
    • - -
    • -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        initialValue: number
      -

      Returns number

    • - -
    • -

      Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
        -

        A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): U
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns U

      • -
      • -
        initialValue: U
        -

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -
        -
      -

      Returns U

      -
    -
    - -
      - -
    • -

      Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -
      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      -

      Returns number

      -
    • - -
    • -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: number
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns number

      • -
      • -
        initialValue: number
      -

      Returns number

    • - -
    • -

      Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

      -
        -
      • -
        callbackfn: ((previousValue, currentValue, currentIndex, array) => U)
        -

        A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

        -
        -
        -
          -
        • -
            -
          • (previousValue, currentValue, currentIndex, array): U
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: number
            • -
            • -
              currentIndex: number
            • -
            • -
              array: Uint8Array
            -

            Returns U

      • -
      • -
        initialValue: U
        -

        If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

        -
        -
      -

      Returns U

      -
    -
    - -
      - -
    • -

      Reverses the elements in an Array.

      -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Sets a value or an array of values.

      -
      -
      -

      Parameters

      -
        -
      • -
        array: ArrayLike<number>
        -

        A typed or untyped array of values to set.

        -
        -
      • -
      • -
        Optional offset: number
        -

        The index in the current array at which the values are to be written.

        -
        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

      Returns a section of an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional start: number
        -

        The beginning of the specified portion of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Determines whether the specified callback function returns true for any element of an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        predicate: ((value, index, array) => unknown)
        -

        A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

        -
        -
        -
          -
        • -
            -
          • (value, index, array): unknown
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: number
            • -
            • -
              index: number
            • -
            • -
              array: Uint8Array
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Sorts an array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional compareFn: ((a, b) => number)
        -

        Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending order.

        -
        [11,2,22,1].sort((a, b) => a - b)
        -
        -
        -
        -
          -
        • -
            -
          • (a, b): number
          • -
          • -
            -

            Parameters

            -
              -
            • -
              a: number
            • -
            • -
              b: number
            -

            Returns number

      -

      Returns ByteView<Data>

      -
    -
    - -
      - -
    • -

      Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional begin: number
        -

        The index of the beginning of the array.

        -
        -
      • -
      • -
        Optional end: number
        -

        The index of the end of the array.

        -
        -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Converts a number to a string by using the current locale.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns a string representation of an array.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns the primitive value of the specified object.

      -
      -

      Returns Uint8Array

      -
    -
    - -
      - -
    • -

      Returns an list of values in the array

      -
      -

      Returns IterableIterator<number>

      -
    -
    - -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Ed25519PeerId.html b/interfaces/unknown.Ed25519PeerId.html deleted file mode 100644 index 5a1bdef..0000000 --- a/interfaces/unknown.Ed25519PeerId.html +++ /dev/null @@ -1,236 +0,0 @@ -Ed25519PeerId | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Ed25519PeerId

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    equals: ((other) => boolean)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): boolean
      • -
      • -
        -

        Parameters

        -
        -

        Returns boolean

    -
    - -
    multihash: MultihashDigest<number>
    -
    - -
    privateKey?: Uint8Array
    -
    - -
    publicKey: Uint8Array
    -
    - -
    toBytes: (() => Uint8Array)
    -
    -

    Type declaration

    -
    -
    - -
    toCID: (() => CID<unknown, number, number, Version>)
    -
    -

    Type declaration

    -
    -
    - -
    toString: (() => string)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): string
      • -
      • -

        Returns string

    -
    - -
    type: "Ed25519"
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.GetOfflineOptions.html b/interfaces/unknown.GetOfflineOptions.html deleted file mode 100644 index d6d3f65..0000000 --- a/interfaces/unknown.GetOfflineOptions.html +++ /dev/null @@ -1,143 +0,0 @@ -GetOfflineOptions | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface GetOfflineOptions

    -
    -

    Hierarchy

    -
      -
    • GetOfflineOptions
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    offline?: boolean
    -

    If true, do not attempt to fetch any missing blocks from the network (default: false)

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Iterable.html b/interfaces/unknown.Iterable.html deleted file mode 100644 index 1547779..0000000 --- a/interfaces/unknown.Iterable.html +++ /dev/null @@ -1,148 +0,0 @@ -Iterable | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Iterable<T>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
      -
    • Iterable
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
      - -
    • -

      Returns Iterator<T, any, undefined>

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.IterableIterator.html b/interfaces/unknown.IterableIterator.html deleted file mode 100644 index 7d308b3..0000000 --- a/interfaces/unknown.IterableIterator.html +++ /dev/null @@ -1,198 +0,0 @@ -IterableIterator | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface IterableIterator<T>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Rest ...args: [] | [undefined]
      -

      Returns IteratorResult<T, any>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Optional value: any
      -

      Returns IteratorResult<T, any>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Optional e: any
      -

      Returns IteratorResult<T, any>

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Iterator.html b/interfaces/unknown.Iterator.html deleted file mode 100644 index dab493b..0000000 --- a/interfaces/unknown.Iterator.html +++ /dev/null @@ -1,190 +0,0 @@ -Iterator | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Iterator<T, TReturn, TNext>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      TReturn = any

    • -
    • -

      TNext = undefined

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Rest ...args: [] | [TNext]
      -

      Returns IteratorResult<T, TReturn>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Optional value: TReturn
      -

      Returns IteratorResult<T, TReturn>

    -
    - -
      - -
    • -
      -

      Parameters

      -
        -
      • -
        Optional e: any
      -

      Returns IteratorResult<T, TReturn>

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.IteratorReturnResult.html b/interfaces/unknown.IteratorReturnResult.html deleted file mode 100644 index fff2fd1..0000000 --- a/interfaces/unknown.IteratorReturnResult.html +++ /dev/null @@ -1,152 +0,0 @@ -IteratorReturnResult | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface IteratorReturnResult<TReturn>

    -
    -

    Type Parameters

    -
      -
    • -

      TReturn

    -
    -

    Hierarchy

    -
      -
    • IteratorReturnResult
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    done: true
    -
    - -
    value: TReturn
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.IteratorYieldResult.html b/interfaces/unknown.IteratorYieldResult.html deleted file mode 100644 index 5dd243c..0000000 --- a/interfaces/unknown.IteratorYieldResult.html +++ /dev/null @@ -1,152 +0,0 @@ -IteratorYieldResult | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface IteratorYieldResult<TYield>

    -
    -

    Type Parameters

    -
      -
    • -

      TYield

    -
    -

    Hierarchy

    -
      -
    • IteratorYieldResult
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    done?: false
    -
    - -
    value: TYield
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Link-1.html b/interfaces/unknown.Link-1.html deleted file mode 100644 index 3fc02a6..0000000 --- a/interfaces/unknown.Link-1.html +++ /dev/null @@ -1,289 +0,0 @@ -Link | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Link<Data, Format, Alg, V>

    -
    -

    Represents an IPLD link to a specific data of type T.

    -
    -
    -

    Template

    Logical type of the data being linked to.

    - -

    Template

    multicodec code corresponding to a codec linked data is encoded with

    - -

    Template

    multicodec code corresponding to the hashing algorithm of the CID

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data extends unknown = unknown

    • -
    • -

      Format extends number = number

    • -
    • -

      Alg extends number = number

    • -
    • -

      V extends Version = 1

      -

      CID version

      -
      -
    -
    -

    Hierarchy

    -
    -
    -

    Implemented by

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    [Marker]?: Data
    -
    - -
    byteLength: number
    -
    - -
    byteOffset: number
    -
    - -
    bytes: ByteView<Link<Data, Format, Alg, V>>
    -
    - -
    code: Format
    -
    - -
    equals: ((other) => other is Link<Data, Format, Alg, Version>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): other is Link<Data, Format, Alg, Version>
      • -
      • -
        -

        Parameters

        -
          -
        • -
          other: unknown
        -

        Returns other is Link<Data, Format, Alg, Version>

    -
    - -
    link: (() => Link<Data, Format, Alg, V>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): Link<Data, Format, Alg, V>
      • -
      • -

        Returns Link<Data, Format, Alg, V>

    -
    - -
    multihash: MultihashDigest<Alg>
    -
    - -
    toString: (<Prefix>(base?) => ToString<Link<Data, Format, Alg, Version>, Prefix>)
    -
    -

    Type declaration

    -
    -
    - -
    toV1: (() => Link<Data, Format, Alg, 1>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): Link<Data, Format, Alg, 1>
      • -
      • -

        Returns Link<Data, Format, Alg, 1>

    -
    - -
    version: V
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Link.html b/interfaces/unknown.Link.html deleted file mode 100644 index 2264bf9..0000000 --- a/interfaces/unknown.Link.html +++ /dev/null @@ -1,289 +0,0 @@ -Link | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Link<Data, Format, Alg, V>

    -
    -

    Represents an IPLD link to a specific data of type T.

    -
    -
    -

    Template

    Logical type of the data being linked to.

    - -

    Template

    multicodec code corresponding to a codec linked data is encoded with

    - -

    Template

    multicodec code corresponding to the hashing algorithm of the CID

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Data extends unknown = unknown

    • -
    • -

      Format extends number = number

    • -
    • -

      Alg extends number = number

    • -
    • -

      V extends Version = 1

      -

      CID version

      -
      -
    -
    -

    Hierarchy

    -
    -
    -

    Implemented by

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    [Marker]?: Data
    -
    - -
    byteLength: number
    -
    - -
    byteOffset: number
    -
    - -
    bytes: ByteView<Link<Data, Format, Alg, V>>
    -
    - -
    code: Format
    -
    - -
    equals: ((other) => other is Link<Data, Format, Alg, Version>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): other is Link<Data, Format, Alg, Version>
      • -
      • -
        -

        Parameters

        -
          -
        • -
          other: unknown
        -

        Returns other is Link<Data, Format, Alg, Version>

    -
    - -
    link: (() => Link<Data, Format, Alg, V>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): Link<Data, Format, Alg, V>
      • -
      • -

        Returns Link<Data, Format, Alg, V>

    -
    - -
    multihash: MultihashDigest<Alg>
    -
    - -
    toString: (<Prefix>(base?) => ToString<Link<Data, Format, Alg, Version>, Prefix>)
    -
    -

    Type declaration

    -
    -
    - -
    toV1: (() => Link<Data, Format, Alg, 1>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): Link<Data, Format, Alg, 1>
      • -
      • -

        Returns Link<Data, Format, Alg, 1>

    -
    - -
    version: V
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultibaseDecoder-1.html b/interfaces/unknown.MultibaseDecoder-1.html deleted file mode 100644 index b53cd74..0000000 --- a/interfaces/unknown.MultibaseDecoder-1.html +++ /dev/null @@ -1,169 +0,0 @@ -MultibaseDecoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultibaseDecoder<Prefix>

    -
    -

    Interface implemented by multibase decoder, that takes multibase strings -to bytes. It may support single encoding like base32 or multiple encodings -like base32, base58btc, base64. If passed multibase is incompatible it will -throw an exception.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -

    Hierarchy

    -
      -
    • MultibaseDecoder
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    decode: ((multibase) => Uint8Array)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (multibase): Uint8Array
      • -
      • -

        Decodes multibase string (which must have a multibase prefix added). -If prefix does not match

        -
        -
        -

        Parameters

        -
        -

        Returns Uint8Array

        -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultibaseDecoder.html b/interfaces/unknown.MultibaseDecoder.html deleted file mode 100644 index d0f2d4e..0000000 --- a/interfaces/unknown.MultibaseDecoder.html +++ /dev/null @@ -1,169 +0,0 @@ -MultibaseDecoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultibaseDecoder<Prefix>

    -
    -

    Interface implemented by multibase decoder, that takes multibase strings -to bytes. It may support single encoding like base32 or multiple encodings -like base32, base58btc, base64. If passed multibase is incompatible it will -throw an exception.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -

    Hierarchy

    -
      -
    • MultibaseDecoder
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    decode: ((multibase) => Uint8Array)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (multibase): Uint8Array
      • -
      • -

        Decodes multibase string (which must have a multibase prefix added). -If prefix does not match

        -
        -
        -

        Parameters

        -
        -

        Returns Uint8Array

        -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultibaseEncoder-1.html b/interfaces/unknown.MultibaseEncoder-1.html deleted file mode 100644 index 2c66312..0000000 --- a/interfaces/unknown.MultibaseEncoder-1.html +++ /dev/null @@ -1,187 +0,0 @@ -MultibaseEncoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultibaseEncoder<Prefix>

    -
    -

    Multibase encoder for the specific base encoding encodes bytes into -multibase of that encoding.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -

    Hierarchy

    -
      -
    • MultibaseEncoder
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    encode: ((bytes) => Multibase<Prefix>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (bytes): Multibase<Prefix>
      • -
      • -

        Encodes binary data into multibase string (which will have a -prefix added).

        -
        -
        -

        Parameters

        -
        -

        Returns Multibase<Prefix>

        -
    -
    - -
    name: string
    -

    Name of the encoding.

    -
    -
    -
    - -
    prefix: Prefix
    -

    Prefix character for that base encoding.

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultibaseEncoder.html b/interfaces/unknown.MultibaseEncoder.html deleted file mode 100644 index 964a837..0000000 --- a/interfaces/unknown.MultibaseEncoder.html +++ /dev/null @@ -1,187 +0,0 @@ -MultibaseEncoder | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultibaseEncoder<Prefix>

    -
    -

    Multibase encoder for the specific base encoding encodes bytes into -multibase of that encoding.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -

    Hierarchy

    -
      -
    • MultibaseEncoder
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    encode: ((bytes) => Multibase<Prefix>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (bytes): Multibase<Prefix>
      • -
      • -

        Encodes binary data into multibase string (which will have a -prefix added).

        -
        -
        -

        Parameters

        -
        -

        Returns Multibase<Prefix>

        -
    -
    - -
    name: string
    -

    Name of the encoding.

    -
    -
    -
    - -
    prefix: Prefix
    -

    Prefix character for that base encoding.

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultihashDigest-1.html b/interfaces/unknown.MultihashDigest-1.html deleted file mode 100644 index 87ac01a..0000000 --- a/interfaces/unknown.MultihashDigest-1.html +++ /dev/null @@ -1,183 +0,0 @@ -MultihashDigest | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultihashDigest<Code>

    -
    -

    Represents a multihash digest which carries information about the -hashing algorithm and an actual hash digest.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number = number

    -
    -

    Hierarchy

    -
      -
    • MultihashDigest
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    bytes: Uint8Array
    -

    Binary representation of this multihash digest.

    -
    -
    -
    - -
    code: Code
    -

    Code of the multihash

    -
    -
    -
    - -
    digest: Uint8Array
    -

    Raw digest (without a hashing algorithm info)

    -
    -
    -
    - -
    size: number
    -

    byte length of the this.digest

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultihashDigest.html b/interfaces/unknown.MultihashDigest.html deleted file mode 100644 index af63ae4..0000000 --- a/interfaces/unknown.MultihashDigest.html +++ /dev/null @@ -1,183 +0,0 @@ -MultihashDigest | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultihashDigest<Code>

    -
    -

    Represents a multihash digest which carries information about the -hashing algorithm and an actual hash digest.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number = number

    -
    -

    Hierarchy

    -
      -
    • MultihashDigest
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    bytes: Uint8Array
    -

    Binary representation of this multihash digest.

    -
    -
    -
    - -
    code: Code
    -

    Code of the multihash

    -
    -
    -
    - -
    digest: Uint8Array
    -

    Raw digest (without a hashing algorithm info)

    -
    -
    -
    - -
    size: number
    -

    byte length of the this.digest

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.MultihashHasher.html b/interfaces/unknown.MultihashHasher.html deleted file mode 100644 index a398d7b..0000000 --- a/interfaces/unknown.MultihashHasher.html +++ /dev/null @@ -1,189 +0,0 @@ -MultihashHasher | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface MultihashHasher<Code>

    -
    -

    Hasher represents a hashing algorithm implementation that produces as -MultihashDigest.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      Code extends number = number

    -
    -

    Hierarchy

    -
      -
    • MultihashHasher
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    code: Code
    -

    Code of the multihash

    -
    -
    -
    - -
    digest: ((input) => MultihashDigest<Code> | Promise<MultihashDigest<Code>>)
    -
    -

    Type declaration

    -
    -
    - -
    name: string
    -

    Name of the multihash

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Pair.html b/interfaces/unknown.Pair.html deleted file mode 100644 index e47f3a4..0000000 --- a/interfaces/unknown.Pair.html +++ /dev/null @@ -1,147 +0,0 @@ -Pair | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Pair

    -
    -

    Hierarchy

    -
      -
    • Pair
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    block: Uint8Array
    -
    - -
    cid: CID<unknown, number, number, Version>
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Phantom-1.html b/interfaces/unknown.Phantom-1.html deleted file mode 100644 index f7f86f4..0000000 --- a/interfaces/unknown.Phantom-1.html +++ /dev/null @@ -1,161 +0,0 @@ -Phantom | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Phantom<T>

    -
    -

    A utility type to retain an unused type parameter T. -Similar to phantom type parameters in Rust.

    -

    Capturing unused type parameters allows us to define "nominal types," which -TypeScript does not natively support. Nominal types in turn allow us to capture -semantics not represented in the actual type structure, without requiring us to define -new classes or pay additional runtime costs.

    -

    For a concrete example, see ByteView, which extends the Uint8Array type to capture -type information about the structure of the data encoded into the array.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    [Marker]?: T
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Phantom.html b/interfaces/unknown.Phantom.html deleted file mode 100644 index 5d6c61e..0000000 --- a/interfaces/unknown.Phantom.html +++ /dev/null @@ -1,161 +0,0 @@ -Phantom | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Phantom<T>

    -
    -

    A utility type to retain an unused type parameter T. -Similar to phantom type parameters in Rust.

    -

    Capturing unused type parameters allows us to define "nominal types," which -TypeScript does not natively support. Nominal types in turn allow us to capture -semantics not represented in the actual type structure, without requiring us to define -new classes or pay additional runtime costs.

    -

    For a concrete example, see ByteView, which extends the Uint8Array type to capture -type information about the structure of the data encoded into the array.

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    [Marker]?: T
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.ProgressEvent.html b/interfaces/unknown.ProgressEvent.html deleted file mode 100644 index 9b8acd1..0000000 --- a/interfaces/unknown.ProgressEvent.html +++ /dev/null @@ -1,164 +0,0 @@ -ProgressEvent | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface ProgressEvent<T, D>

    -
    -

    Progress events are emitted during long running operations

    -
    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends string = any

    • -
    • -

      D = unknown

    -
    -

    Hierarchy

    -
      -
    • ProgressEvent
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    detail: D
    -

    Context-specific event information

    -
    -
    -
    - -
    type: T
    -

    The event type

    -
    -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.ProgressOptions.html b/interfaces/unknown.ProgressOptions.html deleted file mode 100644 index eaa5306..0000000 --- a/interfaces/unknown.ProgressOptions.html +++ /dev/null @@ -1,170 +0,0 @@ -ProgressOptions | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface ProgressOptions<Event>

    -
    -

    Define an onProgress callback that can be invoked with ProgressEvents

    -
    -
    -

    Example

    type MyOperationProgressEvents =
    ProgressEvent<'operation:start'> |
    ProgressEvent<'operation:success', Result> |
    ProgressEvent<'operation:error', Error>

    export interface MyOperationOptions extends ProgressOptions<MyOperationProgressEvents> {
    // define options here
    } -
    -
    -
    -

    Type Parameters

    -
    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

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

    Type declaration

    -
      -
    • -
        -
      • (evt): void
      • -
      • -
        -

        Parameters

        -
        -

        Returns void

    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.PromiseLike.html b/interfaces/unknown.PromiseLike.html deleted file mode 100644 index e93a6fe..0000000 --- a/interfaces/unknown.PromiseLike.html +++ /dev/null @@ -1,172 +0,0 @@ -PromiseLike | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface PromiseLike<T>

    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Hierarchy

    -
      -
    • PromiseLike
    -
    -
    -
    - -
    -
    -

    Methods

    -
    -
    -

    Methods

    -
    - -
      - -
    • -

      Attaches callbacks for the resolution and/or rejection of the Promise.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        TResult1 = T

      • -
      • -

        TResult2 = never

      -
      -

      Parameters

      -
        -
      • -
        Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
        -

        The callback to execute when the Promise is resolved.

        -
        -
      • -
      • -
        Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)
        -

        The callback to execute when the Promise is rejected.

        -
        -
      -

      Returns PromiseLike<TResult1 | TResult2>

      A Promise for the completion of which ever callback is executed.

      - -
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.RSAPeerId.html b/interfaces/unknown.RSAPeerId.html deleted file mode 100644 index e1a1ca1..0000000 --- a/interfaces/unknown.RSAPeerId.html +++ /dev/null @@ -1,236 +0,0 @@ -RSAPeerId | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface RSAPeerId

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    equals: ((other) => boolean)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): boolean
      • -
      • -
        -

        Parameters

        -
        -

        Returns boolean

    -
    - -
    multihash: MultihashDigest<number>
    -
    - -
    privateKey?: Uint8Array
    -
    - -
    publicKey?: Uint8Array
    -
    - -
    toBytes: (() => Uint8Array)
    -
    -

    Type declaration

    -
    -
    - -
    toCID: (() => CID<unknown, number, number, Version>)
    -
    -

    Type declaration

    -
    -
    - -
    toString: (() => string)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): string
      • -
      • -

        Returns string

    -
    - -
    type: "RSA"
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Secp256k1PeerId.html b/interfaces/unknown.Secp256k1PeerId.html deleted file mode 100644 index 06ff7c8..0000000 --- a/interfaces/unknown.Secp256k1PeerId.html +++ /dev/null @@ -1,236 +0,0 @@ -Secp256k1PeerId | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Secp256k1PeerId

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    - -
    equals: ((other) => boolean)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (other): boolean
      • -
      • -
        -

        Parameters

        -
        -

        Returns boolean

    -
    - -
    multihash: MultihashDigest<number>
    -
    - -
    privateKey?: Uint8Array
    -
    - -
    publicKey: Uint8Array
    -
    - -
    toBytes: (() => Uint8Array)
    -
    -

    Type declaration

    -
    -
    - -
    toCID: (() => CID<unknown, number, number, Version>)
    -
    -

    Type declaration

    -
    -
    - -
    toString: (() => string)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (): string
      • -
      • -

        Returns string

    -
    - -
    type: "secp256k1"
    -
    -
    \ No newline at end of file diff --git a/interfaces/unknown.Store.html b/interfaces/unknown.Store.html deleted file mode 100644 index 011edcb..0000000 --- a/interfaces/unknown.Store.html +++ /dev/null @@ -1,357 +0,0 @@ -Store | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Interface Store<Key, Value, Pair, HasOptionsExtension, PutOptionsExtension, PutManyOptionsExtension, GetOptionsExtension, GetManyOptionsExtension, DeleteOptionsExtension, DeleteManyOptionsExtension>

    -
    -

    Type Parameters

    -
      -
    • -

      Key

    • -
    • -

      Value

    • -
    • -

      Pair

    • -
    • -

      HasOptionsExtension = {}

    • -
    • -

      PutOptionsExtension = {}

    • -
    • -

      PutManyOptionsExtension = {}

    • -
    • -

      GetOptionsExtension = {}

    • -
    • -

      GetManyOptionsExtension = {}

    • -
    • -

      DeleteOptionsExtension = {}

    • -
    • -

      DeleteManyOptionsExtension = {}

    -
    -

    Hierarchy

    -
    -
    -
    -
    - -
    -
    -

    Properties

    -
    -
    -

    Properties

    -
    - -
    delete: ((key, options?) => Await<void>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<void>
      • -
      • -

        Remove the record for the passed key

        -
        -
        -

        Parameters

        -
          -
        • -
          key: Key
        • -
        • -
          Optional options: AbortOptions & DeleteOptionsExtension
        -

        Returns Await<void>

        -
        -

        Example

        await store.delete(new Key('awesome'))
        console.log('deleted awesome content :(') -
        -
    -
    - -
    deleteMany: ((source, options?) => AwaitIterable<Key>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<Key>
      • -
      • -

        Remove values for the passed keys

        -
        -
        -

        Parameters

        -
        -

        Returns AwaitIterable<Key>

        -
        -

        Example

        const source = [new Key('awesome')]

        for await (const key of store.deleteMany(source)) {
        console.log(`deleted content with key ${key}`)
        } -
        -
    -
    - -
    get: ((key, options?) => Await<Value>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<Value>
      • -
      • -

        Retrieve the value stored under the given key

        -
        -
        -

        Parameters

        -
          -
        • -
          key: Key
        • -
        • -
          Optional options: AbortOptions & GetOptionsExtension
        -

        Returns Await<Value>

        -
        -

        Example

        const value = await store.get(new Key('awesome'))
        console.log('got content: %s', value.toString('utf8'))
        // => got content: datastore -
        -
    -
    - -
    getMany: ((source, options?) => AwaitIterable<Pair>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<Pair>
      • -
      • -

        Retrieve values for the passed keys

        -
        -
        -

        Parameters

        -
        -

        Returns AwaitIterable<Pair>

        -
        -

        Example

        for await (const { key, value } of store.getMany([new Key('awesome')])) {
        console.log(`got "${key}" = "${new TextDecoder('utf8').decode(value)}"`')
        // => got "/awesome" = "datastore"
        } -
        -
    -
    - -
    has: ((key, options?) => Await<boolean>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, options?): Await<boolean>
      • -
      • -

        Check for the existence of a value for the passed key

        -
        -
        -

        Parameters

        -
          -
        • -
          key: Key
        • -
        • -
          Optional options: AbortOptions & HasOptionsExtension
        -

        Returns Await<boolean>

        -
        -

        Example

        const exists = await store.has(new Key('awesome'))

        if (exists) {
        console.log('it is there')
        } else {
        console.log('it is not there')
        } -
        -
    -
    - -
    put: ((key, val, options?) => Await<Key>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (key, val, options?): Await<Key>
      • -
      • -

        Store the passed value under the passed key

        -
        -
        -

        Parameters

        -
          -
        • -
          key: Key
        • -
        • -
          val: Value
        • -
        • -
          Optional options: AbortOptions & PutOptionsExtension
        -

        Returns Await<Key>

        -
        -

        Example

        await store.put([{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }])
        -
        -
    -
    - -
    putMany: ((source, options?) => AwaitIterable<Key>)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (source, options?): AwaitIterable<Key>
      • -
      • -

        Store the given key/value pairs

        -
        -
        -

        Parameters

        -
        -

        Returns AwaitIterable<Key>

        -
        -

        Example

        const source = [{ key: new Key('awesome'), value: new Uint8Array([0, 1, 2, 3]) }]

        for await (const { key, value } of store.putMany(source)) {
        console.info(`put content for key ${key}`)
        } -
        -
    -
    -
    \ No newline at end of file diff --git a/modules.html b/modules.html index b1f7434..8afeb1e 100644 --- a/modules.html +++ b/modules.html @@ -1,13 +1,13 @@ -@helia/dag-json - v0.0.0
    +@helia/dag-json - v0.0.0
    -
    +
    @@ -24,42 +24,36 @@

    Example

    import
     

    Index

    -

    Modules

    -
    -

    Interfaces

    -

    Functions

    -
    -
    \ No newline at end of file + +
    \ No newline at end of file diff --git a/modules/unknown.html b/modules/unknown.html deleted file mode 100644 index e09c4f3..0000000 --- a/modules/unknown.html +++ /dev/null @@ -1,191 +0,0 @@ -unknown | @helia/dag-json - v0.0.0
    -
    - -
    -
    - -
    -
    \ No newline at end of file diff --git a/types/unknown.ArrayBufferLike.html b/types/unknown.ArrayBufferLike.html deleted file mode 100644 index 318c13b..0000000 --- a/types/unknown.ArrayBufferLike.html +++ /dev/null @@ -1,116 +0,0 @@ -ArrayBufferLike | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file diff --git a/types/unknown.Await.html b/types/unknown.Await.html deleted file mode 100644 index 1441d5a..0000000 --- a/types/unknown.Await.html +++ /dev/null @@ -1,124 +0,0 @@ -Await | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file diff --git a/types/unknown.AwaitIterable.html b/types/unknown.AwaitIterable.html deleted file mode 100644 index 04a61ed..0000000 --- a/types/unknown.AwaitIterable.html +++ /dev/null @@ -1,124 +0,0 @@ -AwaitIterable | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias AwaitIterable<T>

    -
    AwaitIterable<T>: Iterable<T> | AsyncIterable<T>
    -

    An iterable or async iterable of values

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapNetworkNotifyProgressEvents.html b/types/unknown.BitswapNetworkNotifyProgressEvents.html deleted file mode 100644 index d6663a1..0000000 --- a/types/unknown.BitswapNetworkNotifyProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapNetworkNotifyProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapNetworkNotifyProgressEvents

    -
    BitswapNetworkNotifyProgressEvents: ProgressEvent<"bitswap:network:provide", CID> | BitswapNetworkProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapNetworkProgressEvents.html b/types/unknown.BitswapNetworkProgressEvents.html deleted file mode 100644 index b98ab9f..0000000 --- a/types/unknown.BitswapNetworkProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapNetworkProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapNetworkProgressEvents

    -
    BitswapNetworkProgressEvents: ProgressEvent<"bitswap:network:dial", PeerId>
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapNetworkWantProgressEvents.html b/types/unknown.BitswapNetworkWantProgressEvents.html deleted file mode 100644 index 3053257..0000000 --- a/types/unknown.BitswapNetworkWantProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapNetworkWantProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapNetworkWantProgressEvents

    -
    BitswapNetworkWantProgressEvents: ProgressEvent<"bitswap:network:send-wantlist", PeerId> | ProgressEvent<"bitswap:network:send-wantlist:error", {
        error: Error;
        peer: PeerId;
    }> | ProgressEvent<"bitswap:network:find-providers", CID> | BitswapNetworkProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapNotifyProgressEvents.html b/types/unknown.BitswapNotifyProgressEvents.html deleted file mode 100644 index eb0209c..0000000 --- a/types/unknown.BitswapNotifyProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapNotifyProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapNotifyProgressEvents

    -
    BitswapNotifyProgressEvents: BitswapNetworkNotifyProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapWantBlockProgressEvents.html b/types/unknown.BitswapWantBlockProgressEvents.html deleted file mode 100644 index ab1fc72..0000000 --- a/types/unknown.BitswapWantBlockProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapWantBlockProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapWantBlockProgressEvents

    -
    BitswapWantBlockProgressEvents: ProgressEvent<"bitswap:want-block:unwant", CID> | ProgressEvent<"bitswap:want-block:block", CID> | BitswapNetworkWantProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.BitswapWantProgressEvents.html b/types/unknown.BitswapWantProgressEvents.html deleted file mode 100644 index 1691e12..0000000 --- a/types/unknown.BitswapWantProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -BitswapWantProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias BitswapWantProgressEvents

    -
    BitswapWantProgressEvents: BitswapWantBlockProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.DeleteBlockProgressEvents.html b/types/unknown.DeleteBlockProgressEvents.html deleted file mode 100644 index 77f3dbb..0000000 --- a/types/unknown.DeleteBlockProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -DeleteBlockProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias DeleteBlockProgressEvents

    -
    DeleteBlockProgressEvents: ProgressEvent<"blocks:delete:blockstore:delete", CID>
    -
    -
    \ No newline at end of file diff --git a/types/unknown.DeleteManyBlocksProgressEvents.html b/types/unknown.DeleteManyBlocksProgressEvents.html deleted file mode 100644 index a3cac9e..0000000 --- a/types/unknown.DeleteManyBlocksProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -DeleteManyBlocksProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias DeleteManyBlocksProgressEvents

    -
    DeleteManyBlocksProgressEvents: ProgressEvent<"blocks:delete-many:blockstore:delete-many">
    -
    -
    \ No newline at end of file diff --git a/types/unknown.GetAllBlocksProgressEvents.html b/types/unknown.GetAllBlocksProgressEvents.html deleted file mode 100644 index c749810..0000000 --- a/types/unknown.GetAllBlocksProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -GetAllBlocksProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias GetAllBlocksProgressEvents

    -
    GetAllBlocksProgressEvents: ProgressEvent<"blocks:get-all:blockstore:get-many">
    -
    -
    \ No newline at end of file diff --git a/types/unknown.GetBlockProgressEvents.html b/types/unknown.GetBlockProgressEvents.html deleted file mode 100644 index 7d2a37c..0000000 --- a/types/unknown.GetBlockProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -GetBlockProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias GetBlockProgressEvents

    -
    GetBlockProgressEvents: ProgressEvent<"blocks:get:bitswap:want", CID> | ProgressEvent<"blocks:get:blockstore:get", CID> | ProgressEvent<"blocks:get:blockstore:put", CID> | BitswapWantProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.GetManyBlocksProgressEvents.html b/types/unknown.GetManyBlocksProgressEvents.html deleted file mode 100644 index 43236fc..0000000 --- a/types/unknown.GetManyBlocksProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -GetManyBlocksProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias GetManyBlocksProgressEvents

    -
    GetManyBlocksProgressEvents: ProgressEvent<"blocks:get-many:blockstore:get-many"> | ProgressEvent<"blocks:get-many:bitswap:want", CID> | ProgressEvent<"blocks:get-many:blockstore:put", CID> | BitswapWantProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.HasBlockProgressEvents.html b/types/unknown.HasBlockProgressEvents.html deleted file mode 100644 index c1212fa..0000000 --- a/types/unknown.HasBlockProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -HasBlockProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias HasBlockProgressEvents

    -
    HasBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:bitswap:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID> | BitswapNotifyProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.IteratorResult.html b/types/unknown.IteratorResult.html deleted file mode 100644 index e5f8a55..0000000 --- a/types/unknown.IteratorResult.html +++ /dev/null @@ -1,123 +0,0 @@ -IteratorResult | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias IteratorResult<T, TReturn>

    -
    IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      TReturn = any

    -
    -
    \ No newline at end of file diff --git a/types/unknown.Multibase-1.html b/types/unknown.Multibase-1.html deleted file mode 100644 index 1ef4fbf..0000000 --- a/types/unknown.Multibase-1.html +++ /dev/null @@ -1,125 +0,0 @@ -Multibase | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias Multibase<Prefix>

    -
    Multibase<Prefix>: string | string & {
        0: Prefix;
    }
    -

    Multibase represents base encoded strings with a prefix first character -describing it's encoding.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -
    -
    \ No newline at end of file diff --git a/types/unknown.Multibase.html b/types/unknown.Multibase.html deleted file mode 100644 index 1a5d0eb..0000000 --- a/types/unknown.Multibase.html +++ /dev/null @@ -1,125 +0,0 @@ -Multibase | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias Multibase<Prefix>

    -
    Multibase<Prefix>: string | string & {
        0: Prefix;
    }
    -

    Multibase represents base encoded strings with a prefix first character -describing it's encoding.

    -
    -
    -

    Type Parameters

    -
      -
    • -

      Prefix extends string

    -
    -
    -
    \ No newline at end of file diff --git a/types/unknown.Partial.html b/types/unknown.Partial.html deleted file mode 100644 index ff4f7cb..0000000 --- a/types/unknown.Partial.html +++ /dev/null @@ -1,124 +0,0 @@ -Partial | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias Partial<T>

    -
    Partial<T>: {
        [P in keyof T]?: T[P]
    }
    -

    Make all properties in T optional

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -
    -
    \ No newline at end of file diff --git a/types/unknown.PeerId.html b/types/unknown.PeerId.html deleted file mode 100644 index 55f7fd2..0000000 --- a/types/unknown.PeerId.html +++ /dev/null @@ -1,116 +0,0 @@ -PeerId | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file diff --git a/types/unknown.PeerIdType.html b/types/unknown.PeerIdType.html deleted file mode 100644 index 05502d9..0000000 --- a/types/unknown.PeerIdType.html +++ /dev/null @@ -1,116 +0,0 @@ -PeerIdType | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file diff --git a/types/unknown.PutBlockProgressEvents.html b/types/unknown.PutBlockProgressEvents.html deleted file mode 100644 index c1962ce..0000000 --- a/types/unknown.PutBlockProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -PutBlockProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias PutBlockProgressEvents

    -
    PutBlockProgressEvents: ProgressEvent<"blocks:put:duplicate", CID> | ProgressEvent<"blocks:put:bitswap:notify", CID> | ProgressEvent<"blocks:put:blockstore:put", CID> | BitswapNotifyProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.PutManyBlocksProgressEvents.html b/types/unknown.PutManyBlocksProgressEvents.html deleted file mode 100644 index 1192cc3..0000000 --- a/types/unknown.PutManyBlocksProgressEvents.html +++ /dev/null @@ -1,116 +0,0 @@ -PutManyBlocksProgressEvents | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias PutManyBlocksProgressEvents

    -
    PutManyBlocksProgressEvents: ProgressEvent<"blocks:put-many:duplicate", CID> | ProgressEvent<"blocks:put-many:bitswap:notify", CID> | ProgressEvent<"blocks:put-many:blockstore:put-many"> | BitswapNotifyProgressEvents
    -
    -
    \ No newline at end of file diff --git a/types/unknown.ToString-1.html b/types/unknown.ToString-1.html deleted file mode 100644 index 40292ef..0000000 --- a/types/unknown.ToString-1.html +++ /dev/null @@ -1,123 +0,0 @@ -ToString | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias ToString<T, Prefix>

    -
    ToString<T, Prefix>: Multibase<Prefix> & Phantom<T>
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      Prefix extends string = string

    -
    -
    \ No newline at end of file diff --git a/types/unknown.ToString.html b/types/unknown.ToString.html deleted file mode 100644 index 160e895..0000000 --- a/types/unknown.ToString.html +++ /dev/null @@ -1,123 +0,0 @@ -ToString | @helia/dag-json - v0.0.0
    -
    - -
    -
    -
    -
    - -

    Type alias ToString<T, Prefix>

    -
    ToString<T, Prefix>: Multibase<Prefix> & Phantom<T>
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      Prefix extends string = string

    -
    -
    \ No newline at end of file diff --git a/types/unknown.Version-1.html b/types/unknown.Version-1.html deleted file mode 100644 index 8ec7284..0000000 --- a/types/unknown.Version-1.html +++ /dev/null @@ -1,116 +0,0 @@ -Version | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file diff --git a/types/unknown.Version.html b/types/unknown.Version.html deleted file mode 100644 index 03efbc0..0000000 --- a/types/unknown.Version.html +++ /dev/null @@ -1,116 +0,0 @@ -Version | @helia/dag-json - v0.0.0
    -
    - -
    - -
    \ No newline at end of file