diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 000000000..b79c9e89f --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 000000000..7dead6118 --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js index 3092fea0e..7352c3677 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,8 +1,8 @@ "use strict"; -"use strict";(()=>{var Ie=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ie(_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;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let 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 He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",pe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(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(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,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();})(); +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||this.scrollToHash()}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/classes/_divviup_dap.DAPError.html b/classes/_divviup_dap.DAPError.html index 6c546c959..03966a7ab 100644 --- a/classes/_divviup_dap.DAPError.html +++ b/classes/_divviup_dap.DAPError.html @@ -1,22 +1,20 @@ -DAPError | Documentation

Class DAPError

Hierarchy (view full)

Constructors

constructor -

Properties

clientContext -detail -instance -message -name -shortType -stack? -status -taskId -title -type -prepareStackTrace? -stackTraceLimit -

Methods

captureStackTrace -fromResponse -

Constructors

constructor

Properties

Readonly clientContext

clientContext: string

Readonly detail

detail: string

Readonly instance

instance: string

message

message: string

name

name: string

Readonly shortType

shortType: string

Optional stack

stack?: string

Readonly status

status: number

Readonly taskId

taskId: TaskId

Readonly title

title: string

Readonly type

type: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

-

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromResponse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +DAPError | Documentation

Class DAPError

Hierarchy (view full)

Constructors

constructor +

Properties

clientContext +detail +instance +message +name +shortType +stack? +status +taskId +title +type +prepareStackTrace? +stackTraceLimit +

Methods

captureStackTrace +fromResponse +

Constructors

constructor

Properties

Readonly clientContext

clientContext: string

Readonly detail

detail: string

Readonly instance

instance: string

message

message: string

name

name: string

Readonly shortType

shortType: string

Optional stack

stack?: string

Readonly status

status: number

Readonly taskId

taskId: TaskId

Readonly title

title: string

Readonly type

type: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

    • (err, stackTraces): any

    • Parameters

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromResponse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap.HpkeConfig.html b/classes/_divviup_dap.HpkeConfig.html index 7ae3d8970..e5c7371c4 100644 --- a/classes/_divviup_dap.HpkeConfig.html +++ b/classes/_divviup_dap.HpkeConfig.html @@ -1,10 +1,10 @@ -HpkeConfig | Documentation

Class HpkeConfig

Implements

Constructors

constructor -

Properties

aeadId -id -kdfId -kemId -publicKey -

Methods

encode -seal -parse -

Constructors

constructor

Properties

aeadId

aeadId: number

id

id: number

kdfId

kdfId: number

kemId

kemId: number

publicKey

publicKey: Buffer

Methods

encode

seal

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +HpkeConfig | Documentation

Class HpkeConfig

Implements

Constructors

constructor +

Properties

aeadId +id +kdfId +kemId +publicKey +

Methods

encode +seal +parse +

Constructors

constructor

Properties

aeadId

aeadId: number

id

id: number

kdfId

kdfId: number

kemId

kemId: number

publicKey

publicKey: Buffer

Methods

encode

seal

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap.Task.html b/classes/_divviup_dap.Task.html index 694d6e0f0..81b18852d 100644 --- a/classes/_divviup_dap.Task.html +++ b/classes/_divviup_dap.Task.html @@ -1,29 +1,29 @@ -Task | Documentation

Class Task<Spec, Measurement>

A client for interacting with DAP servers, as specified by +Task | Documentation

Class Task<Spec, Measurement>

A client for interacting with DAP servers, as specified by draft-ietf-ppm-dap-02. Instances of this class contain all of the necessary functionality to generate a privacy-preserving measurement report for the provided ClientVdaf, such as an implementation of Prio3, as specified by draft-irtf-cfrg-vdaf-03.

-

Type Parameters

Constructors

constructor -

Properties

protocolVersion -

Methods

fetchKeyConfiguration -generateReport -invalidateHpkeConfig -sendMeasurement -sendReport -

Constructors

constructor

Properties

Static Readonly protocolVersion

protocolVersion: string = DAP_VERSION

the protocol version for this task, usually in the form dap-{nn}

-

Methods

fetchKeyConfiguration

  • fetchKeyConfiguration(): Promise<void>

  • Fetches hpke configuration from the configured aggregators over +

Type Parameters

Constructors

constructor +

Properties

protocolVersion +

Methods

fetchKeyConfiguration +generateReport +invalidateHpkeConfig +sendMeasurement +sendReport +

Constructors

constructor

Properties

Static Readonly protocolVersion

protocolVersion: string = DAP_VERSION

the protocol version for this task, usually in the form dap-{nn}

+

Methods

fetchKeyConfiguration

  • fetchKeyConfiguration(): Promise<void>

  • Fetches hpke configuration from the configured aggregators over the network. This will make one http/https request for each aggregator (leader and helper).

    Returns Promise<void>

    Throws

    DAPError if any response is not Ok.

    -

generateReport

generateReport

  • generateReport(measurement, options?): Promise<Report>

  • Produce a Report from the supplied Measurement

    This may make network requests to fetch key configuration from the leader and helper, if needed.

    Parameters

    • measurement: Measurement

      The type of this argument will be determined by the Vdaf that this task is constructed for.

    • Optional options: ReportOptions

    Returns Promise<Report>

    Throws

    Error if there is any issue in generating the report

    -

invalidateHpkeConfig

sendMeasurement

  • sendMeasurement(measurement, options?): Promise<void>

  • A convenience function to fetch the key configuration (if +

invalidateHpkeConfig

sendMeasurement

  • sendMeasurement(measurement, options?): Promise<void>

  • A convenience function to fetch the key configuration (if needed), generate a report from the provided measurement and send that report to the leader aggregator.

    This will call Task.generateReport and @@ -32,7 +32,7 @@ retry.

    Parameters

    Returns Promise<void>

    Throws

    DAPError if any http response is not Ok or Error if there is an issue generating the report

    -

sendReport

sendReport

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap.TaskId.html b/classes/_divviup_dap.TaskId.html index 2e0f9e487..e41b5240d 100644 --- a/classes/_divviup_dap.TaskId.html +++ b/classes/_divviup_dap.TaskId.html @@ -1,6 +1,6 @@ -TaskId | Documentation

Class TaskId

Implements

Constructors

constructor -

Properties

buffer -

Methods

encode -toString -random -

Constructors

constructor

Properties

buffer

buffer: Buffer

Methods

encode

toString

Static random

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +TaskId | Documentation

Class TaskId

Implements

Constructors

constructor +

Properties

buffer +

Methods

encode +toString +random +

Constructors

constructor

Properties

buffer

buffer: Buffer

Methods

encode

toString

Static random

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Aggregator.html b/classes/_divviup_dap._internal_.Aggregator.html index ed68e8754..add289140 100644 --- a/classes/_divviup_dap._internal_.Aggregator.html +++ b/classes/_divviup_dap._internal_.Aggregator.html @@ -1,8 +1,8 @@ -Aggregator | Documentation

Class Aggregator

Constructors

constructor -

Properties

hpkeConfigList? -role -url -

Methods

seal -helper -leader -

Constructors

constructor

Properties

Optional hpkeConfigList

hpkeConfigList?: HpkeConfigList

role

role: Role

url

url: URL

Methods

seal

Static helper

Static leader

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Aggregator | Documentation

Class Aggregator

Constructors

constructor +

Properties

hpkeConfigList? +role +url +

Methods

seal +helper +leader +

Constructors

constructor

Properties

Optional hpkeConfigList

hpkeConfigList?: HpkeConfigList

role

role: Role

url

url: URL

Methods

seal

Static helper

Static leader

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.CipherSuite.html b/classes/_divviup_dap._internal_.CipherSuite.html index a92fb6d4d..8f7e59f17 100644 --- a/classes/_divviup_dap._internal_.CipherSuite.html +++ b/classes/_divviup_dap._internal_.CipherSuite.html @@ -1,4 +1,4 @@ -CipherSuite | Documentation

Class CipherSuite

The Hybrid Public Key Encryption (HPKE) ciphersuite, +CipherSuite | Documentation

Class CipherSuite

The Hybrid Public Key Encryption (HPKE) ciphersuite, which supports all of the ciphersuites defined in RFC9180.

The class consists of the @hpke/core, @@ -27,49 +27,49 @@

Example: Use a ciphersuite consisting of an external module.

import { AeadId, CipherSuite, KdfId } from "http://deno.land/x/hpke/mod.ts";
// Use an extension module.
import {
  HybridkemX25519Kyber768,
} from "https://deno.land/x/hpke/x/hybridkem-x25519-kyber768/mod.ts";

const suite = new CipherSuite({
  kem: new HybridkemX25519Kyber768(),
  kdf: KdfId.HkdfSha256,
  aead: AeadId.Aes128Gcm,
});
-

Hierarchy (view full)

Constructors

constructor -

Properties

_api -_kem -

Accessors

aead -kdf -kem -

Methods

_setup -createRecipientContext -createSenderContext -deriveKeyPair -generateKeyPair -importKey -open -seal -

Constructors

constructor

Hierarchy (view full)

Constructors

constructor +

Properties

_api +_kem +

Accessors

aead +kdf +kem +

Methods

_setup +createRecipientContext +createSenderContext +deriveKeyPair +generateKeyPair +importKey +open +seal +

Constructors

constructor

Properties

Protected _api

_api: undefined | SubtleCrypto

Protected _kem

_kem: KemInterface

Accessors

aead

  • get aead(): AeadInterface

  • Gets the AEAD context of the ciphersuite.

    -

    Returns AeadInterface

kdf

  • get kdf(): KdfInterface

  • Gets the KDF context of the ciphersuite.

    -

    Returns KdfInterface

kem

  • get kem(): KemInterface

  • Gets the KEM context of the ciphersuite.

    -

    Returns KemInterface

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

Properties

Protected _api

_api: undefined | SubtleCrypto

Protected _kem

_kem: KemInterface

Accessors

aead

  • get aead(): AeadInterface

  • Gets the AEAD context of the ciphersuite.

    +

    Returns AeadInterface

kdf

  • get kdf(): KdfInterface

  • Gets the KDF context of the ciphersuite.

    +

    Returns KdfInterface

kem

  • get kem(): KemInterface

  • Gets the KEM context of the ciphersuite.

    +

    Returns KemInterface

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

  • createRecipientContext(params): Promise<EncryptionContext>

  • Creates an encryption context for a recipient.

    If the error occurred, throws DecapError | DeserializeError | ValidationError.

    Parameters

    Returns Promise<EncryptionContext>

    A recipient encryption context.

    Throws

    DecapError, DeserializeError, ValidationError

    -

createSenderContext

createSenderContext

  • createSenderContext(params): Promise<SenderContext>

  • Creates an encryption context for a sender.

    If the error occurred, throws DecapError | ValidationError.

    Parameters

    Returns Promise<SenderContext>

    A sender encryption context.

    Throws

    EncapError, ValidationError

    -

deriveKeyPair

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair for the cipher suite in the manner defined in RFC9180 Section 7.1.3.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      A byte string of input keying material. The maximum length is 128 bytes.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Deprecated

    Use KemInterface.deriveKeyPair instead.

    Throws

    DeriveKeyPairError

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair for the cipher suite.

    +

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair for the cipher suite.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Deprecated

    Use KemInterface.generateKeyPair instead.

    Throws

    NotSupportedError

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Deprecated

Use KemInterface.generateKeyPair instead.

Throws

DeserializeError

-

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    +

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    If the error occurred, throws DecapError | DeserializeError | OpenError | ValidationError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for building a recipient encryption context.

    • ct: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • Optional aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    DecapError, DeserializeError, OpenError, ValidationError

    -

seal

seal

  • seal(params, pt, aad?): Promise<CipherSuiteSealResponse>

  • Encrypts a message to a recipient.

    If the error occurred, throws EncapError | MessageLimitReachedError | SealError | ValidationError.

    Parameters

    • params: SenderContextParams

      A set of parameters for building a sender encryption context.

    • pt: ArrayBuffer

      A plain text as bytes to be encrypted.

    • Optional aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<CipherSuiteSealResponse>

    A cipher text and an encapsulated key as bytes.

    Throws

    EncapError, MessageLimitReachedError, SealError, ValidationError

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.CipherSuiteNative.html b/classes/_divviup_dap._internal_.CipherSuiteNative.html index 153c47b97..0b92f4092 100644 --- a/classes/_divviup_dap._internal_.CipherSuiteNative.html +++ b/classes/_divviup_dap._internal_.CipherSuiteNative.html @@ -1,4 +1,4 @@ -CipherSuiteNative | Documentation

Class CipherSuiteNative

The Hybrid Public Key Encryption (HPKE) ciphersuite, +CipherSuiteNative | Documentation

Class CipherSuiteNative

The Hybrid Public Key Encryption (HPKE) ciphersuite, which is implemented using only Web Cryptography API.

This is the super class of CipherSuite and the same as @@ -35,46 +35,46 @@

Example: Use a ciphersuite which is currently not supported by Web Cryptography API.

import { Aes128Gcm, HkdfSha256, CipherSuite } from "http://deno.land/x/hpke/mod.ts";
// Use an extension module.
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke/x/dhkem-x25519/mod.ts";

const suite = new CipherSuite({
  kem: new DhkemX25519HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy (view full)

Constructors

constructor -

Properties

_api -_kem -

Accessors

aead -kdf -kem -

Methods

_setup -createRecipientContext -createSenderContext -open -seal -

Constructors

constructor

Hierarchy (view full)

Constructors

constructor +

Properties

_api +_kem +

Accessors

aead +kdf +kem +

Methods

_setup +createRecipientContext +createSenderContext +open +seal +

Constructors

constructor

Properties

Protected _api

_api: undefined | SubtleCrypto

Protected _kem

_kem: KemInterface

Accessors

aead

  • get aead(): AeadInterface

  • Gets the AEAD context of the ciphersuite.

    -

    Returns AeadInterface

kdf

  • get kdf(): KdfInterface

  • Gets the KDF context of the ciphersuite.

    -

    Returns KdfInterface

kem

  • get kem(): KemInterface

  • Gets the KEM context of the ciphersuite.

    -

    Returns KemInterface

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

Properties

Protected _api

_api: undefined | SubtleCrypto

Protected _kem

_kem: KemInterface

Accessors

aead

  • get aead(): AeadInterface

  • Gets the AEAD context of the ciphersuite.

    +

    Returns AeadInterface

kdf

  • get kdf(): KdfInterface

  • Gets the KDF context of the ciphersuite.

    +

    Returns KdfInterface

kem

  • get kem(): KemInterface

  • Gets the KEM context of the ciphersuite.

    +

    Returns KemInterface

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

  • createRecipientContext(params): Promise<EncryptionContext>

  • Creates an encryption context for a recipient.

    If the error occurred, throws DecapError | DeserializeError | ValidationError.

    Parameters

    Returns Promise<EncryptionContext>

    A recipient encryption context.

    Throws

    DecapError, DeserializeError, ValidationError

    -

createSenderContext

  • createSenderContext(params): Promise<SenderContext>

  • Creates an encryption context for a sender.

    +

createSenderContext

  • createSenderContext(params): Promise<SenderContext>

  • Creates an encryption context for a sender.

    If the error occurred, throws DecapError | ValidationError.

    Parameters

    Returns Promise<SenderContext>

    A sender encryption context.

    Throws

    EncapError, ValidationError

    -

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    +

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    If the error occurred, throws DecapError | DeserializeError | OpenError | ValidationError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for building a recipient encryption context.

    • ct: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • Optional aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    DecapError, DeserializeError, OpenError, ValidationError

    -

seal

  • seal(params, pt, aad?): Promise<CipherSuiteSealResponse>

  • Encrypts a message to a recipient.

    +

seal

  • seal(params, pt, aad?): Promise<CipherSuiteSealResponse>

  • Encrypts a message to a recipient.

    If the error occurred, throws EncapError | MessageLimitReachedError | SealError | ValidationError.

    Parameters

    • params: SenderContextParams

      A set of parameters for building a sender encryption context.

    • pt: ArrayBuffer

      A plain text as bytes to be encrypted.

    • Optional aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<CipherSuiteSealResponse>

    A cipher text and an encapsulated key as bytes.

    Throws

    EncapError, MessageLimitReachedError, SealError, ValidationError

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Extension.html b/classes/_divviup_dap._internal_.Extension.html index 615a97282..7b870e1ba 100644 --- a/classes/_divviup_dap._internal_.Extension.html +++ b/classes/_divviup_dap._internal_.Extension.html @@ -1,5 +1,5 @@ -Extension | Documentation

Class Extension

Implements

Constructors

constructor -

Properties

data -extensionType -

Methods

encode -

Constructors

constructor

Properties

data

data: Buffer

extensionType

extensionType: TBD

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Extension | Documentation

Class Extension

Implements

Constructors

constructor +

Properties

data +extensionType +

Methods

encode +

Constructors

constructor

Properties

data

data: Buffer

extensionType

extensionType: TBD

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Field.html b/classes/_divviup_dap._internal_.Field.html index 839655892..e48ad0200 100644 --- a/classes/_divviup_dap._internal_.Field.html +++ b/classes/_divviup_dap._internal_.Field.html @@ -1,21 +1,21 @@ -Field | Documentation

Class Field

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field | Documentation

Class Field

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.HpkeCiphertext.html b/classes/_divviup_dap._internal_.HpkeCiphertext.html index 1af6d7945..b1a2eb89e 100644 --- a/classes/_divviup_dap._internal_.HpkeCiphertext.html +++ b/classes/_divviup_dap._internal_.HpkeCiphertext.html @@ -1,6 +1,6 @@ -HpkeCiphertext | Documentation

Class HpkeCiphertext

Implements

Constructors

constructor -

Properties

configId -encapsulatedContext -payload -

Methods

encode -

Constructors

constructor

Properties

configId

configId: number

encapsulatedContext

encapsulatedContext: Buffer

payload

payload: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +HpkeCiphertext | Documentation

Class HpkeCiphertext

Implements

Constructors

constructor +

Properties

configId +encapsulatedContext +payload +

Methods

encode +

Constructors

constructor

Properties

configId

configId: number

encapsulatedContext

encapsulatedContext: Buffer

payload

payload: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.HpkeConfigList.html b/classes/_divviup_dap._internal_.HpkeConfigList.html index 7f953ab98..1b0ab5a6e 100644 --- a/classes/_divviup_dap._internal_.HpkeConfigList.html +++ b/classes/_divviup_dap._internal_.HpkeConfigList.html @@ -1,6 +1,6 @@ -HpkeConfigList | Documentation

Class HpkeConfigList

Implements

Constructors

constructor -

Properties

configs -

Methods

encode -selectConfig -parse -

Constructors

constructor

Properties

configs

configs: HpkeConfig[]

Methods

encode

selectConfig

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +HpkeConfigList | Documentation

Class HpkeConfigList

Implements

Constructors

constructor +

Properties

configs +

Methods

encode +selectConfig +parse +

Constructors

constructor

Properties

configs

configs: HpkeConfig[]

Methods

encode

selectConfig

Static parse

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.InputShareAad.html b/classes/_divviup_dap._internal_.InputShareAad.html index 31c606289..1320652a2 100644 --- a/classes/_divviup_dap._internal_.InputShareAad.html +++ b/classes/_divviup_dap._internal_.InputShareAad.html @@ -1,6 +1,6 @@ -InputShareAad | Documentation

Class InputShareAad

Implements

Constructors

constructor -

Properties

metadata -publicShare -taskId -

Methods

encode -

Constructors

constructor

Properties

metadata

metadata: ReportMetadata

publicShare

publicShare: Buffer

taskId

taskId: TaskId

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +InputShareAad | Documentation

Class InputShareAad

Implements

Constructors

constructor +

Properties

metadata +publicShare +taskId +

Methods

encode +

Constructors

constructor

Properties

metadata

metadata: ReportMetadata

publicShare

publicShare: Buffer

taskId

taskId: TaskId

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.NativeAlgorithm.html b/classes/_divviup_dap._internal_.NativeAlgorithm.html index 502047fbb..b67bbce85 100644 --- a/classes/_divviup_dap._internal_.NativeAlgorithm.html +++ b/classes/_divviup_dap._internal_.NativeAlgorithm.html @@ -1,4 +1,4 @@ -NativeAlgorithm | Documentation

Class NativeAlgorithm

Hierarchy (view full)

Constructors

constructor -

Properties

_api -

Methods

_setup -

Constructors

constructor

Properties

Protected _api

_api: undefined | SubtleCrypto

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +NativeAlgorithm | Documentation

Class NativeAlgorithm

Hierarchy (view full)

Constructors

constructor +

Properties

_api +

Methods

_setup +

Constructors

constructor

Properties

Protected _api

_api: undefined | SubtleCrypto

Methods

Protected _setup

  • _setup(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Parser.html b/classes/_divviup_dap._internal_.Parser.html index 64f77c77a..80a25214c 100644 --- a/classes/_divviup_dap._internal_.Parser.html +++ b/classes/_divviup_dap._internal_.Parser.html @@ -1,10 +1,10 @@ -Parser | Documentation

Class Parser

Constructors

constructor -

Properties

buffer -index -

Methods

array16 -opaque16 -slice -uint16 -uint8 -from -

Constructors

constructor

Properties

buffer

buffer: Buffer

index

index: number = 0

Methods

array16

opaque16

slice

uint16

uint8

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Parser | Documentation

Class Parser

Constructors

constructor +

Properties

buffer +index +

Methods

array16 +opaque16 +slice +uint16 +uint8 +from +

Constructors

constructor

Properties

buffer

buffer: Buffer

index

index: number = 0

Methods

array16

opaque16

slice

uint16

uint8

Static from

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.PlaintextInputShare.html b/classes/_divviup_dap._internal_.PlaintextInputShare.html index 075970be6..1f6201c30 100644 --- a/classes/_divviup_dap._internal_.PlaintextInputShare.html +++ b/classes/_divviup_dap._internal_.PlaintextInputShare.html @@ -1,5 +1,5 @@ -PlaintextInputShare | Documentation

Class PlaintextInputShare

Implements

Constructors

constructor -

Properties

extensions -payload -

Methods

encode -

Constructors

constructor

Properties

extensions

extensions: Extension[]

payload

payload: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +PlaintextInputShare | Documentation

Class PlaintextInputShare

Implements

Constructors

constructor +

Properties

extensions +payload +

Methods

encode +

Constructors

constructor

Properties

extensions

extensions: Extension[]

payload

payload: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Prio3.html b/classes/_divviup_dap._internal_.Prio3.html index fde6bf60d..74a45e612 100644 --- a/classes/_divviup_dap._internal_.Prio3.html +++ b/classes/_divviup_dap._internal_.Prio3.html @@ -1,33 +1,33 @@ -Prio3 | Documentation

Class Prio3<Measurement, AggregateResult>

Type Parameters

  • Measurement
  • AggregateResult

Hierarchy (view full)

Constructors

constructor -

Properties

flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly flp

flp: Flp<Measurement, AggregateResult>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3 | Documentation

Class Prio3<Measurement, AggregateResult>

Type Parameters

  • Measurement
  • AggregateResult

Hierarchy (view full)

Constructors

constructor +

Properties

flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly flp

flp: Flp<Measurement, AggregateResult>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Prio3Count.html b/classes/_divviup_dap._internal_.Prio3Count.html index 5bf5780ee..265ccde2c 100644 --- a/classes/_divviup_dap._internal_.Prio3Count.html +++ b/classes/_divviup_dap._internal_.Prio3Count.html @@ -1,33 +1,33 @@ -Prio3Count | Documentation

Class Prio3Count

Hierarchy (view full)

  • Prio3<boolean, number>
    • Prio3Count

Constructors

constructor -

Properties

flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

  • new Prio3Count(__namedParameters): Prio3Count

  • Parameters

    • __namedParameters: {
          shares: number;
      }
      • shares: number

    Returns Prio3Count

Properties

Readonly flp

flp: Flp<boolean, number>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, boolean, number>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: boolean[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: boolean[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, boolean, number>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number>

  • Parameters

    • aggregationParameter: null
    • measurements: boolean[]

    Returns Promise<number>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Count | Documentation

Class Prio3Count

Hierarchy (view full)

  • Prio3<boolean, number>
    • Prio3Count

Constructors

constructor +

Properties

flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

  • new Prio3Count(__namedParameters): Prio3Count

  • Parameters

    • __namedParameters: {
          shares: number;
      }
      • shares: number

    Returns Prio3Count

Properties

Readonly flp

flp: Flp<boolean, number>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, boolean, number>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: boolean[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: boolean[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, boolean, number>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number>

  • Parameters

    • aggregationParameter: null
    • measurements: boolean[]

    Returns Promise<number>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Prio3Histogram.html b/classes/_divviup_dap._internal_.Prio3Histogram.html index ccc1b262b..eea6e8dc5 100644 --- a/classes/_divviup_dap._internal_.Prio3Histogram.html +++ b/classes/_divviup_dap._internal_.Prio3Histogram.html @@ -1,35 +1,35 @@ -Prio3Histogram | Documentation

Class Prio3Histogram

Hierarchy (view full)

  • Prio3<number, number[]>
    • Prio3Histogram

Constructors

constructor -

Properties

chunkLength -flp -id -length -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number, number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number, number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number, number[]>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[]

    Returns Promise<number[]>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number[]

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number[]

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Histogram | Documentation

Class Prio3Histogram

Hierarchy (view full)

  • Prio3<number, number[]>
    • Prio3Histogram

Constructors

constructor +

Properties

chunkLength +flp +id +length +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number, number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number, number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number, number[]>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[]

    Returns Promise<number[]>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number[]

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number[]

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Prio3Sum.html b/classes/_divviup_dap._internal_.Prio3Sum.html index 6ed70e9dd..e1c343144 100644 --- a/classes/_divviup_dap._internal_.Prio3Sum.html +++ b/classes/_divviup_dap._internal_.Prio3Sum.html @@ -1,34 +1,34 @@ -Prio3Sum | Documentation

Class Prio3Sum

Hierarchy (view full)

  • Prio3<number | bigint, number | bigint>
    • Prio3Sum

Constructors

constructor -

Properties

bits -flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

  • new Prio3Sum(__namedParameters): Prio3Sum

  • Parameters

    • __namedParameters: {
          bits: number;
          shares: number;
      }
      • bits: number
      • shares: number

    Returns Prio3Sum

Properties

Readonly bits

bits: number

Readonly flp

flp: Flp<number | bigint, number | bigint>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number | bigint, number | bigint>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: (number | bigint)[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: (number | bigint)[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number | bigint, number | bigint>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number | bigint>

  • Parameters

    • aggregationParameter: null
    • measurements: (number | bigint)[]

    Returns Promise<number | bigint>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number | bigint

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number | bigint

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Sum | Documentation

Class Prio3Sum

Hierarchy (view full)

  • Prio3<number | bigint, number | bigint>
    • Prio3Sum

Constructors

constructor +

Properties

bits +flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

  • new Prio3Sum(__namedParameters): Prio3Sum

  • Parameters

    • __namedParameters: {
          bits: number;
          shares: number;
      }
      • bits: number
      • shares: number

    Returns Prio3Sum

Properties

Readonly bits

bits: number

Readonly flp

flp: Flp<number | bigint, number | bigint>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number | bigint, number | bigint>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: (number | bigint)[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: (number | bigint)[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number | bigint, number | bigint>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number | bigint>

  • Parameters

    • aggregationParameter: null
    • measurements: (number | bigint)[]

    Returns Promise<number | bigint>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number | bigint

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number | bigint

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Prio3SumVec.html b/classes/_divviup_dap._internal_.Prio3SumVec.html index bf4e2deda..290e587cb 100644 --- a/classes/_divviup_dap._internal_.Prio3SumVec.html +++ b/classes/_divviup_dap._internal_.Prio3SumVec.html @@ -1,36 +1,36 @@ -Prio3SumVec | Documentation

Class Prio3SumVec

Hierarchy (view full)

  • Prio3<number[], number[]>
    • Prio3SumVec

Constructors

constructor -

Properties

bits -chunkLength -flp -id -length -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number[], number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number[], number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[][];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[][]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number[], number[]>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[][]

    Returns Promise<number[]>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number[]

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number[]

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3SumVec | Documentation

Class Prio3SumVec

Hierarchy (view full)

  • Prio3<number[], number[]>
    • Prio3SumVec

Constructors

constructor +

Properties

bits +chunkLength +flp +id +length +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number[], number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    • outputShare: bigint[]

    Returns string[]

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

  • prepareInit(verifyKey, aggregatorId, _aggregationParameter, nonce, __namedParameters, __namedParameters): Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

  • Parameters

    Returns Promise<{
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }>

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number[], number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[][];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[][]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number[], number[]>>

shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[][]

    Returns Promise<number[]>

unshard

  • unshard(_aggregationParameter, aggregatorShares, measurementCount): number[]

  • Parameters

    • _aggregationParameter: null
    • aggregatorShares: AggregatorShare[]
    • measurementCount: number

    Returns number[]

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Report.html b/classes/_divviup_dap._internal_.Report.html index dc55f1568..348419795 100644 --- a/classes/_divviup_dap._internal_.Report.html +++ b/classes/_divviup_dap._internal_.Report.html @@ -1,7 +1,7 @@ -Report | Documentation

Class Report

Implements

Constructors

constructor -

Properties

helperCiphertext -leaderCiphertext -metadata -publicShare -

Methods

encode -

Constructors

constructor

Properties

helperCiphertext

helperCiphertext: HpkeCiphertext

leaderCiphertext

leaderCiphertext: HpkeCiphertext

metadata

metadata: ReportMetadata

publicShare

publicShare: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Report | Documentation

Class Report

Implements

Constructors

constructor +

Properties

helperCiphertext +leaderCiphertext +metadata +publicShare +

Methods

encode +

Constructors

constructor

Properties

helperCiphertext

helperCiphertext: HpkeCiphertext

leaderCiphertext

leaderCiphertext: HpkeCiphertext

metadata

metadata: ReportMetadata

publicShare

publicShare: Buffer

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.ReportId.html b/classes/_divviup_dap._internal_.ReportId.html index c0ae1af8a..0aca2d49f 100644 --- a/classes/_divviup_dap._internal_.ReportId.html +++ b/classes/_divviup_dap._internal_.ReportId.html @@ -1,5 +1,5 @@ -ReportId | Documentation

Class ReportId

Implements

Constructors

constructor -

Properties

bytes -

Methods

encode -random -

Constructors

constructor

Properties

bytes

bytes: Buffer

Methods

encode

Static random

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ReportId | Documentation

Class ReportId

Implements

Constructors

constructor +

Properties

bytes +

Methods

encode +random +

Constructors

constructor

Properties

bytes

bytes: Buffer

Methods

encode

Static random

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.ReportMetadata.html b/classes/_divviup_dap._internal_.ReportMetadata.html index a8c4a1af2..f89113dba 100644 --- a/classes/_divviup_dap._internal_.ReportMetadata.html +++ b/classes/_divviup_dap._internal_.ReportMetadata.html @@ -1,5 +1,5 @@ -ReportMetadata | Documentation

Class ReportMetadata

Implements

Constructors

constructor -

Properties

reportId -time -

Methods

encode -

Constructors

constructor

Properties

reportId

reportId: ReportId

time

time: number

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ReportMetadata | Documentation

Class ReportMetadata

Implements

Constructors

constructor +

Properties

reportId +time +

Methods

encode +

Constructors

constructor

Properties

reportId

reportId: ReportId

time

time: number

Methods

encode

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Vdaf.html b/classes/_divviup_dap._internal_.Vdaf.html index f32d7c39f..4c122ace9 100644 --- a/classes/_divviup_dap._internal_.Vdaf.html +++ b/classes/_divviup_dap._internal_.Vdaf.html @@ -1,31 +1,31 @@ -Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Hierarchy (view full)

Constructors

constructor -

Properties

id -nonceSize -randSize -rounds -shares -verifyKeySize -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

  • domainSeparationTag(usage): Buffer

  • Parameters

    • usage: number

    Returns Buffer

Abstract encodeAggregationParameter

  • encodeAggregationParameter(aggregationParameter): Buffer

  • Parameters

    Returns Buffer

Abstract encodeAggregatorShare

  • encodeAggregatorShare(aggregatorShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodeInputShare

  • encodeInputShare(inputShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationMessage

  • encodePreparationMessage(preparationMessage): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationShare

  • encodePreparationShare(preparationShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePublicShare

  • encodePublicShare(publicShare): Buffer

  • Parameters

    Returns Buffer

encodeTestVectorAggregatorShare

  • encodeTestVectorAggregatorShare(aggregatorShare): string

  • Parameters

    Returns string

encodeTestVectorInputShare

  • encodeTestVectorInputShare(inputShare): string

  • Parameters

    Returns string

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    Returns string[]

encodeTestVectorPreparationMessage

  • encodeTestVectorPreparationMessage(preparationMessage): string

  • Parameters

    Returns string

encodeTestVectorPreparationShare

  • encodeTestVectorPreparationShare(preparationShare): string

  • Parameters

    Returns string

encodeTestVectorPublicShare

  • encodeTestVectorPublicShare(publicShare): string

  • Parameters

    Returns string

Abstract isValid

  • isValid(aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    Returns boolean

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Hierarchy (view full)

Constructors

constructor +

Properties

id +nonceSize +randSize +rounds +shares +verifyKeySize +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

  • domainSeparationTag(usage): Buffer

  • Parameters

    • usage: number

    Returns Buffer

Abstract encodeAggregationParameter

  • encodeAggregationParameter(aggregationParameter): Buffer

  • Parameters

    Returns Buffer

Abstract encodeAggregatorShare

  • encodeAggregatorShare(aggregatorShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodeInputShare

  • encodeInputShare(inputShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationMessage

  • encodePreparationMessage(preparationMessage): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationShare

  • encodePreparationShare(preparationShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePublicShare

  • encodePublicShare(publicShare): Buffer

  • Parameters

    Returns Buffer

encodeTestVectorAggregatorShare

  • encodeTestVectorAggregatorShare(aggregatorShare): string

  • Parameters

    Returns string

encodeTestVectorInputShare

  • encodeTestVectorInputShare(inputShare): string

  • Parameters

    Returns string

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    Returns string[]

encodeTestVectorPreparationMessage

  • encodeTestVectorPreparationMessage(preparationMessage): string

  • Parameters

    Returns string

encodeTestVectorPreparationShare

  • encodeTestVectorPreparationShare(preparationShare): string

  • Parameters

    Returns string

encodeTestVectorPublicShare

  • encodeTestVectorPublicShare(publicShare): string

  • Parameters

    Returns string

Abstract isValid

  • isValid(aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    Returns boolean

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_dap._internal_.Xof.html b/classes/_divviup_dap._internal_.Xof.html index d3ed628bd..cc058d1b7 100644 --- a/classes/_divviup_dap._internal_.Xof.html +++ b/classes/_divviup_dap._internal_.Xof.html @@ -1,6 +1,6 @@ -Xof | Documentation

Class XofAbstract

Constructors

constructor -

Methods

next -nextVec -deriveSeed -expandIntoVec -

Constructors

constructor

Methods

Abstract next

  • next(_length): Promise<Uint8Array>

  • Parameters

    • _length: number

    Returns Promise<Uint8Array>

nextVec

  • nextVec(field, length): Promise<bigint[]>

  • Parameters

    • field: Field
    • length: number

    Returns Promise<bigint[]>

Static deriveSeed

  • deriveSeed(this, seed, dst, binder): Promise<Uint8Array>

  • Parameters

    Returns Promise<Uint8Array>

Static expandIntoVec

  • expandIntoVec(this, field, seed, dst, binder, length): Promise<bigint[]>

  • Parameters

    • this: XofConstructor
    • field: Field
    • seed: Uint8Array
    • dst: Uint8Array
    • binder: Uint8Array
    • length: number

    Returns Promise<bigint[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Xof | Documentation

Class XofAbstract

Constructors

constructor +

Methods

next +nextVec +deriveSeed +expandIntoVec +

Constructors

constructor

Methods

Abstract next

  • next(_length): Promise<Uint8Array>

  • Parameters

    • _length: number

    Returns Promise<Uint8Array>

nextVec

  • nextVec(field, length): Promise<bigint[]>

  • Parameters

    • field: Field
    • length: number

    Returns Promise<bigint[]>

Static deriveSeed

  • deriveSeed(this, seed, dst, binder): Promise<Uint8Array>

  • Parameters

    Returns Promise<Uint8Array>

Static expandIntoVec

  • expandIntoVec(this, field, seed, dst, binder, length): Promise<bigint[]>

  • Parameters

    • this: XofConstructor
    • field: Field
    • seed: Uint8Array
    • dst: Uint8Array
    • binder: Uint8Array
    • length: number

    Returns Promise<bigint[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field.Field.html b/classes/_divviup_field.Field.html index 1e8c63231..46003df08 100644 --- a/classes/_divviup_field.Field.html +++ b/classes/_divviup_field.Field.html @@ -1,21 +1,21 @@ -Field | Documentation

Class Field

Hierarchy (view full)

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field | Documentation

Class Field

Hierarchy (view full)

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field.Field128.html b/classes/_divviup_field.Field128.html index 66fbd368b..3e101ced7 100644 --- a/classes/_divviup_field.Field128.html +++ b/classes/_divviup_field.Field128.html @@ -1,21 +1,21 @@ -Field128 | Documentation

Class Field128

Hierarchy (view full)

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field128 | Documentation

Class Field128

Hierarchy (view full)

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field.Field64.html b/classes/_divviup_field.Field64.html index 258913a27..2738e8626 100644 --- a/classes/_divviup_field.Field64.html +++ b/classes/_divviup_field.Field64.html @@ -1,21 +1,21 @@ -Field64 | Documentation

Class Field64

Hierarchy (view full)

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field64 | Documentation

Class Field64

Hierarchy (view full)

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field.Field96.html b/classes/_divviup_field.Field96.html index 040d0d8e8..7669f3d75 100644 --- a/classes/_divviup_field.Field96.html +++ b/classes/_divviup_field.Field96.html @@ -1,21 +1,21 @@ -Field96 | Documentation

Class Field96

Hierarchy (view full)

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field96 | Documentation

Class Field96

Hierarchy (view full)

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field.Vector.html b/classes/_divviup_field.Vector.html index 07b8ce2ad..a186cb1ce 100644 --- a/classes/_divviup_field.Vector.html +++ b/classes/_divviup_field.Vector.html @@ -1,6 +1,6 @@ -Vector | Documentation

Class Vector

Constructors

constructor -

Properties

elementSize -values -

Accessors

length -

Methods

toValues -

Constructors

constructor

  • new Vector(values, elementSize): Vector

  • Parameters

    • values: bigint[]
    • elementSize: number

    Returns Vector

Properties

Readonly elementSize

elementSize: number

Readonly values

values: bigint[]

Accessors

length

Methods

toValues

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Vector | Documentation

Class Vector

Constructors

constructor +

Properties

elementSize +values +

Accessors

length +

Methods

toValues +

Constructors

constructor

  • new Vector(values, elementSize): Vector

  • Parameters

    • values: bigint[]
    • elementSize: number

    Returns Vector

Properties

Readonly elementSize

elementSize: number

Readonly values

values: bigint[]

Accessors

length

Methods

toValues

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_field._internal_.PrimeField.html b/classes/_divviup_field._internal_.PrimeField.html index a3225ae04..df9231553 100644 --- a/classes/_divviup_field._internal_.PrimeField.html +++ b/classes/_divviup_field._internal_.PrimeField.html @@ -1,30 +1,30 @@ -PrimeField | Documentation

Class PrimeField

Constructors

constructor -

Properties

elementSize -modulus -

Methods

add -addPolys -addVectorElements -combineVectors -div -divPolys -divVectorElements -evalPolyAt -evalPolyAtRoots -exp -expVectorElements -getPowerSeries -getRootOfUnity -interpolate -interpolateRoots -inv -invVectorElements -mod -mul -mulPolys -mulVectorElements -newVectorFrom -rand -sub -subPolys -subVectorElements -

Constructors

constructor

Properties

Readonly elementSize

elementSize: number

Readonly modulus

modulus: bigint

Methods

add

  • add(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

addPolys

addVectorElements

combineVectors

div

  • div(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

divPolys

divVectorElements

evalPolyAt

evalPolyAtRoots

exp

  • exp(base, exponent): bigint

  • Parameters

    • base: bigint
    • exponent: bigint

    Returns bigint

expVectorElements

getPowerSeries

getRootOfUnity

  • getRootOfUnity(order): bigint

  • Parameters

    • order: number

    Returns bigint

interpolate

interpolateRoots

inv

invVectorElements

mod

  • mod(value): bigint

  • Parameters

    • value: bigint

    Returns bigint

mul

  • mul(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

mulPolys

mulVectorElements

newVectorFrom

rand

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

subPolys

subVectorElements

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +PrimeField | Documentation

Class PrimeField

Constructors

constructor +

Properties

elementSize +modulus +

Methods

add +addPolys +addVectorElements +combineVectors +div +divPolys +divVectorElements +evalPolyAt +evalPolyAtRoots +exp +expVectorElements +getPowerSeries +getRootOfUnity +interpolate +interpolateRoots +inv +invVectorElements +mod +mul +mulPolys +mulVectorElements +newVectorFrom +rand +sub +subPolys +subVectorElements +

Constructors

constructor

Properties

Readonly elementSize

elementSize: number

Readonly modulus

modulus: bigint

Methods

add

  • add(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

addPolys

addVectorElements

combineVectors

div

  • div(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

divPolys

divVectorElements

evalPolyAt

evalPolyAtRoots

exp

  • exp(base, exponent): bigint

  • Parameters

    • base: bigint
    • exponent: bigint

    Returns bigint

expVectorElements

getPowerSeries

getRootOfUnity

  • getRootOfUnity(order): bigint

  • Parameters

    • order: number

    Returns bigint

interpolate

interpolateRoots

inv

invVectorElements

mod

  • mod(value): bigint

  • Parameters

    • value: bigint

    Returns bigint

mul

  • mul(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

mulPolys

mulVectorElements

newVectorFrom

rand

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

subPolys

subVectorElements

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3.Prio3.html b/classes/_divviup_prio3.Prio3.html index 211acbccd..1a0a9bd9f 100644 --- a/classes/_divviup_prio3.Prio3.html +++ b/classes/_divviup_prio3.Prio3.html @@ -1,33 +1,33 @@ -Prio3 | Documentation

Class Prio3<Measurement, AggregateResult>

Type Parameters

  • Measurement
  • AggregateResult

Hierarchy (view full)

Constructors

constructor -

Properties

flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly flp

flp: Flp<Measurement, AggregateResult>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3 | Documentation

Class Prio3<Measurement, AggregateResult>

Type Parameters

  • Measurement
  • AggregateResult

Hierarchy (view full)

Constructors

constructor +

Properties

flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly flp

flp: Flp<Measurement, AggregateResult>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3.Prio3Count.html b/classes/_divviup_prio3.Prio3Count.html index db992d975..1e2569932 100644 --- a/classes/_divviup_prio3.Prio3Count.html +++ b/classes/_divviup_prio3.Prio3Count.html @@ -1,33 +1,33 @@ -Prio3Count | Documentation

Class Prio3Count

Hierarchy (view full)

  • Prio3<boolean, number>
    • Prio3Count

Constructors

constructor -

Properties

flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly flp

flp: Flp<boolean, number>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, boolean, number>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: boolean[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: boolean[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, boolean, number>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number>

  • Parameters

    • aggregationParameter: null
    • measurements: boolean[]

    Returns Promise<number>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Count | Documentation

Class Prio3Count

Hierarchy (view full)

  • Prio3<boolean, number>
    • Prio3Count

Constructors

constructor +

Properties

flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly flp

flp: Flp<boolean, number>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, boolean, number>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: boolean[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: boolean[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, boolean, number>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number>

  • Parameters

    • aggregationParameter: null
    • measurements: boolean[]

    Returns Promise<number>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3.Prio3Histogram.html b/classes/_divviup_prio3.Prio3Histogram.html index 3e16f1031..962252e26 100644 --- a/classes/_divviup_prio3.Prio3Histogram.html +++ b/classes/_divviup_prio3.Prio3Histogram.html @@ -1,35 +1,35 @@ -Prio3Histogram | Documentation

Class Prio3Histogram

Hierarchy (view full)

  • Prio3<number, number[]>
    • Prio3Histogram

Constructors

constructor -

Properties

chunkLength -flp -id -length -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number, number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number, number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number, number[]>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[]

    Returns Promise<number[]>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Histogram | Documentation

Class Prio3Histogram

Hierarchy (view full)

  • Prio3<number, number[]>
    • Prio3Histogram

Constructors

constructor +

Properties

chunkLength +flp +id +length +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number, number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number, number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number, number[]>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[]

    Returns Promise<number[]>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3.Prio3Sum.html b/classes/_divviup_prio3.Prio3Sum.html index a3651fbf8..c4bb889df 100644 --- a/classes/_divviup_prio3.Prio3Sum.html +++ b/classes/_divviup_prio3.Prio3Sum.html @@ -1,34 +1,34 @@ -Prio3Sum | Documentation

Class Prio3Sum

Hierarchy (view full)

  • Prio3<number | bigint, number | bigint>
    • Prio3Sum

Constructors

constructor -

Properties

bits -flp -id -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly flp

flp: Flp<number | bigint, number | bigint>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number | bigint, number | bigint>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: (number | bigint)[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: (number | bigint)[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number | bigint, number | bigint>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number | bigint>

  • Parameters

    • aggregationParameter: null
    • measurements: (number | bigint)[]

    Returns Promise<number | bigint>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3Sum | Documentation

Class Prio3Sum

Hierarchy (view full)

  • Prio3<number | bigint, number | bigint>
    • Prio3Sum

Constructors

constructor +

Properties

bits +flp +id +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly flp

flp: Flp<number | bigint, number | bigint>

Readonly id

id: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number | bigint, number | bigint>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: (number | bigint)[];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: (number | bigint)[]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number | bigint, number | bigint>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number | bigint>

  • Parameters

    • aggregationParameter: null
    • measurements: (number | bigint)[]

    Returns Promise<number | bigint>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3.Prio3SumVec.html b/classes/_divviup_prio3.Prio3SumVec.html index 3b6b9de67..e1877853f 100644 --- a/classes/_divviup_prio3.Prio3SumVec.html +++ b/classes/_divviup_prio3.Prio3SumVec.html @@ -1,36 +1,36 @@ -Prio3SumVec | Documentation

Class Prio3SumVec

Hierarchy (view full)

  • Prio3<number[], number[]>
    • Prio3SumVec

Constructors

constructor -

Properties

bits -chunkLength -flp -id -length -nonceSize -randSize -rounds -shares -verifyKeySize -xof -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number[], number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number[], number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[][];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[][]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number[], number[]>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[][]

    Returns Promise<number[]>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Prio3SumVec | Documentation

Class Prio3SumVec

Hierarchy (view full)

  • Prio3<number[], number[]>
    • Prio3SumVec

Constructors

constructor +

Properties

bits +chunkLength +flp +id +length +nonceSize +randSize +rounds +shares +verifyKeySize +xof +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Readonly bits

bits: number

Readonly chunkLength

chunkLength: number

Readonly flp

flp: Flp<number[], number[]>

Readonly id

id: number

Readonly length

length: number

Readonly nonceSize

nonceSize: 16 = 16

Readonly randSize

randSize: number

Readonly rounds

rounds: 1 = 1

Readonly shares

shares: number

Readonly verifyKeySize

verifyKeySize: number

Readonly xof

xof: XofConstructor

Methods

aggregate

domainSeparationTag

encodeAggregationParameter

encodeAggregatorShare

encodeInputShare

encodePreparationMessage

encodePreparationShare

encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

isValid

  • isValid(_aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    • _aggregationParameter: null
    • previousAggregationParameters: null[]

    Returns boolean

prepareInit

prepareNext

run

  • run(__namedParameters): Promise<TestVector<null, number[], number[]>>

  • Parameters

    • __namedParameters: {
          aggregationParameter: null;
          measurements: number[][];
          nonces?: Buffer[];
          rands?: Buffer[];
          verifyKey?: Buffer;
      }
      • aggregationParameter: null
      • measurements: number[][]
      • Optional nonces?: Buffer[]
      • Optional rands?: Buffer[]
      • Optional verifyKey?: Buffer

    Returns Promise<TestVector<null, number[], number[]>>

shard

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

  • test(aggregationParameter, measurements): Promise<number[]>

  • Parameters

    • aggregationParameter: null
    • measurements: number[][]

    Returns Promise<number[]>

unshard

unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3._internal_.Field.html b/classes/_divviup_prio3._internal_.Field.html index b2037dd6f..8288bb623 100644 --- a/classes/_divviup_prio3._internal_.Field.html +++ b/classes/_divviup_prio3._internal_.Field.html @@ -1,21 +1,21 @@ -Field | Documentation

Class Field

Constructors

constructor -

Properties

encodedSize -genOrder -generator -modulus -

Methods

add -additiveSecretShare -decode -encode -evalPoly -exp -fillRandom -interpolate -mul -mulPolys -randomElement -sub -sum -vecAdd -vecSub -

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Field | Documentation

Class Field

Constructors

constructor +

Properties

encodedSize +genOrder +generator +modulus +

Methods

add +additiveSecretShare +decode +encode +evalPoly +exp +fillRandom +interpolate +mul +mulPolys +randomElement +sub +sum +vecAdd +vecSub +

Constructors

constructor

Properties

Readonly encodedSize

encodedSize: number

Readonly genOrder

genOrder: bigint

Readonly generator

generator: bigint

Readonly modulus

modulus: bigint

Methods

add

  • add(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

additiveSecretShare

  • additiveSecretShare(input, numShares): bigint[][]

  • Parameters

    • input: bigint[]
    • numShares: number

    Returns bigint[][]

decode

  • decode(encoded): bigint[]

  • Parameters

    • encoded: Uint8Array

    Returns bigint[]

encode

  • encode(data): Uint8Array

  • Parameters

    • data: bigint[]

    Returns Uint8Array

evalPoly

  • evalPoly(p, x): bigint

  • Parameters

    • p: bigint[]
    • x: bigint

    Returns bigint

exp

  • exp(b, exp): bigint

  • Parameters

    • b: bigint
    • exp: bigint

    Returns bigint

fillRandom

  • fillRandom(length): bigint[]

  • Parameters

    • length: number

    Returns bigint[]

interpolate

  • interpolate(rootsOfUnity, ys): bigint[]

  • Parameters

    • rootsOfUnity: bigint[]
    • ys: bigint[]

    Returns bigint[]

mul

  • mul(a, b): bigint

  • Parameters

    • a: bigint
    • b: bigint

    Returns bigint

mulPolys

  • mulPolys(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

randomElement

  • randomElement(): bigint

  • Returns bigint

sub

  • sub(x, y): bigint

  • Parameters

    • x: bigint
    • y: bigint

    Returns bigint

sum

  • sum<T>(arr, mapper): bigint

  • Type Parameters

    • T

    Parameters

    • arr: T[]
    • mapper: ((value, index) => bigint)
        • (value, index): bigint

        • Parameters

          • value: T
          • index: number

          Returns bigint

    Returns bigint

vecAdd

  • vecAdd(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

vecSub

  • vecSub(a, b): bigint[]

  • Parameters

    • a: bigint[]
    • b: bigint[]

    Returns bigint[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3._internal_.Vdaf.html b/classes/_divviup_prio3._internal_.Vdaf.html index 372a98a7d..a789c584f 100644 --- a/classes/_divviup_prio3._internal_.Vdaf.html +++ b/classes/_divviup_prio3._internal_.Vdaf.html @@ -1,31 +1,31 @@ -Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Hierarchy (view full)

Constructors

constructor -

Properties

id -nonceSize -randSize -rounds -shares -verifyKeySize -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

  • domainSeparationTag(usage): Buffer

  • Parameters

    • usage: number

    Returns Buffer

Abstract encodeAggregationParameter

  • encodeAggregationParameter(aggregationParameter): Buffer

  • Parameters

    Returns Buffer

Abstract encodeAggregatorShare

  • encodeAggregatorShare(aggregatorShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodeInputShare

  • encodeInputShare(inputShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationMessage

  • encodePreparationMessage(preparationMessage): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationShare

  • encodePreparationShare(preparationShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePublicShare

  • encodePublicShare(publicShare): Buffer

  • Parameters

    Returns Buffer

encodeTestVectorAggregatorShare

  • encodeTestVectorAggregatorShare(aggregatorShare): string

  • Parameters

    Returns string

encodeTestVectorInputShare

  • encodeTestVectorInputShare(inputShare): string

  • Parameters

    Returns string

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    Returns string[]

encodeTestVectorPreparationMessage

  • encodeTestVectorPreparationMessage(preparationMessage): string

  • Parameters

    Returns string

encodeTestVectorPreparationShare

  • encodeTestVectorPreparationShare(preparationShare): string

  • Parameters

    Returns string

encodeTestVectorPublicShare

  • encodeTestVectorPublicShare(publicShare): string

  • Parameters

    Returns string

Abstract isValid

  • isValid(aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    Returns boolean

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Hierarchy (view full)

Constructors

constructor +

Properties

id +nonceSize +randSize +rounds +shares +verifyKeySize +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

  • domainSeparationTag(usage): Buffer

  • Parameters

    • usage: number

    Returns Buffer

Abstract encodeAggregationParameter

  • encodeAggregationParameter(aggregationParameter): Buffer

  • Parameters

    Returns Buffer

Abstract encodeAggregatorShare

  • encodeAggregatorShare(aggregatorShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodeInputShare

  • encodeInputShare(inputShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationMessage

  • encodePreparationMessage(preparationMessage): Buffer

  • Parameters

    Returns Buffer

Abstract encodePreparationShare

  • encodePreparationShare(preparationShare): Buffer

  • Parameters

    Returns Buffer

Abstract encodePublicShare

  • encodePublicShare(publicShare): Buffer

  • Parameters

    Returns Buffer

encodeTestVectorAggregatorShare

  • encodeTestVectorAggregatorShare(aggregatorShare): string

  • Parameters

    Returns string

encodeTestVectorInputShare

  • encodeTestVectorInputShare(inputShare): string

  • Parameters

    Returns string

encodeTestVectorOutputShare

  • encodeTestVectorOutputShare(outputShare): string[]

  • Parameters

    Returns string[]

encodeTestVectorPreparationMessage

  • encodeTestVectorPreparationMessage(preparationMessage): string

  • Parameters

    Returns string

encodeTestVectorPreparationShare

  • encodeTestVectorPreparationShare(preparationShare): string

  • Parameters

    Returns string

encodeTestVectorPublicShare

  • encodeTestVectorPublicShare(publicShare): string

  • Parameters

    Returns string

Abstract isValid

  • isValid(aggregationParameter, previousAggregationParameters): boolean

  • Parameters

    Returns boolean

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

  • shard(measurement, nonce, rand): Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

  • Parameters

    Returns Promise<{
        inputShares: InputShare[];
        publicShare: PublicShare;
    }>

shardEncoded

  • shardEncoded(measurement, nonce, rand): Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

  • Parameters

    Returns Promise<{
        inputShares: Buffer[];
        publicShare: Buffer;
    }>

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_prio3._internal_.Xof.html b/classes/_divviup_prio3._internal_.Xof.html index 72896f36f..24e77649c 100644 --- a/classes/_divviup_prio3._internal_.Xof.html +++ b/classes/_divviup_prio3._internal_.Xof.html @@ -1,6 +1,6 @@ -Xof | Documentation

Class XofAbstract

Constructors

constructor -

Methods

next -nextVec -deriveSeed -expandIntoVec -

Constructors

constructor

Methods

Abstract next

  • next(_length): Promise<Uint8Array>

  • Parameters

    • _length: number

    Returns Promise<Uint8Array>

nextVec

  • nextVec(field, length): Promise<bigint[]>

  • Parameters

    • field: Field
    • length: number

    Returns Promise<bigint[]>

Static deriveSeed

  • deriveSeed(this, seed, dst, binder): Promise<Uint8Array>

  • Parameters

    Returns Promise<Uint8Array>

Static expandIntoVec

  • expandIntoVec(this, field, seed, dst, binder, length): Promise<bigint[]>

  • Parameters

    • this: XofConstructor
    • field: Field
    • seed: Uint8Array
    • dst: Uint8Array
    • binder: Uint8Array
    • length: number

    Returns Promise<bigint[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Xof | Documentation

Class XofAbstract

Constructors

constructor +

Methods

next +nextVec +deriveSeed +expandIntoVec +

Constructors

constructor

Methods

Abstract next

  • next(_length): Promise<Uint8Array>

  • Parameters

    • _length: number

    Returns Promise<Uint8Array>

nextVec

  • nextVec(field, length): Promise<bigint[]>

  • Parameters

    • field: Field
    • length: number

    Returns Promise<bigint[]>

Static deriveSeed

  • deriveSeed(this, seed, dst, binder): Promise<Uint8Array>

  • Parameters

    Returns Promise<Uint8Array>

Static expandIntoVec

  • expandIntoVec(this, field, seed, dst, binder, length): Promise<bigint[]>

  • Parameters

    • this: XofConstructor
    • field: Field
    • seed: Uint8Array
    • dst: Uint8Array
    • binder: Uint8Array
    • length: number

    Returns Promise<bigint[]>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_divviup_vdaf.Vdaf.html b/classes/_divviup_vdaf.Vdaf.html index e280c85ea..f31fddbb1 100644 --- a/classes/_divviup_vdaf.Vdaf.html +++ b/classes/_divviup_vdaf.Vdaf.html @@ -1,31 +1,31 @@ -Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Constructors

constructor -

Properties

id -nonceSize -randSize -rounds -shares -verifyKeySize -

Methods

aggregate -domainSeparationTag -encodeAggregationParameter -encodeAggregatorShare -encodeInputShare -encodePreparationMessage -encodePreparationShare -encodePublicShare -encodeTestVectorAggregatorShare -encodeTestVectorInputShare -encodeTestVectorOutputShare -encodeTestVectorPreparationMessage -encodeTestVectorPreparationShare -encodeTestVectorPublicShare -isValid -prepareInit -prepareNext -run -shard -shardEncoded -test -unshard -unshardPreparationShares -

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

Abstract encodeAggregationParameter

Abstract encodeAggregatorShare

Abstract encodeInputShare

Abstract encodePreparationMessage

Abstract encodePreparationShare

Abstract encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

Abstract isValid

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

shardEncoded

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Vdaf | Documentation

Class Vdaf<Measurement, AggregationParameter, PublicShare, InputShare, OutputShare, AggregatorShare, AggregateResult, PreparationState, PreparationShare, PreparationMessage>Abstract

Type Parameters

  • Measurement
  • AggregationParameter
  • PublicShare
  • InputShare
  • OutputShare
  • AggregatorShare
  • AggregateResult
  • PreparationState
  • PreparationShare
  • PreparationMessage

Constructors

constructor +

Properties

id +nonceSize +randSize +rounds +shares +verifyKeySize +

Methods

aggregate +domainSeparationTag +encodeAggregationParameter +encodeAggregatorShare +encodeInputShare +encodePreparationMessage +encodePreparationShare +encodePublicShare +encodeTestVectorAggregatorShare +encodeTestVectorInputShare +encodeTestVectorOutputShare +encodeTestVectorPreparationMessage +encodeTestVectorPreparationShare +encodeTestVectorPublicShare +isValid +prepareInit +prepareNext +run +shard +shardEncoded +test +unshard +unshardPreparationShares +

Constructors

constructor

Properties

Abstract id

id: number

Abstract nonceSize

nonceSize: number

Abstract randSize

randSize: number

Abstract rounds

rounds: number

Abstract shares

shares: number

Abstract verifyKeySize

verifyKeySize: number

Methods

Abstract aggregate

domainSeparationTag

Abstract encodeAggregationParameter

Abstract encodeAggregatorShare

Abstract encodeInputShare

Abstract encodePreparationMessage

Abstract encodePreparationShare

Abstract encodePublicShare

encodeTestVectorAggregatorShare

encodeTestVectorInputShare

encodeTestVectorOutputShare

encodeTestVectorPreparationMessage

encodeTestVectorPreparationShare

encodeTestVectorPublicShare

Abstract isValid

Abstract prepareInit

Abstract prepareNext

run

Abstract shard

shardEncoded

test

Abstract unshard

Abstract unshardPreparationShares

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_divviup_dap._internal_.Role.html b/enums/_divviup_dap._internal_.Role.html index 81b7ca003..2f27928e0 100644 --- a/enums/_divviup_dap._internal_.Role.html +++ b/enums/_divviup_dap._internal_.Role.html @@ -1,5 +1,5 @@ -Role | Documentation

Enumeration Role

Enumeration Members

Client -Collector -Helper -Leader -

Enumeration Members

Client

Client: 1

Collector

Collector: 0

Helper

Helper: 3

Leader

Leader: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Role | Documentation

Enumeration Role

Enumeration Members

Client +Collector +Helper +Leader +

Enumeration Members

Client

Client: 1

Collector

Collector: 0

Helper

Helper: 3

Leader

Leader: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_divviup_prio3._internal_.Usage.html b/enums/_divviup_prio3._internal_.Usage.html index 00dea01d0..f2db56025 100644 --- a/enums/_divviup_prio3._internal_.Usage.html +++ b/enums/_divviup_prio3._internal_.Usage.html @@ -1,8 +1,8 @@ -Usage | Documentation

Enumeration Usage

Enumeration Members

JointRandPart -JointRandSeed -JointRandomness -MeasurementShare -ProofShare -ProveRandomness -QueryRandomness -

Enumeration Members

JointRandPart

JointRandPart: 7

JointRandSeed

JointRandSeed: 6

JointRandomness

JointRandomness: 3

MeasurementShare

MeasurementShare: 1

ProofShare

ProofShare: 2

ProveRandomness

ProveRandomness: 4

QueryRandomness

QueryRandomness: 5

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Usage | Documentation

Enumeration Usage

Enumeration Members

JointRandPart +JointRandSeed +JointRandomness +MeasurementShare +ProofShare +ProveRandomness +QueryRandomness +

Enumeration Members

JointRandPart

JointRandPart: 7

JointRandSeed

JointRandSeed: 6

JointRandomness

JointRandomness: 3

MeasurementShare

MeasurementShare: 1

ProofShare

ProofShare: 2

ProveRandomness

ProveRandomness: 4

QueryRandomness

QueryRandomness: 5

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_divviup_vdaf.formatDomainSeparationTag.html b/functions/_divviup_vdaf.formatDomainSeparationTag.html index 6f58bb3ab..268250033 100644 --- a/functions/_divviup_vdaf.formatDomainSeparationTag.html +++ b/functions/_divviup_vdaf.formatDomainSeparationTag.html @@ -1 +1 @@ -formatDomainSeparationTag | Documentation

Function formatDomainSeparationTag

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +formatDomainSeparationTag | Documentation

Function formatDomainSeparationTag

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_divviup_vdaf.runVdaf.html b/functions/_divviup_vdaf.runVdaf.html index ab6e71923..9ed1a007d 100644 --- a/functions/_divviup_vdaf.runVdaf.html +++ b/functions/_divviup_vdaf.runVdaf.html @@ -1 +1 @@ -runVdaf | Documentation

Function runVdaf

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +runVdaf | Documentation

Function runVdaf

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index cfafbe824..5ac7a3487 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -Documentation

Documentation

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Documentation

Documentation

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 4bff47f17..d1b93068e 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -Documentation

Documentation

DivviUp Typescript Client

Coverage Status +Documentation

Documentation

DivviUp Typescript Client

Coverage Status CI

docs for main

Protocol Versions and Release Branches

The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,4 +104,4 @@

UNPKG

<script
    src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
    crossorigin="anonymous"
    integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
</script>
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap.ReportOptions.html b/interfaces/_divviup_dap.ReportOptions.html index bef8d0db7..b9924b09f 100644 --- a/interfaces/_divviup_dap.ReportOptions.html +++ b/interfaces/_divviup_dap.ReportOptions.html @@ -1,2 +1,2 @@ -ReportOptions | Documentation

Interface ReportOptions

interface ReportOptions {
    timestamp?: Date;
}

Properties

timestamp? -

Properties

Optional timestamp

timestamp?: Date

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ReportOptions | Documentation

Interface ReportOptions

interface ReportOptions {
    timestamp?: Date;
}

Properties

timestamp? +

Properties

Optional timestamp

timestamp?: Date

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AeadEncryptionContext.html b/interfaces/_divviup_dap._internal_.AeadEncryptionContext.html index 88c70d4c3..6d4365e9c 100644 --- a/interfaces/_divviup_dap._internal_.AeadEncryptionContext.html +++ b/interfaces/_divviup_dap._internal_.AeadEncryptionContext.html @@ -1,14 +1,14 @@ -AeadEncryptionContext | Documentation

Interface AeadEncryptionContext

The AEAD encryption context interface.

-
interface AeadEncryptionContext {
    open(iv, data, aad): Promise<ArrayBuffer>;
    seal(iv, data, aad): Promise<ArrayBuffer>;
}

Methods

open -seal -

Methods

open

  • open(iv, data, aad): Promise<ArrayBuffer>

  • Decrypts data with an initialization vector and additional authenticated data.

    +AeadEncryptionContext | Documentation

    Interface AeadEncryptionContext

    The AEAD encryption context interface.

    +
    interface AeadEncryptionContext {
        open(iv, data, aad): Promise<ArrayBuffer>;
        seal(iv, data, aad): Promise<ArrayBuffer>;
    }

    Methods

    open +seal +

    Methods

    open

    • open(iv, data, aad): Promise<ArrayBuffer>

    • Decrypts data with an initialization vector and additional authenticated data.

      Parameters

      • iv: ArrayBuffer

        An initialization vector.

      • data: ArrayBuffer

        A plain text as bytes to be encrypted.

      • aad: ArrayBuffer

        Additional authenticated data as bytes fed by an application.

      Returns Promise<ArrayBuffer>

      A decrypted plain text as bytes.

      -

    seal

    • seal(iv, data, aad): Promise<ArrayBuffer>

    • Encrypts data with an initialization vector and additional authenticated data.

      +

    seal

    • seal(iv, data, aad): Promise<ArrayBuffer>

    • Encrypts data with an initialization vector and additional authenticated data.

      Parameters

      • iv: ArrayBuffer

        An initialization vector.

      • data: ArrayBuffer

        A plain text as bytes to be encrypted.

      • aad: ArrayBuffer

        Additional authenticated data as bytes fed by an application.

      Returns Promise<ArrayBuffer>

      A cipher text as bytes.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AeadInterface.html b/interfaces/_divviup_dap._internal_.AeadInterface.html index a6beec884..08a06f609 100644 --- a/interfaces/_divviup_dap._internal_.AeadInterface.html +++ b/interfaces/_divviup_dap._internal_.AeadInterface.html @@ -1,14 +1,14 @@ -AeadInterface | Documentation

Interface AeadInterface

The AEAD interface.

-
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key): AeadEncryptionContext;
}

Properties

id -keySize -nonceSize -tagSize -

Methods

createEncryptionContext -

Properties

Readonly id

id: AeadId

The KDF identifier.

-

Readonly keySize

keySize: number

The length in bytes of an AEAD key (Nk).

-

Readonly nonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

-

Readonly tagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

-

Methods

createEncryptionContext

  • createEncryptionContext(key): AeadEncryptionContext

  • Creates an AEAD encryption context which has seal/open operation.

    +AeadInterface | Documentation

    Interface AeadInterface

    The AEAD interface.

    +
    interface AeadInterface {
        id: AeadId;
        keySize: number;
        nonceSize: number;
        tagSize: number;
        createEncryptionContext(key): AeadEncryptionContext;
    }

    Properties

    id +keySize +nonceSize +tagSize +

    Methods

    createEncryptionContext +

    Properties

    Readonly id

    id: AeadId

    The KDF identifier.

    +

    Readonly keySize

    keySize: number

    The length in bytes of an AEAD key (Nk).

    +

    Readonly nonceSize

    nonceSize: number

    The length in bytes of an AEAD nonce (Nn).

    +

    Readonly tagSize

    tagSize: number

    The length in bytes of an AEAD authentication tag (Nt).

    +

    Methods

    createEncryptionContext

    • createEncryptionContext(key): AeadEncryptionContext

    • Creates an AEAD encryption context which has seal/open operation.

      Parameters

      • key: ArrayBuffer

        A byte string of the raw key.

      Returns AeadEncryptionContext

      An AEAD encryption context.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesCbcParams.html b/interfaces/_divviup_dap._internal_.AesCbcParams.html index 54fbb0f75..bbada9192 100644 --- a/interfaces/_divviup_dap._internal_.AesCbcParams.html +++ b/interfaces/_divviup_dap._internal_.AesCbcParams.html @@ -1,3 +1,3 @@ -AesCbcParams | Documentation

Interface AesCbcParams

interface AesCbcParams {
    iv: BufferSource;
    name: string;
}

Hierarchy (view full)

Properties

iv -name -

Properties

iv

iv: BufferSource

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesCbcParams | Documentation

Interface AesCbcParams

interface AesCbcParams {
    iv: BufferSource;
    name: string;
}

Hierarchy (view full)

Properties

iv +name +

Properties

iv

iv: BufferSource

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesCtrParams.html b/interfaces/_divviup_dap._internal_.AesCtrParams.html index 13c3c1b07..6555f6338 100644 --- a/interfaces/_divviup_dap._internal_.AesCtrParams.html +++ b/interfaces/_divviup_dap._internal_.AesCtrParams.html @@ -1,4 +1,4 @@ -AesCtrParams | Documentation

Interface AesCtrParams

interface AesCtrParams {
    counter: BufferSource;
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

counter -length -name -

Properties

counter

counter: BufferSource

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesCtrParams | Documentation

Interface AesCtrParams

interface AesCtrParams {
    counter: BufferSource;
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

counter +length +name +

Properties

counter

counter: BufferSource

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesDerivedKeyParams.html b/interfaces/_divviup_dap._internal_.AesDerivedKeyParams.html index c12e75cc7..d1f24fa82 100644 --- a/interfaces/_divviup_dap._internal_.AesDerivedKeyParams.html +++ b/interfaces/_divviup_dap._internal_.AesDerivedKeyParams.html @@ -1,3 +1,3 @@ -AesDerivedKeyParams | Documentation

Interface AesDerivedKeyParams

interface AesDerivedKeyParams {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length -name -

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesDerivedKeyParams | Documentation

Interface AesDerivedKeyParams

interface AesDerivedKeyParams {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length +name +

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesGcmParams.html b/interfaces/_divviup_dap._internal_.AesGcmParams.html index cf6717c47..faada475c 100644 --- a/interfaces/_divviup_dap._internal_.AesGcmParams.html +++ b/interfaces/_divviup_dap._internal_.AesGcmParams.html @@ -1,5 +1,5 @@ -AesGcmParams | Documentation

Interface AesGcmParams

interface AesGcmParams {
    additionalData?: BufferSource;
    iv: BufferSource;
    name: string;
    tagLength?: number;
}

Hierarchy (view full)

Properties

additionalData? -iv -name -tagLength? -

Properties

Optional additionalData

additionalData?: BufferSource

iv

iv: BufferSource

name

name: string

Optional tagLength

tagLength?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesGcmParams | Documentation

Interface AesGcmParams

interface AesGcmParams {
    additionalData?: BufferSource;
    iv: BufferSource;
    name: string;
    tagLength?: number;
}

Hierarchy (view full)

Properties

additionalData? +iv +name +tagLength? +

Properties

Optional additionalData

additionalData?: BufferSource

iv

iv: BufferSource

name

name: string

Optional tagLength

tagLength?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesKeyAlgorithm.html b/interfaces/_divviup_dap._internal_.AesKeyAlgorithm.html index 94f4e290f..9251d30e3 100644 --- a/interfaces/_divviup_dap._internal_.AesKeyAlgorithm.html +++ b/interfaces/_divviup_dap._internal_.AesKeyAlgorithm.html @@ -1,3 +1,3 @@ -AesKeyAlgorithm | Documentation

Interface AesKeyAlgorithm

interface AesKeyAlgorithm {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length -name -

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesKeyAlgorithm | Documentation

Interface AesKeyAlgorithm

interface AesKeyAlgorithm {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length +name +

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.AesKeyGenParams.html b/interfaces/_divviup_dap._internal_.AesKeyGenParams.html index 22e967efd..06c8cedc4 100644 --- a/interfaces/_divviup_dap._internal_.AesKeyGenParams.html +++ b/interfaces/_divviup_dap._internal_.AesKeyGenParams.html @@ -1,3 +1,3 @@ -AesKeyGenParams | Documentation

Interface AesKeyGenParams

interface AesKeyGenParams {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length -name -

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +AesKeyGenParams | Documentation

Interface AesKeyGenParams

interface AesKeyGenParams {
    length: number;
    name: string;
}

Hierarchy (view full)

Properties

length +name +

Properties

length

length: number

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Algorithm.html b/interfaces/_divviup_dap._internal_.Algorithm.html index 521d4ac07..9bc533804 100644 --- a/interfaces/_divviup_dap._internal_.Algorithm.html +++ b/interfaces/_divviup_dap._internal_.Algorithm.html @@ -1,2 +1,2 @@ -Algorithm | Documentation

Interface Algorithm

interface Algorithm {
    name: string;
}

Hierarchy (view full)

Properties

name -

Properties

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +Algorithm | Documentation

Interface Algorithm

interface Algorithm {
    name: string;
}

Hierarchy (view full)

Properties

name +

Properties

name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.ArrayBufferView.html b/interfaces/_divviup_dap._internal_.ArrayBufferView.html index 2a3aec376..0a2c80910 100644 --- a/interfaces/_divviup_dap._internal_.ArrayBufferView.html +++ b/interfaces/_divviup_dap._internal_.ArrayBufferView.html @@ -1,7 +1,7 @@ -ArrayBufferView | Documentation

Interface ArrayBufferView

interface ArrayBufferView {
    buffer: ArrayBufferLike;
    byteLength: number;
    byteOffset: number;
}

Properties

buffer -byteLength -byteOffset -

Properties

buffer

buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

-

byteLength

byteLength: number

The length in bytes of the array.

-

byteOffset

byteOffset: number

The offset in bytes of the array.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ArrayBufferView | Documentation

Interface ArrayBufferView

interface ArrayBufferView {
    buffer: ArrayBufferLike;
    byteLength: number;
    byteOffset: number;
}

Properties

buffer +byteLength +byteOffset +

Properties

buffer

buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

+

byteLength

byteLength: number

The length in bytes of the array.

+

byteOffset

byteOffset: number

The offset in bytes of the array.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.ArrayLike.html b/interfaces/_divviup_dap._internal_.ArrayLike.html index 35111ec30..afc0e4ee3 100644 --- a/interfaces/_divviup_dap._internal_.ArrayLike.html +++ b/interfaces/_divviup_dap._internal_.ArrayLike.html @@ -1,2 +1,2 @@ -ArrayLike | Documentation

Interface ArrayLike<T>

interface ArrayLike<T> {
    length: number;
    [n: number]: T;
}

Type Parameters

  • T

Indexable

[n: number]: T

Properties

length -

Properties

Readonly length

length: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +ArrayLike | Documentation

Interface ArrayLike<T>

interface ArrayLike<T> {
    length: number;
    [n: number]: T;
}

Type Parameters

  • T

Indexable

[n: number]: T

Properties

length +

Properties

Readonly length

length: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Buffer.html b/interfaces/_divviup_dap._internal_.Buffer.html index 15201b926..082d5390f 100644 --- a/interfaces/_divviup_dap._internal_.Buffer.html +++ b/interfaces/_divviup_dap._internal_.Buffer.html @@ -1,116 +1,116 @@ -Buffer | Documentation

Interface Buffer

interface Buffer {
    BYTES_PER_ELEMENT: number;
    [toStringTag]: "Uint8Array";
    buffer: ArrayBufferLike;
    byteLength: number;
    byteOffset: number;
    length: number;
    [iterator](): IterableIterator<number>;
    at(index): undefined | number;
    compare(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): -1 | 0 | 1;
    copy(target, targetStart?, sourceStart?, sourceEnd?): number;
    copyWithin(target, start, end?): this;
    entries(): IterableIterator<[number, number]>;
    equals(otherBuffer): boolean;
    every(predicate, thisArg?): boolean;
    fill(value, offset?, end?, encoding?): this;
    filter(predicate, thisArg?): Uint8Array;
    find(predicate, thisArg?): undefined | number;
    findIndex(predicate, thisArg?): number;
    forEach(callbackfn, thisArg?): void;
    includes(value, byteOffset?, encoding?): boolean;
    indexOf(value, byteOffset?, encoding?): number;
    join(separator?): string;
    keys(): IterableIterator<number>;
    lastIndexOf(value, byteOffset?, encoding?): number;
    map(callbackfn, thisArg?): Uint8Array;
    readBigInt64BE(offset?): bigint;
    readBigInt64LE(offset?): bigint;
    readBigUInt64BE(offset?): bigint;
    readBigUInt64LE(offset?): bigint;
    readBigUint64BE(offset?): bigint;
    readBigUint64LE(offset?): bigint;
    readDoubleBE(offset?): number;
    readDoubleLE(offset?): number;
    readFloatBE(offset?): number;
    readFloatLE(offset?): number;
    readInt16BE(offset?): number;
    readInt16LE(offset?): number;
    readInt32BE(offset?): number;
    readInt32LE(offset?): number;
    readInt8(offset?): number;
    readIntBE(offset, byteLength): number;
    readIntLE(offset, byteLength): number;
    readUInt16BE(offset?): number;
    readUInt16LE(offset?): number;
    readUInt32BE(offset?): number;
    readUInt32LE(offset?): number;
    readUInt8(offset?): number;
    readUIntBE(offset, byteLength): number;
    readUIntLE(offset, byteLength): number;
    readUint16BE(offset?): number;
    readUint16LE(offset?): number;
    readUint32BE(offset?): number;
    readUint32LE(offset?): number;
    readUint8(offset?): number;
    readUintBE(offset, byteLength): number;
    readUintLE(offset, byteLength): number;
    reduce(callbackfn): number;
    reduce(callbackfn, initialValue): number;
    reduce<U>(callbackfn, initialValue): U;
    reduceRight(callbackfn): number;
    reduceRight(callbackfn, initialValue): number;
    reduceRight<U>(callbackfn, initialValue): U;
    reverse(): this;
    set(array, offset?): void;
    slice(start?, end?): Buffer;
    some(predicate, thisArg?): boolean;
    sort(compareFn?): this;
    subarray(start?, end?): Buffer;
    swap16(): Buffer;
    swap32(): Buffer;
    swap64(): Buffer;
    toJSON(): {
        data: number[];
        type: "Buffer";
    };
    toLocaleString(): string;
    toString(encoding?, start?, end?): string;
    valueOf(): Uint8Array;
    values(): IterableIterator<number>;
    write(string, encoding?): number;
    write(string, offset, encoding?): number;
    write(string, offset, length, encoding?): number;
    writeBigInt64BE(value, offset?): number;
    writeBigInt64LE(value, offset?): number;
    writeBigUInt64BE(value, offset?): number;
    writeBigUInt64LE(value, offset?): number;
    writeBigUint64BE(value, offset?): number;
    writeBigUint64LE(value, offset?): number;
    writeDoubleBE(value, offset?): number;
    writeDoubleLE(value, offset?): number;
    writeFloatBE(value, offset?): number;
    writeFloatLE(value, offset?): number;
    writeInt16BE(value, offset?): number;
    writeInt16LE(value, offset?): number;
    writeInt32BE(value, offset?): number;
    writeInt32LE(value, offset?): number;
    writeInt8(value, offset?): number;
    writeIntBE(value, offset, byteLength): number;
    writeIntLE(value, offset, byteLength): number;
    writeUInt16BE(value, offset?): number;
    writeUInt16LE(value, offset?): number;
    writeUInt32BE(value, offset?): number;
    writeUInt32LE(value, offset?): number;
    writeUInt8(value, offset?): number;
    writeUIntBE(value, offset, byteLength): number;
    writeUIntLE(value, offset, byteLength): number;
    writeUint16BE(value, offset?): number;
    writeUint16LE(value, offset?): number;
    writeUint32BE(value, offset?): number;
    writeUint32LE(value, offset?): number;
    writeUint8(value, offset?): number;
    writeUintBE(value, offset, byteLength): number;
    writeUintLE(value, offset, byteLength): number;
}

Hierarchy

  • Uint8Array
    • Buffer

Properties

BYTES_PER_ELEMENT -[toStringTag] -buffer -byteLength -byteOffset -length -

Methods

[iterator] -at -compare -copy -copyWithin -entries -equals -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -readBigInt64BE -readBigInt64LE -readBigUInt64BE -readBigUInt64LE -readBigUint64BE -readBigUint64LE -readDoubleBE -readDoubleLE -readFloatBE -readFloatLE -readInt16BE -readInt16LE -readInt32BE -readInt32LE -readInt8 -readIntBE -readIntLE -readUInt16BE -readUInt16LE -readUInt32BE -readUInt32LE -readUInt8 -readUIntBE -readUIntLE -readUint16BE -readUint16LE -readUint32BE -readUint32LE -readUint8 -readUintBE -readUintLE -reduce -reduceRight -reverse -set -slice -some -sort -subarray -swap16 -swap32 -swap64 -toJSON -toLocaleString -toString -valueOf -values -write -writeBigInt64BE -writeBigInt64LE -writeBigUInt64BE -writeBigUInt64LE -writeBigUint64BE -writeBigUint64LE -writeDoubleBE -writeDoubleLE -writeFloatBE -writeFloatLE -writeInt16BE -writeInt16LE -writeInt32BE -writeInt32LE -writeInt8 -writeIntBE -writeIntLE -writeUInt16BE -writeUInt16LE -writeUInt32BE -writeUInt32LE -writeUInt8 -writeUIntBE -writeUIntLE -writeUint16BE -writeUint16LE -writeUint32BE -writeUint32LE -writeUint8 -writeUintBE -writeUintLE -

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Uint8Array"

Readonly buffer

buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number

The offset in bytes of the array.

-

Readonly length

length: number

The length of the array.

-

Methods

[iterator]

  • [iterator](): IterableIterator<number>

  • Returns IterableIterator<number>

at

copy

  • copy(target, targetStart?, sourceStart?, sourceEnd?): number

  • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

    +

copy

  • copy(target, targetStart?, sourceStart?, sourceEnd?): number

  • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

    TypedArray.prototype.set() performs the same operation, and is available for all TypedArrays, including Node.js Buffers, although it takes different function arguments.

    @@ -143,30 +143,30 @@
  • Optional sourceEnd: number

    The offset within buf at which to stop copying (not inclusive).

Returns number

The number of bytes copied.

Since

v0.1.90

-

copyWithin

  • copyWithin(target, start, end?): this

  • Returns the this object after copying a section of the array identified by start and end +

copyWithin

  • copyWithin(target, start, end?): this

  • 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.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: number

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

      -

    Returns this

entries

Returns this

entries

  • entries(): IterableIterator<[number, number]>

  • Creates and returns an iterator of [index, byte] pairs from the contents of buf.

    import { Buffer } from 'node:buffer';

    // Log the entire contents of a `Buffer`.

    const buf = Buffer.from('buffer');

    for (const pair of buf.entries()) {
      console.log(pair);
    }
    // Prints:
    //   [0, 98]
    //   [1, 117]
    //   [2, 102]
    //   [3, 102]
    //   [4, 101]
    //   [5, 114]

    Returns IterableIterator<[number, number]>

    Since

    v1.1.0

    -

equals

  • equals(otherBuffer): boolean

  • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

    +

equals

  • equals(otherBuffer): boolean

  • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

    import { Buffer } from 'node:buffer';

    const buf1 = Buffer.from('ABC');
    const buf2 = Buffer.from('414243', 'hex');
    const buf3 = Buffer.from('ABCD');

    console.log(buf1.equals(buf2));
    // Prints: true
    console.log(buf1.equals(buf3));
    // Prints: false

    Parameters

    • otherBuffer: Uint8Array

      A Buffer or Uint8Array with which to compare buf.

    Returns boolean

    Since

    v0.11.13

    -

every

  • every(predicate, thisArg?): boolean

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

    +

every

  • every(predicate, thisArg?): boolean

  • 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

fill

  • fill(value, offset?, end?, encoding?): this

  • Fills buf with the specified value. If the offset and end are not given, +

Returns boolean

fill

  • fill(value, offset?, end?, encoding?): this

  • Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled:

    import { Buffer } from 'node:buffer';

    // Fill a `Buffer` with the ASCII character 'h'.

    const b = Buffer.allocUnsafe(50).fill('h');

    console.log(b.toString());
    // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

    // Fill a buffer with empty string
    const c = Buffer.allocUnsafe(5).fill('');

    console.log(c.fill(''));
    // Prints: <Buffer 00 00 00 00 00>
    @@ -187,31 +187,31 @@
  • Optional encoding: BufferEncoding

    The encoding for value if value is a string.

Returns this

A reference to buf.

Since

v0.5.0

-

filter

  • filter(predicate, thisArg?): Uint8Array

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

    +

filter

  • filter(predicate, thisArg?): Uint8Array

  • 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

find

  • find(predicate, thisArg?): undefined | number

  • Returns the value of the first element in the array where predicate is true, and undefined +

Returns Uint8Array

find

  • find(predicate, thisArg?): undefined | number

  • 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

findIndex

  • findIndex(predicate, thisArg?): number

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

Returns undefined | number

findIndex

  • findIndex(predicate, thisArg?): 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

forEach

  • forEach(callbackfn, thisArg?): void

  • Performs the specified action for each element in an array.

    +

Returns number

forEach

  • forEach(callbackfn, thisArg?): void

  • 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

includes

  • includes(value, byteOffset?, encoding?): boolean

  • Equivalent to buf.indexOf() !== -1.

    +

Returns void

includes

  • includes(value, byteOffset?, encoding?): boolean

  • Equivalent to buf.indexOf() !== -1.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from('this is a buffer');

    console.log(buf.includes('this'));
    // Prints: true
    console.log(buf.includes('is'));
    // Prints: true
    console.log(buf.includes(Buffer.from('a buffer')));
    // Prints: true
    console.log(buf.includes(97));
    // Prints: true (97 is the decimal ASCII value for 'a')
    console.log(buf.includes(Buffer.from('a buffer example')));
    // Prints: false
    console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
    // Prints: true
    console.log(buf.includes('this', 4));
    // Prints: false

    Parameters

    • value: string | number | Buffer

      What to search for.

      @@ -219,7 +219,7 @@
    • Optional encoding: BufferEncoding

      If value is a string, this is its encoding.

    Returns boolean

    true if value was found in buf, false otherwise.

    Since

    v5.3.0

    -

indexOf

  • indexOf(value, byteOffset?, encoding?): number

  • If value is:

    +

indexOf

  • indexOf(value, byteOffset?, encoding?): number

  • If value is:

    • a string, value is interpreted according to the character encoding inencoding.
    • a Buffer or Uint8Array, value will be used in its entirety. @@ -243,14 +243,14 @@
  • Optional encoding: BufferEncoding

    If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

Returns number

The index of the first occurrence of value in buf, or -1 if buf does not contain value.

Since

v1.5.0

-

join

  • join(separator?): string

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

    +

join

  • join(separator?): string

  • 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

keys

Returns string

keys

  • keys(): IterableIterator<number>

  • Creates and returns an iterator of buf keys (indices).

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from('buffer');

    for (const key of buf.keys()) {
      console.log(key);
    }
    // Prints:
    //   0
    //   1
    //   2
    //   3
    //   4
    //   5

    Returns IterableIterator<number>

    Since

    v1.1.0

    -

lastIndexOf

  • lastIndexOf(value, byteOffset?, encoding?): number

  • Identical to buf.indexOf(), except the last occurrence of value is found +

lastIndexOf

  • lastIndexOf(value, byteOffset?, encoding?): number

  • Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from('this buffer is a buffer');

    console.log(buf.lastIndexOf('this'));
    // Prints: 0
    console.log(buf.lastIndexOf('buffer'));
    // Prints: 17
    console.log(buf.lastIndexOf(Buffer.from('buffer')));
    // Prints: 17
    console.log(buf.lastIndexOf(97));
    // Prints: 15 (97 is the decimal ASCII value for 'a')
    console.log(buf.lastIndexOf(Buffer.from('yolo')));
    // Prints: -1
    console.log(buf.lastIndexOf('buffer', 5));
    // Prints: 5
    console.log(buf.lastIndexOf('buffer', 4));
    // Prints: -1

    const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

    console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
    // Prints: 6
    console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
    // Prints: 4
    @@ -267,133 +267,133 @@
  • Optional encoding: BufferEncoding

    If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

Returns number

The index of the last occurrence of value in buf, or -1 if buf does not contain value.

Since

v6.0.0

-

map

  • map(callbackfn, thisArg?): Uint8Array

  • Calls a defined callback function on each element of an array, and returns an array that +

map

  • map(callbackfn, thisArg?): Uint8Array

  • 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

readBigInt64BE

  • readBigInt64BE(offset?): bigint

  • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

    +

Returns Uint8Array

readBigInt64BE

  • readBigInt64BE(offset?): bigint

  • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns bigint

    Since

    v12.0.0, v10.20.0

    -

readBigInt64LE

  • readBigInt64LE(offset?): bigint

  • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

    +

readBigInt64LE

  • readBigInt64LE(offset?): bigint

  • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns bigint

    Since

    v12.0.0, v10.20.0

    -

readBigUInt64BE

  • readBigUInt64BE(offset?): bigint

  • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

    +

readBigUInt64BE

  • readBigUInt64BE(offset?): bigint

  • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

    This function is also available under the readBigUint64BE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64BE(0));
    // Prints: 4294967295n

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns bigint

    Since

    v12.0.0, v10.20.0

    -

readBigUInt64LE

  • readBigUInt64LE(offset?): bigint

  • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

    +

readBigUInt64LE

  • readBigUInt64LE(offset?): bigint

  • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

    This function is also available under the readBigUint64LE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64LE(0));
    // Prints: 18446744069414584320n

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns bigint

    Since

    v12.0.0, v10.20.0

    -

readBigUint64BE

  • readBigUint64BE(offset?): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

    Alias

    Buffer.readBigUInt64BE

    +

readBigUint64BE

  • readBigUint64BE(offset?): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

    Alias

    Buffer.readBigUInt64BE

    Since

    v14.10.0, v12.19.0

    -

readBigUint64LE

  • readBigUint64LE(offset?): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

    Alias

    Buffer.readBigUInt64LE

    +

readBigUint64LE

  • readBigUint64LE(offset?): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

    Alias

    Buffer.readBigUInt64LE

    Since

    v14.10.0, v12.19.0

    -

readDoubleBE

  • readDoubleBE(offset?): number

  • Reads a 64-bit, big-endian double from buf at the specified offset.

    +

readDoubleBE

  • readDoubleBE(offset?): number

  • Reads a 64-bit, big-endian double from buf at the specified offset.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleBE(0));
    // Prints: 8.20788039913184e-304

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    Since

    v0.11.15

    -

readDoubleLE

  • readDoubleLE(offset?): number

  • Reads a 64-bit, little-endian double from buf at the specified offset.

    +

readDoubleLE

  • readDoubleLE(offset?): number

  • Reads a 64-bit, little-endian double from buf at the specified offset.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleLE(0));
    // Prints: 5.447603722011605e-270
    console.log(buf.readDoubleLE(1));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    Since

    v0.11.15

    -

readFloatBE

  • readFloatBE(offset?): number

  • Reads a 32-bit, big-endian float from buf at the specified offset.

    +

readFloatBE

  • readFloatBE(offset?): number

  • Reads a 32-bit, big-endian float from buf at the specified offset.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatBE(0));
    // Prints: 2.387939260590663e-38

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.11.15

    -

readFloatLE

  • readFloatLE(offset?): number

  • Reads a 32-bit, little-endian float from buf at the specified offset.

    +

readFloatLE

  • readFloatLE(offset?): number

  • Reads a 32-bit, little-endian float from buf at the specified offset.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatLE(0));
    // Prints: 1.539989614439558e-36
    console.log(buf.readFloatLE(1));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.11.15

    -

readInt16BE

  • readInt16BE(offset?): number

  • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

    +

readInt16BE

  • readInt16BE(offset?): number

  • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16BE(0));
    // Prints: 5

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    Since

    v0.5.5

    -

readInt16LE

  • readInt16LE(offset?): number

  • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

    +

readInt16LE

  • readInt16LE(offset?): number

  • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16LE(0));
    // Prints: 1280
    console.log(buf.readInt16LE(1));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    Since

    v0.5.5

    -

readInt32BE

  • readInt32BE(offset?): number

  • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

    +

readInt32BE

  • readInt32BE(offset?): number

  • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32BE(0));
    // Prints: 5

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.5.5

    -

readInt32LE

  • readInt32LE(offset?): number

  • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

    +

readInt32LE

  • readInt32LE(offset?): number

  • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32LE(0));
    // Prints: 83886080
    console.log(buf.readInt32LE(1));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.5.5

    -

readInt8

  • readInt8(offset?): number

  • Reads a signed 8-bit integer from buf at the specified offset.

    +

readInt8

  • readInt8(offset?): number

  • Reads a signed 8-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([-1, 5]);

    console.log(buf.readInt8(0));
    // Prints: -1
    console.log(buf.readInt8(1));
    // Prints: 5
    console.log(buf.readInt8(2));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    Since

    v0.5.0

    -

readIntBE

  • readIntBE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value +

readIntBE

  • readIntBE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntBE(0, 6).toString(16));
    // Prints: 1234567890ab
    console.log(buf.readIntBE(1, 6).toString(16));
    // Throws ERR_OUT_OF_RANGE.
    console.log(buf.readIntBE(1, 0).toString(16));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    • byteLength: number

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Returns number

    Since

    v0.11.15

    -

readIntLE

  • readIntLE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value +

readIntLE

  • readIntLE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntLE(0, 6).toString(16));
    // Prints: -546f87a9cbee

    Parameters

    • offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    • byteLength: number

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Returns number

    Since

    v0.11.15

    -

readUInt16BE

  • readUInt16BE(offset?): number

  • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

    +

readUInt16BE

  • readUInt16BE(offset?): number

  • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint16BE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16BE(0).toString(16));
    // Prints: 1234
    console.log(buf.readUInt16BE(1).toString(16));
    // Prints: 3456

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    Since

    v0.5.5

    -

readUInt16LE

  • readUInt16LE(offset?): number

  • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

    +

readUInt16LE

  • readUInt16LE(offset?): number

  • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint16LE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16LE(0).toString(16));
    // Prints: 3412
    console.log(buf.readUInt16LE(1).toString(16));
    // Prints: 5634
    console.log(buf.readUInt16LE(2).toString(16));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    Since

    v0.5.5

    -

readUInt32BE

  • readUInt32BE(offset?): number

  • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

    +

readUInt32BE

  • readUInt32BE(offset?): number

  • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint32BE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32BE(0).toString(16));
    // Prints: 12345678

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.5.5

    -

readUInt32LE

  • readUInt32LE(offset?): number

  • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

    +

readUInt32LE

  • readUInt32LE(offset?): number

  • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint32LE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32LE(0).toString(16));
    // Prints: 78563412
    console.log(buf.readUInt32LE(1).toString(16));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    Since

    v0.5.5

    -

readUInt8

  • readUInt8(offset?): number

  • Reads an unsigned 8-bit integer from buf at the specified offset.

    +

readUInt8

  • readUInt8(offset?): number

  • Reads an unsigned 8-bit integer from buf at the specified offset.

    This function is also available under the readUint8 alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([1, -2]);

    console.log(buf.readUInt8(0));
    // Prints: 1
    console.log(buf.readUInt8(1));
    // Prints: 254
    console.log(buf.readUInt8(2));
    // Throws ERR_OUT_OF_RANGE.

    Parameters

    • Optional offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    Since

    v0.5.0

    -

readUIntBE

  • readUIntBE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting +

readUIntBE

  • readUIntBE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.

    This function is also available under the readUintBE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntBE(0, 6).toString(16));
    // Prints: 1234567890ab
    console.log(buf.readUIntBE(1, 6).toString(16));
    // Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ 
    Since
    v14.10.0, v12.19.0

    Parameters

    • offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    • byteLength: number

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Returns number

    Since

    v0.11.15

    -

readUIntLE

  • readUIntLE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting +

readUIntLE

  • readUIntLE(offset, byteLength): number

  • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.

    This function is also available under the readUintLE alias.

    import { Buffer } from 'node:buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntLE(0, 6).toString(16));
    // Prints: ab9078563412
@@ -409,26 +409,26 @@ 
    Since
    v14.10.0, v12.19.0

    Parameters

    • offset: number

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    • byteLength: number

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Returns number

    Since

    v0.11.15

    -

readUint16BE

  • readUint16BE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt16BE

    +

readUint16BE

  • readUint16BE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt16BE

    Since

    v14.9.0, v12.19.0

    -

readUint16LE

  • readUint16LE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt16LE

    +

readUint16LE

  • readUint16LE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt16LE

    Since

    v14.9.0, v12.19.0

    -

readUint32BE

  • readUint32BE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt32BE

    +

readUint32BE

  • readUint32BE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt32BE

    Since

    v14.9.0, v12.19.0

    -

readUint32LE

  • readUint32LE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt32LE

    +

readUint32LE

  • readUint32LE(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt32LE

    Since

    v14.9.0, v12.19.0

    -

readUint8

  • readUint8(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt8

    +

readUint8

  • readUint8(offset?): number

  • Parameters

    • Optional offset: number

    Returns number

    Alias

    Buffer.readUInt8

    Since

    v14.9.0, v12.19.0

    -

readUintBE

  • readUintBE(offset, byteLength): number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

    Alias

    Buffer.readUIntBE

    +

readUintBE

  • readUintBE(offset, byteLength): number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

    Alias

    Buffer.readUIntBE

    Since

    v14.9.0, v12.19.0

    -

readUintLE

  • readUintLE(offset, byteLength): number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

    Alias

    Buffer.readUIntLE

    +

readUintLE

  • readUintLE(offset, byteLength): number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

    Alias

    Buffer.readUIntLE

    Since

    v14.9.0, v12.19.0

    -

reduce

  • reduce(callbackfn): number

  • Calls the specified callback function for all the elements in an array. The return value of +

reduce

  • reduce(callbackfn): 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.

    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

  • reduce(callbackfn, initialValue): 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

  • reduce<U>(callbackfn, initialValue): U

  • Calls the specified callback function for all the elements in an array. The return value of +

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

      • Parameters

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

        Returns number

Returns number

  • reduce(callbackfn, initialValue): 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

  • reduce<U>(callbackfn, initialValue): U

  • 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 @@ -436,12 +436,12 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. +

    Returns U

    reduceRight

    • reduceRight(callbackfn): 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.

      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

    • reduceRight(callbackfn, initialValue): 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

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. +

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

        • Parameters

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

          Returns number

    Returns number

  • reduceRight(callbackfn, initialValue): 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

  • reduceRight<U>(callbackfn, initialValue): 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.

    Type Parameters

    • U

    Parameters

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

      A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      +

    Returns U

    reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • 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

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

    Returns void

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      This method is not compatible with the Uint8Array.prototype.slice(), which is a superclass of Buffer. To copy the slice, useUint8Array.prototype.slice().

      @@ -462,19 +462,19 @@

      Since

      v14.9.0, v12.19.0

    • Optional end: number

      Where the new Buffer will end (not inclusive).

    Returns Buffer

    Since

    v0.3.0

    Deprecated

    Use subarray instead.

    -

    some

    • some(predicate, thisArg?): boolean

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

      +

    some

    • some(predicate, thisArg?): boolean

    • 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

    sort

    • sort(compareFn?): this

    • Sorts an array.

      +

    Returns boolean

    sort

    • sort(compareFn?): this

    • 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 this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

        • (a, b): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      Specifying end greater than buf.length will return the same result as that of end equal to buf.length.

      @@ -489,7 +489,7 @@

      Deprecated

      Use subarray instead.

      Parameters

      • Optional start: number

        Where the new Buffer will start.

      • Optional end: number

        Where the new Buffer will end (not inclusive).

      Returns Buffer

      Since

      v3.0.0

      -

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the +

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 2.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap16();

      console.log(buf1);
      // Prints: <Buffer 02 01 04 03 06 05 08 07>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap16();
      // Throws ERR_INVALID_BUFFER_SIZE.
      @@ -499,27 +499,27 @@

      Deprecated

      Use subarray instead.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the +

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 4.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap32();

      console.log(buf1);
      // Prints: <Buffer 04 03 02 01 08 07 06 05>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap32();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. +

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 8.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap64();

      console.log(buf1);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap64();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v6.3.0

      -

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls +

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls this function when stringifying a Buffer instance.

      Buffer.from() accepts objects in the format returned from this method. In particular, Buffer.from(buf.toJSON()) works like Buffer.from(buf).

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
      const json = JSON.stringify(buf);

      console.log(json);
      // Prints: {"type":"Buffer","data":[1,2,3,4,5]}

      const copy = JSON.parse(json, (key, value) => {
        return value &#x26;&#x26; value.type === 'Buffer' ?
          Buffer.from(value) :
          value;
      });

      console.log(copy);
      // Prints: <Buffer 01 02 03 04 05>

      Returns {
          data: number[];
          type: "Buffer";
      }

      • data: number[]
      • type: "Buffer"

      Since

      v0.9.2

      -

    toLocaleString

    • toLocaleString(): string

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

      -

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      +

    toLocaleString

    • toLocaleString(): string

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

      +

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8, then each invalid byte is replaced with the replacement character U+FFFD.

      The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@

      Deprecated

      Use subarray instead.

    • Optional start: number

      The byte offset to start decoding at.

    • Optional end: number

      The byte offset to stop decoding at (not inclusive).

    Returns string

    Since

    v0.1.90

    -

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      -

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is +

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      +

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is called automatically when a Buffer is used in a for..of statement.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('buffer');

      for (const value of buf.values()) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      for (const value of buf) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      Returns IterableIterator<number>

      Since

      v1.1.0

      -

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did +

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did not contain enough space to fit the entire string, only part of string will be written. However, partially encoded characters will not be written.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(256);

      const len = buf.write('\u00bd + \u00bc = \u00be', 0);

      console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
      // Prints: 12 bytes: ½ + ¼ = ¾

      const buffer = Buffer.alloc(10);

      const length = buffer.write('abcd', 8);

      console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
      // Prints: 2 bytes : ab
@@ -545,7 +545,7 @@ 
      Deprecated
      Use subarray instead.
    • Optional encoding: BufferEncoding

      The character encoding of string.

    Returns number

    Number of bytes written.

    Since

    v0.1.90

    -
  • write(string, offset, encoding?): number

  • Parameters

    Returns number

  • write(string, offset, length, encoding?): number

  • Parameters

    • string: string
    • offset: number
    • length: number
    • Optional encoding: BufferEncoding

    Returns number

    • writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +
    • write(string, offset, encoding?): number

    • Parameters

      Returns number

    • write(string, offset, length, encoding?): number

    • Parameters

      • string: string
      • offset: number
      • length: number
      • Optional encoding: BufferEncoding

      Returns number

    writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64BE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>
      @@ -553,7 +553,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      +

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64LE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>
      @@ -561,7 +561,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      This function is also available under the writeBigUint64BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de ca fa fe ca ce fa de>
      @@ -569,7 +569,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      +

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de fa ce ca fe fa ca de>

      This function is also available under the writeBigUint64LE alias.

      @@ -577,11 +577,11 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      +

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      Since

      v14.10.0, v12.19.0

      -

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      +

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      Since

      v14.10.0, v12.19.0

      -

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleBE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
      @@ -589,7 +589,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleLE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
      @@ -597,7 +597,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is +

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatBE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer 4f 4a fe bb>
      @@ -605,7 +605,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is +

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatLE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer bb fe 4a 4f>
      @@ -613,7 +613,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16BE(0x0102, 0);

      console.log(buf);
      // Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16LE(0x0304, 0);

      console.log(buf);
      // Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32BE(0x01020304, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32LE(0x05060708, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid +

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid signed 8-bit integer. Behavior is undefined when value is anything other than a signed 8-bit integer.

      value is interpreted and written as a two's complement signed integer.

      @@ -659,7 +659,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a +

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
      @@ -668,7 +668,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
      @@ -677,7 +677,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16BE(0xdead, 0);
      buf.writeUInt16BE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is +

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16LE(0xdead, 0);
      buf.writeUInt16LE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32BE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is +

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32LE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a +

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer. Behavior is undefined when value is anything other than an unsigned 8-bit integer.

      This function is also available under the writeUint8 alias.

      @@ -723,7 +723,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintBE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintLE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      +

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      +

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      +

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      +

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      +

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      Since

      v14.9.0, v12.19.0

      -

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      +

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      Since

      v14.9.0, v12.19.0

      -

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      +

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      Since

      v14.9.0, v12.19.0

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.BufferConstructor.html b/interfaces/_divviup_dap._internal_.BufferConstructor.html index 563a49ca9..8951e0dd0 100644 --- a/interfaces/_divviup_dap._internal_.BufferConstructor.html +++ b/interfaces/_divviup_dap._internal_.BufferConstructor.html @@ -1,43 +1,43 @@ -BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. +BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'

    -
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor -

    Properties

    poolSize -

    Methods

    alloc -allocUnsafe -allocUnsafeSlow -byteLength -compare -concat -copyBytesFrom -from -isBuffer -isEncoding -of -

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      +
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor +

    Properties

    poolSize +

    Methods

    alloc +allocUnsafe +allocUnsafeSlow +byteLength +compare +concat +copyBytesFrom +from +isBuffer +isEncoding +of +

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: BufferEncoding

        encoding to use, optional. Default is 'utf8'

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

      -
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      +
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as +

    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.

      Parameters

      • arrayBuffer: ArrayBuffer | SharedArrayBuffer

        The ArrayBuffer with which to share memory.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: readonly any[]

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      +
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(buffer) instead.

      -

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used +

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used for pooling. This value may be modified.

    Since

    v0.11.3

    -

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      +

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(5);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00>

      If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      @@ -56,7 +56,7 @@
    • Optional fill: string | number | Uint8Array

      A value to pre-fill the new Buffer with.

    • Optional encoding: BufferEncoding

      If fill is a string, this is its encoding.

    Returns Buffer

    Since

    v5.10.0

    -

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      +

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use Buffer.alloc() instead to initializeBuffer instances with zeroes.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(10);

      console.log(buf);
      // Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

      buf.fill(0);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
 additional performance that Buffer.allocUnsafe() provides.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.10.0

      -

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if +

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if size is 0.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use buf.fill(0) to initialize @@ -93,7 +93,7 @@

      A TypeError will be thrown if size is not a number.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.12.0

      -

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. +

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. This is not the same as String.prototype.length, which does not account for the encoding that is used to convert the string into bytes.

      For 'base64', 'base64url', and 'hex', this function assumes valid input. @@ -110,12 +110,12 @@

    • Optional encoding: BufferEncoding

      If string is a string, this is its encoding.

    Returns number

    The number of bytes contained within string.

    Since

    v0.1.90

    -

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      +

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from('1234');
      const buf2 = Buffer.from('0123');
      const arr = [buf1, buf2];

      console.log(arr.sort(Buffer.compare));
      // Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
      // (This result is equal to: [buf2, buf1].)

      Parameters

      • buf1: Uint8Array
      • buf2: Uint8Array

      Returns -1 | 0 | 1

      Either -1, 0, or 1, depending on the result of the comparison. See compare for details.

      Since

      v0.11.13

      -

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      +

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      If the list has no items, or if the totalLength is 0, then a new zero-lengthBuffer is returned.

      If totalLength is not provided, it is calculated from the Buffer instances in list by adding their lengths.

      @@ -128,14 +128,14 @@

      Parameters

      • list: readonly Uint8Array[]

        List of Buffer or Uint8Array instances to concatenate.

      • Optional totalLength: number

        Total length of the Buffer instances in list when concatenated.

      Returns Buffer

      Since

      v0.7.11

      -

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      +

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      const u16 = new Uint16Array([0, 0xffff]);
      const buf = Buffer.copyBytesFrom(u16, 1, 1);
      u16[1] = 0;
      console.log(buf.length); // 2
      console.log(buf[0]); // 255
      console.log(buf[1]); // 255

      Parameters

      • view: TypedArray

        The {TypedArray} to copy.

      • Optional offset: number

        The starting offset within view.

      • Optional length: number

        The number of elements from view to copy.

      Returns Buffer

      Since

      v19.8.0

      -

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. +

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.

      import { Buffer } from 'node:buffer';

      // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
      const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
      @@ -146,20 +146,20 @@ appropriate for Buffer.from() variants.

      Buffer.from(array) and Buffer.from(string) may also use the internalBuffer pool like Buffer.allocUnsafe() does.

      Parameters

      Returns Buffer

      Since

      v5.10.0

      -
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      +
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      Parameters

      • data: Uint8Array | readonly number[]

        data to create a new Buffer

        -

      Returns Buffer

    • from(data): Buffer

    • Parameters

      Returns Buffer

    • from(str, encoding?): Buffer

    • Creates a new Buffer containing the given JavaScript string {str}. +

    Returns Buffer

  • from(data): Buffer

  • Parameters

    Returns Buffer

  • from(str, encoding?): Buffer

  • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

    -

    Parameters

    Returns Buffer

    • isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      +

      Parameters

      Returns Buffer

    isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      import { Buffer } from 'node:buffer';

      Buffer.isBuffer(Buffer.alloc(10)); // true
      Buffer.isBuffer(Buffer.from('foo')); // true
      Buffer.isBuffer('a string'); // false
      Buffer.isBuffer([]); // false
      Buffer.isBuffer(new Uint8Array(1024)); // false

      Parameters

      • obj: any

      Returns obj is Buffer

      Since

      v0.1.101

      -

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, +

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, or false otherwise.

      import { Buffer } from 'node:buffer';

      console.log(Buffer.isEncoding('utf8'));
      // Prints: true

      console.log(Buffer.isEncoding('hex'));
      // Prints: true

      console.log(Buffer.isEncoding('utf/8'));
      // Prints: false

      console.log(Buffer.isEncoding(''));
      // Prints: false

      Parameters

      • encoding: string

        A character encoding name to check.

      Returns encoding is BufferEncoding

      Since

      v0.9.1

      -

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      -

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      +

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.CallSite.html b/interfaces/_divviup_dap._internal_.CallSite.html index 7a9d52061..5eca2d013 100644 --- a/interfaces/_divviup_dap._internal_.CallSite.html +++ b/interfaces/_divviup_dap._internal_.CallSite.html @@ -1,48 +1,48 @@ -CallSite | Documentation

    Interface CallSite

    interface CallSite {
        getColumnNumber(): null | number;
        getEnclosingColumnNumber(): number;
        getEnclosingLineNumber(): number;
        getEvalOrigin(): undefined | string;
        getFileName(): undefined | string;
        getFunction(): undefined | Function;
        getFunctionName(): null | string;
        getLineNumber(): null | number;
        getMethodName(): null | string;
        getPosition(): number;
        getPromiseIndex(): null | number;
        getScriptHash(): string;
        getScriptNameOrSourceURL(): string;
        getThis(): unknown;
        getTypeName(): null | string;
        isAsync(): boolean;
        isConstructor(): boolean;
        isEval(): boolean;
        isNative(): boolean;
        isPromiseAll(): boolean;
        isToplevel(): boolean;
        toString(): string;
    }

    Methods

    getColumnNumber -getEnclosingColumnNumber -getEnclosingLineNumber -getEvalOrigin -getFileName -getFunction -getFunctionName -getLineNumber -getMethodName -getPosition -getPromiseIndex -getScriptHash -getScriptNameOrSourceURL -getThis -getTypeName -isAsync -isConstructor -isEval -isNative -isPromiseAll -isToplevel -toString -

    Methods

    getColumnNumber

    • getColumnNumber(): null | number

    • Current column number [if this function was defined in a script]

      -

      Returns null | number

    getEnclosingColumnNumber

    • getEnclosingColumnNumber(): number

    • Returns number

    getEnclosingLineNumber

    • getEnclosingLineNumber(): number

    • Returns number

    getEvalOrigin

    • getEvalOrigin(): undefined | string

    • A call site object representing the location where eval was called +CallSite | Documentation

      Interface CallSite

      interface CallSite {
          getColumnNumber(): null | number;
          getEnclosingColumnNumber(): number;
          getEnclosingLineNumber(): number;
          getEvalOrigin(): undefined | string;
          getFileName(): undefined | string;
          getFunction(): undefined | Function;
          getFunctionName(): null | string;
          getLineNumber(): null | number;
          getMethodName(): null | string;
          getPosition(): number;
          getPromiseIndex(): null | number;
          getScriptHash(): string;
          getScriptNameOrSourceURL(): string;
          getThis(): unknown;
          getTypeName(): null | string;
          isAsync(): boolean;
          isConstructor(): boolean;
          isEval(): boolean;
          isNative(): boolean;
          isPromiseAll(): boolean;
          isToplevel(): boolean;
          toString(): string;
      }

      Methods

      getColumnNumber +getEnclosingColumnNumber +getEnclosingLineNumber +getEvalOrigin +getFileName +getFunction +getFunctionName +getLineNumber +getMethodName +getPosition +getPromiseIndex +getScriptHash +getScriptNameOrSourceURL +getThis +getTypeName +isAsync +isConstructor +isEval +isNative +isPromiseAll +isToplevel +toString +

      Methods

      getColumnNumber

      • getColumnNumber(): null | number

      • Current column number [if this function was defined in a script]

        +

        Returns null | number

      getEnclosingColumnNumber

      • getEnclosingColumnNumber(): number

      • Returns number

      getEnclosingLineNumber

      • getEnclosingLineNumber(): number

      • Returns number

      getEvalOrigin

      • getEvalOrigin(): undefined | string

      • A call site object representing the location where eval was called [if this function was created using a call to eval]

        -

        Returns undefined | string

      getFileName

      • getFileName(): undefined | string

      • Name of the script [if this function was defined in a script]

        -

        Returns undefined | string

      getFunction

      • getFunction(): undefined | Function

      • Current function

        -

        Returns undefined | Function

      getFunctionName

      • getFunctionName(): null | string

      • Name of the current function, typically its name property. +

        Returns undefined | string

      getFileName

      • getFileName(): undefined | string

      • Name of the script [if this function was defined in a script]

        +

        Returns undefined | string

      getFunction

      • getFunction(): undefined | Function

      • Current function

        +

        Returns undefined | Function

      getFunctionName

      • getFunctionName(): null | string

      • Name of the current function, typically its name property. If a name property is not available an attempt will be made to try to infer a name from the function's context.

        -

        Returns null | string

      getLineNumber

      • getLineNumber(): null | number

      • Current line number [if this function was defined in a script]

        -

        Returns null | number

      getMethodName

      • getMethodName(): null | string

      • Name of the property [of "this" or one of its prototypes] that holds +

        Returns null | string

      getLineNumber

      • getLineNumber(): null | number

      • Current line number [if this function was defined in a script]

        +

        Returns null | number

      getMethodName

      • getMethodName(): null | string

      • Name of the property [of "this" or one of its prototypes] that holds the current function

        -

        Returns null | string

      getPosition

      • getPosition(): number

      • Returns number

      getPromiseIndex

      • getPromiseIndex(): null | number

      • returns the index of the promise element that was followed in +

        Returns null | string

      getPosition

      • getPosition(): number

      • Returns number

      getPromiseIndex

      • getPromiseIndex(): null | number

      • returns the index of the promise element that was followed in Promise.all() or Promise.any() for async stack traces, or null if the CallSite is not an async

        -

        Returns null | number

      getScriptHash

      • getScriptHash(): string

      • Returns string

      getScriptNameOrSourceURL

      • getScriptNameOrSourceURL(): string

      • Returns string

      getThis

      • getThis(): unknown

      • Value of "this"

        -

        Returns unknown

      getTypeName

      • getTypeName(): null | string

      • Type of "this" as a string. +

        Returns null | number

      getScriptHash

      • getScriptHash(): string

      • Returns string

      getScriptNameOrSourceURL

      • getScriptNameOrSourceURL(): string

      • Returns string

      getThis

      • getThis(): unknown

      • Value of "this"

        +

        Returns unknown

      getTypeName

      • getTypeName(): null | string

      • Type of "this" as a string. This is the name of the function stored in the constructor field of "this", if available. Otherwise the object's [[Class]] internal property.

        -

        Returns null | string

      isAsync

      • isAsync(): boolean

      • is this an async call (i.e. await, Promise.all(), or Promise.any())?

        -

        Returns boolean

      isConstructor

      • isConstructor(): boolean

      • Is this a constructor call?

        -

        Returns boolean

      isEval

      • isEval(): boolean

      • Does this call take place in code defined by a call to eval?

        -

        Returns boolean

      isNative

      • isNative(): boolean

      • Is this call in native V8 code?

        -

        Returns boolean

      isPromiseAll

      • isPromiseAll(): boolean

      • is this an async call to Promise.all()?

        -

        Returns boolean

      isToplevel

      • isToplevel(): boolean

      • Is this a toplevel invocation, that is, is "this" the global object?

        -

        Returns boolean

      toString

      • toString(): string

      • Returns string

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

      Returns null | string

    isAsync

    • isAsync(): boolean

    • is this an async call (i.e. await, Promise.all(), or Promise.any())?

      +

      Returns boolean

    isConstructor

    • isConstructor(): boolean

    • Is this a constructor call?

      +

      Returns boolean

    isEval

    • isEval(): boolean

    • Does this call take place in code defined by a call to eval?

      +

      Returns boolean

    isNative

    • isNative(): boolean

    • Is this call in native V8 code?

      +

      Returns boolean

    isPromiseAll

    • isPromiseAll(): boolean

    • is this an async call to Promise.all()?

      +

      Returns boolean

    isToplevel

    • isToplevel(): boolean

    • Is this a toplevel invocation, that is, is "this" the global object?

      +

      Returns boolean

    toString

    • toString(): string

    • Returns string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.CipherSuiteParams.html b/interfaces/_divviup_dap._internal_.CipherSuiteParams.html index 0d7865f36..0897ee7b4 100644 --- a/interfaces/_divviup_dap._internal_.CipherSuiteParams.html +++ b/interfaces/_divviup_dap._internal_.CipherSuiteParams.html @@ -1,8 +1,8 @@ -CipherSuiteParams | Documentation

    Interface CipherSuiteParams

    The parameters used to configure the CipherSuite.

    -
    interface CipherSuiteParams {
        aead: AeadId | AeadInterface;
        kdf: KdfId | KdfInterface;
        kem: KemId | KemInterface;
    }

    Properties

    aead -kdf -kem -

    Properties

    aead

    aead: AeadId | AeadInterface

    The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.

    -

    kdf

    kdf: KdfId | KdfInterface

    The KDF (Key Derivation Function) identifier or the KDF object.

    -

    kem

    kem: KemId | KemInterface

    The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +CipherSuiteParams | Documentation

    Interface CipherSuiteParams

    The parameters used to configure the CipherSuite.

    +
    interface CipherSuiteParams {
        aead: AeadId | AeadInterface;
        kdf: KdfId | KdfInterface;
        kem: KemId | KemInterface;
    }

    Properties

    aead +kdf +kem +

    Properties

    aead

    aead: AeadId | AeadInterface

    The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.

    +

    kdf

    kdf: KdfId | KdfInterface

    The KDF (Key Derivation Function) identifier or the KDF object.

    +

    kem

    kem: KemId | KemInterface

    The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.CipherSuiteSealResponse.html b/interfaces/_divviup_dap._internal_.CipherSuiteSealResponse.html index 983ce7fcc..fbf328996 100644 --- a/interfaces/_divviup_dap._internal_.CipherSuiteSealResponse.html +++ b/interfaces/_divviup_dap._internal_.CipherSuiteSealResponse.html @@ -1,6 +1,6 @@ -CipherSuiteSealResponse | Documentation

    Interface CipherSuiteSealResponse

    The response of the single-shot seal API.

    -
    interface CipherSuiteSealResponse {
        ct: ArrayBuffer;
        enc: ArrayBuffer;
    }

    Properties

    ct -enc -

    Properties

    ct

    ct: ArrayBuffer

    The ciphertext as bytes.

    -

    enc

    enc: ArrayBuffer

    The encapsulated key.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +CipherSuiteSealResponse | Documentation

    Interface CipherSuiteSealResponse

    The response of the single-shot seal API.

    +
    interface CipherSuiteSealResponse {
        ct: ArrayBuffer;
        enc: ArrayBuffer;
    }

    Properties

    ct +enc +

    Properties

    ct

    ct: ArrayBuffer

    The ciphertext as bytes.

    +

    enc

    enc: ArrayBuffer

    The encapsulated key.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.ClientParameters.html b/interfaces/_divviup_dap._internal_.ClientParameters.html index c426f0530..857b9215e 100644 --- a/interfaces/_divviup_dap._internal_.ClientParameters.html +++ b/interfaces/_divviup_dap._internal_.ClientParameters.html @@ -1,17 +1,17 @@ -ClientParameters | Documentation

    Interface ClientParameters

    Parameters from which to build a Task

    +ClientParameters | Documentation

    Interface ClientParameters

    Parameters from which to build a Task

    Type Param: Measurement

    The Measurement for the provided vdaf, usually inferred from the vdaf.

    -
    interface ClientParameters {
        helper: string | URL;
        id: string | Buffer | TaskId;
        leader: string | URL;
        timePrecisionSeconds: number;
    }

    Properties

    helper -id -leader -timePrecisionSeconds -

    Properties

    helper

    helper: string | URL

    the url of the helper aggregator, specified as either a string or +

    interface ClientParameters {
        helper: string | URL;
        id: string | Buffer | TaskId;
        leader: string | URL;
        timePrecisionSeconds: number;
    }

    Properties

    helper +id +leader +timePrecisionSeconds +

    Properties

    helper

    helper: string | URL

    the url of the helper aggregator, specified as either a string or URLs.

    -

    id

    id: string | Buffer | TaskId

    The task identifier for this Task. This can be specified +

    id

    id: string | Buffer | TaskId

    The task identifier for this Task. This can be specified either as a Buffer, a TaskId or a base64url-encoded string *

    -

    leader

    leader: string | URL

    the url of the leader aggregator, specified as either a string +

    leader

    leader: string | URL

    the url of the leader aggregator, specified as either a string or a URL

    -

    timePrecisionSeconds

    timePrecisionSeconds: number

    The task's minimum batch duration, in seconds. Report timestamps will be +

    timePrecisionSeconds

    timePrecisionSeconds: number

    The task's minimum batch duration, in seconds. Report timestamps will be rounded down to a multiple of this.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.ClientVdaf.html b/interfaces/_divviup_dap._internal_.ClientVdaf.html index e5408f56e..f6a92d2d0 100644 --- a/interfaces/_divviup_dap._internal_.ClientVdaf.html +++ b/interfaces/_divviup_dap._internal_.ClientVdaf.html @@ -1,6 +1,6 @@ -ClientVdaf | Documentation

    Interface ClientVdaf<Measurement>

    interface ClientVdaf<Measurement> {
        nonceSize: number;
        randSize: number;
        rounds: number;
        shares: number;
        shardEncoded(measurement, nonce, rand): Promise<{
            inputShares: Buffer[];
            publicShare: Buffer;
        }>;
    }

    Type Parameters

    • Measurement

    Properties

    nonceSize -randSize -rounds -shares -

    Methods

    shardEncoded -

    Properties

    nonceSize

    nonceSize: number

    randSize

    randSize: number

    rounds

    rounds: number

    shares

    shares: number

    Methods

    shardEncoded

    • shardEncoded(measurement, nonce, rand): Promise<{
          inputShares: Buffer[];
          publicShare: Buffer;
      }>

    • Parameters

      Returns Promise<{
          inputShares: Buffer[];
          publicShare: Buffer;
      }>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +ClientVdaf | Documentation

    Interface ClientVdaf<Measurement>

    interface ClientVdaf<Measurement> {
        nonceSize: number;
        randSize: number;
        rounds: number;
        shares: number;
        shardEncoded(measurement, nonce, rand): Promise<{
            inputShares: Buffer[];
            publicShare: Buffer;
        }>;
    }

    Type Parameters

    • Measurement

    Properties

    nonceSize +randSize +rounds +shares +

    Methods

    shardEncoded +

    Properties

    nonceSize

    nonceSize: number

    randSize

    randSize: number

    rounds

    rounds: number

    shares

    shares: number

    Methods

    shardEncoded

    • shardEncoded(measurement, nonce, rand): Promise<{
          inputShares: Buffer[];
          publicShare: Buffer;
      }>

    • Parameters

      Returns Promise<{
          inputShares: Buffer[];
          publicShare: Buffer;
      }>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.CryptoKey.html b/interfaces/_divviup_dap._internal_.CryptoKey.html index de9849f6c..fd5519e67 100644 --- a/interfaces/_divviup_dap._internal_.CryptoKey.html +++ b/interfaces/_divviup_dap._internal_.CryptoKey.html @@ -1,12 +1,12 @@ -CryptoKey | Documentation

    Interface CryptoKey

    The CryptoKey dictionary of the Web Crypto API represents a cryptographic key. +CryptoKey | Documentation

    Interface CryptoKey

    The CryptoKey dictionary of the Web Crypto API represents a cryptographic key. Available only in secure contexts.

    MDN Reference

    -
    interface CryptoKey {
        algorithm: KeyAlgorithm;
        extractable: boolean;
        type: KeyType;
        usages: KeyUsage[];
    }

    Properties

    algorithm -extractable -type -usages -

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    MDN Reference

    -

    Readonly extractable

    extractable: boolean

    MDN Reference

    -

    Readonly type

    type: KeyType

    MDN Reference

    -

    Readonly usages

    usages: KeyUsage[]

    MDN Reference

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface CryptoKey {
        algorithm: KeyAlgorithm;
        extractable: boolean;
        type: KeyType;
        usages: KeyUsage[];
    }

    Properties

    algorithm +extractable +type +usages +

    Properties

    Readonly algorithm

    algorithm: KeyAlgorithm

    MDN Reference

    +

    Readonly extractable

    extractable: boolean

    MDN Reference

    +

    Readonly type

    type: KeyType

    MDN Reference

    +

    Readonly usages

    usages: KeyUsage[]

    MDN Reference

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.CryptoKeyPair.html b/interfaces/_divviup_dap._internal_.CryptoKeyPair.html index cf2bcdfc6..a4d54f2ee 100644 --- a/interfaces/_divviup_dap._internal_.CryptoKeyPair.html +++ b/interfaces/_divviup_dap._internal_.CryptoKeyPair.html @@ -1,3 +1,3 @@ -CryptoKeyPair | Documentation

    Interface CryptoKeyPair

    interface CryptoKeyPair {
        privateKey: CryptoKey;
        publicKey: CryptoKey;
    }

    Properties

    privateKey -publicKey -

    Properties

    privateKey

    privateKey: CryptoKey

    publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +CryptoKeyPair | Documentation

    Interface CryptoKeyPair

    interface CryptoKeyPair {
        privateKey: CryptoKey;
        publicKey: CryptoKey;
    }

    Properties

    privateKey +publicKey +

    Properties

    privateKey

    privateKey: CryptoKey

    publicKey

    publicKey: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.EcKeyGenParams.html b/interfaces/_divviup_dap._internal_.EcKeyGenParams.html index 7eaa8a901..a55a4ec56 100644 --- a/interfaces/_divviup_dap._internal_.EcKeyGenParams.html +++ b/interfaces/_divviup_dap._internal_.EcKeyGenParams.html @@ -1,3 +1,3 @@ -EcKeyGenParams | Documentation

    Interface EcKeyGenParams

    interface EcKeyGenParams {
        name: string;
        namedCurve: string;
    }

    Hierarchy (view full)

    Properties

    name -namedCurve -

    Properties

    name

    name: string

    namedCurve

    namedCurve: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +EcKeyGenParams | Documentation

    Interface EcKeyGenParams

    interface EcKeyGenParams {
        name: string;
        namedCurve: string;
    }

    Hierarchy (view full)

    Properties

    name +namedCurve +

    Properties

    name

    name: string

    namedCurve

    namedCurve: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.EcKeyImportParams.html b/interfaces/_divviup_dap._internal_.EcKeyImportParams.html index 52aa6c904..b3fe1cf54 100644 --- a/interfaces/_divviup_dap._internal_.EcKeyImportParams.html +++ b/interfaces/_divviup_dap._internal_.EcKeyImportParams.html @@ -1,3 +1,3 @@ -EcKeyImportParams | Documentation

    Interface EcKeyImportParams

    interface EcKeyImportParams {
        name: string;
        namedCurve: string;
    }

    Hierarchy (view full)

    Properties

    name -namedCurve -

    Properties

    name

    name: string

    namedCurve

    namedCurve: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +EcKeyImportParams | Documentation

    Interface EcKeyImportParams

    interface EcKeyImportParams {
        name: string;
        namedCurve: string;
    }

    Hierarchy (view full)

    Properties

    name +namedCurve +

    Properties

    name

    name: string

    namedCurve

    namedCurve: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.EcdhKeyDeriveParams.html b/interfaces/_divviup_dap._internal_.EcdhKeyDeriveParams.html index 88a33aaf8..30b9928d4 100644 --- a/interfaces/_divviup_dap._internal_.EcdhKeyDeriveParams.html +++ b/interfaces/_divviup_dap._internal_.EcdhKeyDeriveParams.html @@ -1,3 +1,3 @@ -EcdhKeyDeriveParams | Documentation

    Interface EcdhKeyDeriveParams

    interface EcdhKeyDeriveParams {
        name: string;
        public: CryptoKey;
    }

    Hierarchy (view full)

    Properties

    name -public -

    Properties

    name

    name: string

    public

    public: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +EcdhKeyDeriveParams | Documentation

    Interface EcdhKeyDeriveParams

    interface EcdhKeyDeriveParams {
        name: string;
        public: CryptoKey;
    }

    Hierarchy (view full)

    Properties

    name +public +

    Properties

    name

    name: string

    public

    public: CryptoKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.EcdsaParams.html b/interfaces/_divviup_dap._internal_.EcdsaParams.html index 2eefb2bd6..02c764eb7 100644 --- a/interfaces/_divviup_dap._internal_.EcdsaParams.html +++ b/interfaces/_divviup_dap._internal_.EcdsaParams.html @@ -1,3 +1,3 @@ -EcdsaParams | Documentation

    Interface EcdsaParams

    interface EcdsaParams {
        hash: AlgorithmIdentifier;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash -name -

    Properties

    hash

    hash: AlgorithmIdentifier

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +EcdsaParams | Documentation

    Interface EcdsaParams

    interface EcdsaParams {
        hash: AlgorithmIdentifier;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash +name +

    Properties

    hash

    hash: AlgorithmIdentifier

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Encodable.html b/interfaces/_divviup_dap._internal_.Encodable.html index 5ec64f595..2a420ce30 100644 --- a/interfaces/_divviup_dap._internal_.Encodable.html +++ b/interfaces/_divviup_dap._internal_.Encodable.html @@ -1,2 +1,2 @@ -Encodable | Documentation

    Interface Encodable

    interface Encodable {
        encode(): Buffer;
    }

    Implemented by

    Methods

    encode -

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Encodable | Documentation

    Interface Encodable

    interface Encodable {
        encode(): Buffer;
    }

    Implemented by

    Methods

    encode +

    Methods

    encode

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.EncryptionContext.html b/interfaces/_divviup_dap._internal_.EncryptionContext.html index d60e00586..ba44b89a0 100644 --- a/interfaces/_divviup_dap._internal_.EncryptionContext.html +++ b/interfaces/_divviup_dap._internal_.EncryptionContext.html @@ -1,23 +1,23 @@ -EncryptionContext | Documentation

    Interface EncryptionContext

    The encryption context interface for a recipient and a sender.

    -
    interface EncryptionContext {
        export(exporterContext, len): Promise<ArrayBuffer>;
        open(data, aad?): Promise<ArrayBuffer>;
        seal(data, aad?): Promise<ArrayBuffer>;
    }

    Hierarchy (view full)

    Methods

    export -open -seal -

    Methods

    export

    • export(exporterContext, len): Promise<ArrayBuffer>

    • Exports a secret using a variable-length pseudorandom function.

      +EncryptionContext | Documentation

      Interface EncryptionContext

      The encryption context interface for a recipient and a sender.

      +
      interface EncryptionContext {
          export(exporterContext, len): Promise<ArrayBuffer>;
          open(data, aad?): Promise<ArrayBuffer>;
          seal(data, aad?): Promise<ArrayBuffer>;
      }

      Hierarchy (view full)

      Methods

      export +open +seal +

      Methods

      export

      • export(exporterContext, len): Promise<ArrayBuffer>

      • Exports a secret using a variable-length pseudorandom function.

        If the error occurred, throws ExportError.

        Parameters

        • exporterContext: ArrayBuffer

          An exporter context string as bytes. The maximum length is 128 bytes.

        • len: number

          A desired length in bytes of the output secret.

        Returns Promise<ArrayBuffer>

        A secret string as bytes.

        Throws

        ExportError

        -

      open

      • open(data, aad?): Promise<ArrayBuffer>

      • Decrypts data.

        +

      open

      • open(data, aad?): Promise<ArrayBuffer>

      • Decrypts data.

        If the error occurred, throws OpenError.

        Parameters

        • data: ArrayBuffer

          An encrypted text as bytes to be decrypted.

        • Optional aad: ArrayBuffer

          Additional authenticated data as bytes fed by an application.

        Returns Promise<ArrayBuffer>

        A decrypted plain text as bytes.

        Throws

        OpenError

        -

      seal

      • seal(data, aad?): Promise<ArrayBuffer>

      • Encrypts data.

        +

      seal

      • seal(data, aad?): Promise<ArrayBuffer>

      • Encrypts data.

        If the error occurred, throws SealError | MessageLimitReachedError.

        Parameters

        • data: ArrayBuffer

          A plain text as bytes to be encrypted.

        • Optional aad: ArrayBuffer

          Additional authenticated data as bytes fed by an application.

        Returns Promise<ArrayBuffer>

        A cipher text as bytes.

        Throws

        MessageLimitReachedError, SealError

        -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Error.html b/interfaces/_divviup_dap._internal_.Error.html index 01072cc35..d2b2543f5 100644 --- a/interfaces/_divviup_dap._internal_.Error.html +++ b/interfaces/_divviup_dap._internal_.Error.html @@ -1,4 +1,4 @@ -Error | Documentation

    Interface Error

    interface Error {
        message: string;
        name: string;
        stack?: string;
    }

    Hierarchy (view full)

    Properties

    message -name -stack? -

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Error | Documentation

    Interface Error

    interface Error {
        message: string;
        name: string;
        stack?: string;
    }

    Hierarchy (view full)

    Properties

    message +name +stack? +

    Properties

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Exporter.html b/interfaces/_divviup_dap._internal_.Exporter.html index 131ac9cef..8580595a4 100644 --- a/interfaces/_divviup_dap._internal_.Exporter.html +++ b/interfaces/_divviup_dap._internal_.Exporter.html @@ -1,9 +1,9 @@ -Exporter | Documentation

    Interface Exporter

    The exporter interface.

    -
    interface Exporter {
        export(exporterContext, len): Promise<ArrayBuffer>;
    }

    Hierarchy (view full)

    Methods

    export -

    Methods

    export

    • export(exporterContext, len): Promise<ArrayBuffer>

    • Exports a secret using a variable-length pseudorandom function.

      +Exporter | Documentation

      Interface Exporter

      The exporter interface.

      +
      interface Exporter {
          export(exporterContext, len): Promise<ArrayBuffer>;
      }

      Hierarchy (view full)

      Methods

      export +

      Methods

      export

      • export(exporterContext, len): Promise<ArrayBuffer>

      • Exports a secret using a variable-length pseudorandom function.

        If the error occurred, throws ExportError.

        Parameters

        • exporterContext: ArrayBuffer

          An exporter context string as bytes. The maximum length is 128 bytes.

        • len: number

          A desired length in bytes of the output secret.

        Returns Promise<ArrayBuffer>

        A secret string as bytes.

        Throws

        ExportError

        -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.FieldConstructorArgs.html b/interfaces/_divviup_dap._internal_.FieldConstructorArgs.html index 38a7c8063..1e4456a11 100644 --- a/interfaces/_divviup_dap._internal_.FieldConstructorArgs.html +++ b/interfaces/_divviup_dap._internal_.FieldConstructorArgs.html @@ -1,5 +1,5 @@ -FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize -genOrder -generator -modulus -

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize +genOrder +generator +modulus +

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Flp.html b/interfaces/_divviup_dap._internal_.Flp.html index 12830b05a..4851e8409 100644 --- a/interfaces/_divviup_dap._internal_.Flp.html +++ b/interfaces/_divviup_dap._internal_.Flp.html @@ -1,15 +1,15 @@ -Flp | Documentation

    Interface Flp<Measurement, AggResult>

    interface Flp<Measurement, AggResult> {
        field: Field;
        jointRandLen: number;
        measurementLen: number;
        outputLen: number;
        proofLen: number;
        proveRandLen: number;
        queryRandLen: number;
        verifierLen: number;
        decide(verifier): boolean;
        decode(output, numMeasurements): AggResult;
        encode(measurement): bigint[];
        prove(encodedMeasurement, proveRand, jointRand): bigint[];
        query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[];
        truncate(encodedMeasurement): bigint[];
    }

    Type Parameters

    • Measurement
    • AggResult

    Properties

    field -jointRandLen -measurementLen -outputLen -proofLen -proveRandLen -queryRandLen -verifierLen -

    Methods

    decide -decode -encode -prove -query -truncate -

    Properties

    field

    field: Field

    jointRandLen

    jointRandLen: number

    measurementLen

    measurementLen: number

    outputLen

    outputLen: number

    proofLen

    proofLen: number

    proveRandLen

    proveRandLen: number

    queryRandLen

    queryRandLen: number

    verifierLen

    verifierLen: number

    Methods

    decide

    • decide(verifier): boolean

    • Parameters

      • verifier: bigint[]

      Returns boolean

    decode

    • decode(output, numMeasurements): AggResult

    • Parameters

      • output: bigint[]
      • numMeasurements: number

      Returns AggResult

    encode

    • encode(measurement): bigint[]

    • Parameters

      Returns bigint[]

    prove

    • prove(encodedMeasurement, proveRand, jointRand): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proveRand: bigint[]
      • jointRand: bigint[]

      Returns bigint[]

    query

    • query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proof: bigint[]
      • queryRand: bigint[]
      • jointRand: bigint[]
      • shares: number

      Returns bigint[]

    truncate

    • truncate(encodedMeasurement): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]

      Returns bigint[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Flp | Documentation

    Interface Flp<Measurement, AggResult>

    interface Flp<Measurement, AggResult> {
        field: Field;
        jointRandLen: number;
        measurementLen: number;
        outputLen: number;
        proofLen: number;
        proveRandLen: number;
        queryRandLen: number;
        verifierLen: number;
        decide(verifier): boolean;
        decode(output, numMeasurements): AggResult;
        encode(measurement): bigint[];
        prove(encodedMeasurement, proveRand, jointRand): bigint[];
        query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[];
        truncate(encodedMeasurement): bigint[];
    }

    Type Parameters

    • Measurement
    • AggResult

    Properties

    field +jointRandLen +measurementLen +outputLen +proofLen +proveRandLen +queryRandLen +verifierLen +

    Methods

    decide +decode +encode +prove +query +truncate +

    Properties

    field

    field: Field

    jointRandLen

    jointRandLen: number

    measurementLen

    measurementLen: number

    outputLen

    outputLen: number

    proofLen

    proofLen: number

    proveRandLen

    proveRandLen: number

    queryRandLen

    queryRandLen: number

    verifierLen

    verifierLen: number

    Methods

    decide

    • decide(verifier): boolean

    • Parameters

      • verifier: bigint[]

      Returns boolean

    decode

    • decode(output, numMeasurements): AggResult

    • Parameters

      • output: bigint[]
      • numMeasurements: number

      Returns AggResult

    encode

    • encode(measurement): bigint[]

    • Parameters

      Returns bigint[]

    prove

    • prove(encodedMeasurement, proveRand, jointRand): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proveRand: bigint[]
      • jointRand: bigint[]

      Returns bigint[]

    query

    • query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proof: bigint[]
      • queryRand: bigint[]
      • jointRand: bigint[]
      • shares: number

      Returns bigint[]

    truncate

    • truncate(encodedMeasurement): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]

      Returns bigint[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.HistogramArgs.html b/interfaces/_divviup_dap._internal_.HistogramArgs.html index 4a8f8b1c0..e3cb87d42 100644 --- a/interfaces/_divviup_dap._internal_.HistogramArgs.html +++ b/interfaces/_divviup_dap._internal_.HistogramArgs.html @@ -1,4 +1,4 @@ -HistogramArgs | Documentation

    Interface HistogramArgs

    interface HistogramArgs {
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    chunkLength -length -shares -

    Properties

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +HistogramArgs | Documentation

    Interface HistogramArgs

    interface HistogramArgs {
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    chunkLength +length +shares +

    Properties

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.HkdfParams.html b/interfaces/_divviup_dap._internal_.HkdfParams.html index 731a96428..bbba8ea92 100644 --- a/interfaces/_divviup_dap._internal_.HkdfParams.html +++ b/interfaces/_divviup_dap._internal_.HkdfParams.html @@ -1,5 +1,5 @@ -HkdfParams | Documentation

    Interface HkdfParams

    interface HkdfParams {
        hash: AlgorithmIdentifier;
        info: BufferSource;
        name: string;
        salt: BufferSource;
    }

    Hierarchy (view full)

    Properties

    hash -info -name -salt -

    Properties

    hash

    hash: AlgorithmIdentifier

    info

    info: BufferSource

    name

    name: string

    salt

    salt: BufferSource

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +HkdfParams | Documentation

    Interface HkdfParams

    interface HkdfParams {
        hash: AlgorithmIdentifier;
        info: BufferSource;
        name: string;
        salt: BufferSource;
    }

    Hierarchy (view full)

    Properties

    hash +info +name +salt +

    Properties

    hash

    hash: AlgorithmIdentifier

    info

    info: BufferSource

    name

    name: string

    salt

    salt: BufferSource

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.HmacImportParams.html b/interfaces/_divviup_dap._internal_.HmacImportParams.html index 2c1303136..d50de5087 100644 --- a/interfaces/_divviup_dap._internal_.HmacImportParams.html +++ b/interfaces/_divviup_dap._internal_.HmacImportParams.html @@ -1,4 +1,4 @@ -HmacImportParams | Documentation

    Interface HmacImportParams

    interface HmacImportParams {
        hash: AlgorithmIdentifier;
        length?: number;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash -length? -name -

    Properties

    hash

    hash: AlgorithmIdentifier

    Optional length

    length?: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +HmacImportParams | Documentation

    Interface HmacImportParams

    interface HmacImportParams {
        hash: AlgorithmIdentifier;
        length?: number;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash +length? +name +

    Properties

    hash

    hash: AlgorithmIdentifier

    Optional length

    length?: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.HmacKeyGenParams.html b/interfaces/_divviup_dap._internal_.HmacKeyGenParams.html index e3c2d8f64..7ba659546 100644 --- a/interfaces/_divviup_dap._internal_.HmacKeyGenParams.html +++ b/interfaces/_divviup_dap._internal_.HmacKeyGenParams.html @@ -1,4 +1,4 @@ -HmacKeyGenParams | Documentation

    Interface HmacKeyGenParams

    interface HmacKeyGenParams {
        hash: AlgorithmIdentifier;
        length?: number;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash -length? -name -

    Properties

    hash

    hash: AlgorithmIdentifier

    Optional length

    length?: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +HmacKeyGenParams | Documentation

    Interface HmacKeyGenParams

    interface HmacKeyGenParams {
        hash: AlgorithmIdentifier;
        length?: number;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash +length? +name +

    Properties

    hash

    hash: AlgorithmIdentifier

    Optional length

    length?: number

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.IterableIterator.html b/interfaces/_divviup_dap._internal_.IterableIterator.html index 505e90220..116650123 100644 --- a/interfaces/_divviup_dap._internal_.IterableIterator.html +++ b/interfaces/_divviup_dap._internal_.IterableIterator.html @@ -1,5 +1,5 @@ -IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] -next -return? -throw? -

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] +next +return? +throw? +

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Iterator.html b/interfaces/_divviup_dap._internal_.Iterator.html index 24898d5f6..9e6173f39 100644 --- a/interfaces/_divviup_dap._internal_.Iterator.html +++ b/interfaces/_divviup_dap._internal_.Iterator.html @@ -1,4 +1,4 @@ -Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next -return? -throw? -

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next +return? +throw? +

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.IteratorReturnResult.html b/interfaces/_divviup_dap._internal_.IteratorReturnResult.html index 01fa2f604..48414c08f 100644 --- a/interfaces/_divviup_dap._internal_.IteratorReturnResult.html +++ b/interfaces/_divviup_dap._internal_.IteratorReturnResult.html @@ -1,3 +1,3 @@ -IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done -value -

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done +value +

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.IteratorYieldResult.html b/interfaces/_divviup_dap._internal_.IteratorYieldResult.html index cc9ca8922..cdf303bb8 100644 --- a/interfaces/_divviup_dap._internal_.IteratorYieldResult.html +++ b/interfaces/_divviup_dap._internal_.IteratorYieldResult.html @@ -1,3 +1,3 @@ -IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? -value -

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? +value +

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.JsonWebKey.html b/interfaces/_divviup_dap._internal_.JsonWebKey.html index 2d60cb4d9..5a149a57c 100644 --- a/interfaces/_divviup_dap._internal_.JsonWebKey.html +++ b/interfaces/_divviup_dap._internal_.JsonWebKey.html @@ -1,19 +1,19 @@ -JsonWebKey | Documentation

    Interface JsonWebKey

    interface JsonWebKey {
        alg?: string;
        crv?: string;
        d?: string;
        dp?: string;
        dq?: string;
        e?: string;
        ext?: boolean;
        k?: string;
        key_ops?: string[];
        kty?: string;
        n?: string;
        oth?: RsaOtherPrimesInfo[];
        p?: string;
        q?: string;
        qi?: string;
        use?: string;
        x?: string;
        y?: string;
    }

    Properties

    alg? -crv? -d? -dp? -dq? -e? -ext? -k? -key_ops? -kty? -n? -oth? -p? -q? -qi? -use? -x? -y? -

    Properties

    Optional alg

    alg?: string

    Optional crv

    crv?: string

    Optional d

    d?: string

    Optional dp

    dp?: string

    Optional dq

    dq?: string

    Optional e

    e?: string

    Optional ext

    ext?: boolean

    Optional k

    k?: string

    Optional key_ops

    key_ops?: string[]

    Optional kty

    kty?: string

    Optional n

    n?: string

    Optional oth

    oth?: RsaOtherPrimesInfo[]

    Optional p

    p?: string

    Optional q

    q?: string

    Optional qi

    qi?: string

    Optional use

    use?: string

    Optional x

    x?: string

    Optional y

    y?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +JsonWebKey | Documentation

    Interface JsonWebKey

    interface JsonWebKey {
        alg?: string;
        crv?: string;
        d?: string;
        dp?: string;
        dq?: string;
        e?: string;
        ext?: boolean;
        k?: string;
        key_ops?: string[];
        kty?: string;
        n?: string;
        oth?: RsaOtherPrimesInfo[];
        p?: string;
        q?: string;
        qi?: string;
        use?: string;
        x?: string;
        y?: string;
    }

    Properties

    alg? +crv? +d? +dp? +dq? +e? +ext? +k? +key_ops? +kty? +n? +oth? +p? +q? +qi? +use? +x? +y? +

    Properties

    Optional alg

    alg?: string

    Optional crv

    crv?: string

    Optional d

    d?: string

    Optional dp

    dp?: string

    Optional dq

    dq?: string

    Optional e

    e?: string

    Optional ext

    ext?: boolean

    Optional k

    k?: string

    Optional key_ops

    key_ops?: string[]

    Optional kty

    kty?: string

    Optional n

    n?: string

    Optional oth

    oth?: RsaOtherPrimesInfo[]

    Optional p

    p?: string

    Optional q

    q?: string

    Optional qi

    qi?: string

    Optional use

    use?: string

    Optional x

    x?: string

    Optional y

    y?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.KdfInterface.html b/interfaces/_divviup_dap._internal_.KdfInterface.html index 7099e9fac..12f8d6d9f 100644 --- a/interfaces/_divviup_dap._internal_.KdfInterface.html +++ b/interfaces/_divviup_dap._internal_.KdfInterface.html @@ -1,50 +1,50 @@ -KdfInterface | Documentation

    Interface KdfInterface

    The KDF interface.

    -
    interface KdfInterface {
        hashSize: number;
        id: KdfId;
        buildLabeledIkm(label, ikm): Uint8Array;
        buildLabeledInfo(label, info, len): Uint8Array;
        expand(prk, info, len): Promise<ArrayBuffer>;
        extract(salt, ikm): Promise<ArrayBuffer>;
        extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>;
        init(suiteId): void;
        labeledExpand(prk, label, info, len): Promise<ArrayBuffer>;
        labeledExtract(salt, label, ikm): Promise<ArrayBuffer>;
    }

    Properties

    hashSize -id -

    Methods

    buildLabeledIkm -buildLabeledInfo -expand -extract -extractAndExpand -init -labeledExpand -labeledExtract -

    Properties

    Readonly hashSize

    hashSize: number

    The output size of the extract() function in bytes (Nh).

    -

    Readonly id

    id: KdfId

    The KDF identifier.

    -

    Methods

    buildLabeledIkm

    • buildLabeledIkm(label, ikm): Uint8Array

    • Builds a labeled input keying material.

      +KdfInterface | Documentation

      Interface KdfInterface

      The KDF interface.

      +
      interface KdfInterface {
          hashSize: number;
          id: KdfId;
          buildLabeledIkm(label, ikm): Uint8Array;
          buildLabeledInfo(label, info, len): Uint8Array;
          expand(prk, info, len): Promise<ArrayBuffer>;
          extract(salt, ikm): Promise<ArrayBuffer>;
          extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>;
          init(suiteId): void;
          labeledExpand(prk, label, info, len): Promise<ArrayBuffer>;
          labeledExtract(salt, label, ikm): Promise<ArrayBuffer>;
      }

      Properties

      hashSize +id +

      Methods

      buildLabeledIkm +buildLabeledInfo +expand +extract +extractAndExpand +init +labeledExpand +labeledExtract +

      Properties

      Readonly hashSize

      hashSize: number

      The output size of the extract() function in bytes (Nh).

      +

      Readonly id

      id: KdfId

      The KDF identifier.

      +

      Methods

      buildLabeledIkm

      • buildLabeledIkm(label, ikm): Uint8Array

      • Builds a labeled input keying material.

        Parameters

        • label: Uint8Array

          A byte string indicating the cryptographic context/operation.

        • ikm: Uint8Array

        Returns Uint8Array

        An input keying material as bytes.

        -

      buildLabeledInfo

      • buildLabeledInfo(label, info, len): Uint8Array

      • Builds a labeled info string.

        +

      buildLabeledInfo

      • buildLabeledInfo(label, info, len): Uint8Array

      • Builds a labeled info string.

        Parameters

        • label: Uint8Array

          A byte string indicating the cryptographic context/operation.

        • info: Uint8Array

          An additional byte string.

        • len: number

          The length of the output byte string.

        Returns Uint8Array

        An info string as bytes.

        -

      expand

      • expand(prk, info, len): Promise<ArrayBuffer>

      • Expands a pseudorandom key prk.

        +

      expand

      • expand(prk, info, len): Promise<ArrayBuffer>

      • Expands a pseudorandom key prk.

        Parameters

        • prk: ArrayBuffer

          A pseudorandom key.

        • info: ArrayBuffer

          An additional byte string.

        • len: number

          The length in bytes of the output keying material.

        Returns Promise<ArrayBuffer>

        An output keying material as bytes.

        -

      extract

      • extract(salt, ikm): Promise<ArrayBuffer>

      • Extracts a pseudorandom key of fixed length (Nh) bytes.

        +

      extract

      • extract(salt, ikm): Promise<ArrayBuffer>

      • Extracts a pseudorandom key of fixed length (Nh) bytes.

        Parameters

        • salt: ArrayBuffer

          An additional random byte string.

        • ikm: ArrayBuffer

          An input keying material

        Returns Promise<ArrayBuffer>

        A pseudorandom key as bytes.

        -

      extractAndExpand

      • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

      • Extracts a pseudorandom key and expand it to a specified length keying material.

        +

      extractAndExpand

      • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

      • Extracts a pseudorandom key and expand it to a specified length keying material.

        Parameters

        • salt: ArrayBuffer

          An additional random byte string.

        • ikm: ArrayBuffer

          An input keying material

        • info: ArrayBuffer

          An additional byte string.

        • len: number

          The length in bytes of the output keying material.

        Returns Promise<ArrayBuffer>

        An output keying material as bytes.

        -

      init

      • init(suiteId): void

      • Initializes the instance by setting a suite_id defined in RFC9180.

        +

      init

      • init(suiteId): void

      • Initializes the instance by setting a suite_id defined in RFC9180.

        Parameters

        • suiteId: Uint8Array

          A suite_id defined in RFC9180.

          -

        Returns void

      labeledExpand

      • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

      • Extracts a pseudorandom key with label.

        +

      Returns void

    labeledExpand

    • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

    • Extracts a pseudorandom key with label.

      Parameters

      • prk: ArrayBuffer

        A pseudorandom key.

      • label: Uint8Array

        A byte string indicating the cryptographic context/operation.

      • info: Uint8Array

        An additional byte string.

      • len: number

        The length in bytes of the output keying material.

      Returns Promise<ArrayBuffer>

      An output keying material as bytes.

      -

    labeledExtract

    • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

    • Extracts a pseudorandom key with label.

      +

    labeledExtract

    • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

    • Extracts a pseudorandom key with label.

      Parameters

      • salt: ArrayBuffer

        An additional random byte string.

      • label: Uint8Array

        A byte string indicating the cryptographic context/operation.

      • ikm: Uint8Array

        An input keying material

      Returns Promise<ArrayBuffer>

      A pseudorandom key as bytes.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.KemInterface.html b/interfaces/_divviup_dap._internal_.KemInterface.html index d50bd288b..5af5ab3b8 100644 --- a/interfaces/_divviup_dap._internal_.KemInterface.html +++ b/interfaces/_divviup_dap._internal_.KemInterface.html @@ -1,55 +1,55 @@ -KemInterface | Documentation

    Interface KemInterface

    The KEM interface.

    -
    interface KemInterface {
        encSize: number;
        id: KemId;
        privateKeySize: number;
        publicKeySize: number;
        secretSize: number;
        decap(params): Promise<ArrayBuffer>;
        deriveKeyPair(ikm): Promise<CryptoKeyPair>;
        deserializePrivateKey(key): Promise<CryptoKey>;
        deserializePublicKey(key): Promise<CryptoKey>;
        encap(params): Promise<{
            enc: ArrayBuffer;
            sharedSecret: ArrayBuffer;
        }>;
        generateKeyPair(): Promise<CryptoKeyPair>;
        importKey(format, key, isPublic?): Promise<CryptoKey>;
        serializePrivateKey(key): Promise<ArrayBuffer>;
        serializePublicKey(key): Promise<ArrayBuffer>;
    }

    Properties

    encSize -id -privateKeySize -publicKeySize -secretSize -

    Methods

    decap -deriveKeyPair -deserializePrivateKey -deserializePublicKey -encap -generateKeyPair -importKey -serializePrivateKey -serializePublicKey -

    Properties

    Readonly encSize

    encSize: number

    The length in bytes of an encapsulated key produced by this KEM (Nenc).

    -

    Readonly id

    id: KemId

    The KEM identifier.

    -

    Readonly privateKeySize

    privateKeySize: number

    The length in bytes of an encoded private key for this KEM (Nsk).

    -

    Readonly publicKeySize

    publicKeySize: number

    The length in bytes of an encoded public key for this KEM (Npk).

    -

    Readonly secretSize

    secretSize: number

    The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

    -

    Methods

    decap

    • decap(params): Promise<ArrayBuffer>

    • Recovers the ephemeral symmetric key from its encapsulated representation enc.

      +KemInterface | Documentation

      Interface KemInterface

      The KEM interface.

      +
      interface KemInterface {
          encSize: number;
          id: KemId;
          privateKeySize: number;
          publicKeySize: number;
          secretSize: number;
          decap(params): Promise<ArrayBuffer>;
          deriveKeyPair(ikm): Promise<CryptoKeyPair>;
          deserializePrivateKey(key): Promise<CryptoKey>;
          deserializePublicKey(key): Promise<CryptoKey>;
          encap(params): Promise<{
              enc: ArrayBuffer;
              sharedSecret: ArrayBuffer;
          }>;
          generateKeyPair(): Promise<CryptoKeyPair>;
          importKey(format, key, isPublic?): Promise<CryptoKey>;
          serializePrivateKey(key): Promise<ArrayBuffer>;
          serializePublicKey(key): Promise<ArrayBuffer>;
      }

      Properties

      encSize +id +privateKeySize +publicKeySize +secretSize +

      Methods

      decap +deriveKeyPair +deserializePrivateKey +deserializePublicKey +encap +generateKeyPair +importKey +serializePrivateKey +serializePublicKey +

      Properties

      Readonly encSize

      encSize: number

      The length in bytes of an encapsulated key produced by this KEM (Nenc).

      +

      Readonly id

      id: KemId

      The KEM identifier.

      +

      Readonly privateKeySize

      privateKeySize: number

      The length in bytes of an encoded private key for this KEM (Nsk).

      +

      Readonly publicKeySize

      publicKeySize: number

      The length in bytes of an encoded public key for this KEM (Npk).

      +

      Readonly secretSize

      secretSize: number

      The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

      +

      Methods

      decap

      • decap(params): Promise<ArrayBuffer>

      • Recovers the ephemeral symmetric key from its encapsulated representation enc.

        If the error occurred, throws DecapError.

        Parameters

        Returns Promise<ArrayBuffer>

        A shared secret as the output of the decapsulation step.

        Throws

        DecapError

        -

      deriveKeyPair

      • deriveKeyPair(ikm): Promise<CryptoKeyPair>

      • Derives a key pair from the byte string ikm.

        +

      deriveKeyPair

      • deriveKeyPair(ikm): Promise<CryptoKeyPair>

      • Derives a key pair from the byte string ikm.

        If the error occurred, throws DeriveKeyPairError.

        Parameters

        • ikm: ArrayBuffer

          An input keying material.

        Returns Promise<CryptoKeyPair>

        A key pair derived.

        Throws

        DeriveKeyPairError

        -

      deserializePrivateKey

      • deserializePrivateKey(key): Promise<CryptoKey>

      • Deserializes a private key as a byte string of length Nsk to CryptoKey.

        +

      deserializePrivateKey

      • deserializePrivateKey(key): Promise<CryptoKey>

      • Deserializes a private key as a byte string of length Nsk to CryptoKey.

        If the error occurred, throws DeserializeError.

        Parameters

        • key: ArrayBuffer

          A key as bytes.

        Returns Promise<CryptoKey>

        A CryptoKey.

        Throws

        DeserializeError

        -

      deserializePublicKey

      • deserializePublicKey(key): Promise<CryptoKey>

      • Deserializes a public key as a byte string of length Npk to CryptoKey.

        +

      deserializePublicKey

      • deserializePublicKey(key): Promise<CryptoKey>

      • Deserializes a public key as a byte string of length Npk to CryptoKey.

        If the error occurred, throws DeserializeError.

        Parameters

        • key: ArrayBuffer

          A key as bytes.

        Returns Promise<CryptoKey>

        A CryptoKey.

        Throws

        DeserializeError

        -

      encap

      • encap(params): Promise<{
            enc: ArrayBuffer;
            sharedSecret: ArrayBuffer;
        }>

      • Generates an ephemeral, fixed-length symmetric key and +

      encap

      • encap(params): Promise<{
            enc: ArrayBuffer;
            sharedSecret: ArrayBuffer;
        }>

      • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

        If the error occurred, throws EncapError.

        Parameters

        Returns Promise<{
            enc: ArrayBuffer;
            sharedSecret: ArrayBuffer;
        }>

        A shared secret and an encapsulated key as the output of the encapsulation step.

        Throws

        EncapError

        -

      generateKeyPair

      • generateKeyPair(): Promise<CryptoKeyPair>

      • Generates a key pair.

        +

      generateKeyPair

      • generateKeyPair(): Promise<CryptoKeyPair>

      • Generates a key pair.

        If the error occurred, throws NotSupportedError.

        Returns Promise<CryptoKeyPair>

        A key pair generated.

        Throws

        NotSupportedError

        -

      importKey

      • importKey(format, key, isPublic?): Promise<CryptoKey>

      • Imports a public or private key and converts to a CryptoKey.

        +

      importKey

      • importKey(format, key, isPublic?): Promise<CryptoKey>

      • Imports a public or private key and converts to a CryptoKey.

        Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

        @@ -61,14 +61,14 @@
      • Optional isPublic: boolean

        The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

      Returns Promise<CryptoKey>

      A public or private CryptoKey.

      Throws

      DeserializeError

      -

    serializePrivateKey

    • serializePrivateKey(key): Promise<ArrayBuffer>

    • Serializes a private key as CryptoKey to a byte string of length Nsk.

      +

    serializePrivateKey

    • serializePrivateKey(key): Promise<ArrayBuffer>

    • Serializes a private key as CryptoKey to a byte string of length Nsk.

      If the error occurred, throws SerializeError.

      Parameters

      Returns Promise<ArrayBuffer>

      A key as bytes.

      Throws

      SerializeError

      -

    serializePublicKey

    • serializePublicKey(key): Promise<ArrayBuffer>

    • Serializes a public key as CryptoKey to a byte string of length Npk.

      +

    serializePublicKey

    • serializePublicKey(key): Promise<ArrayBuffer>

    • Serializes a public key as CryptoKey to a byte string of length Npk.

      If the error occurred, throws SerializeError.

      Parameters

      Returns Promise<ArrayBuffer>

      A key as bytes.

      Throws

      SerializeError

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.KeyAlgorithm.html b/interfaces/_divviup_dap._internal_.KeyAlgorithm.html index a457a0057..70da3694f 100644 --- a/interfaces/_divviup_dap._internal_.KeyAlgorithm.html +++ b/interfaces/_divviup_dap._internal_.KeyAlgorithm.html @@ -1,2 +1,2 @@ -KeyAlgorithm | Documentation

    Interface KeyAlgorithm

    interface KeyAlgorithm {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name -

    Properties

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +KeyAlgorithm | Documentation

    Interface KeyAlgorithm

    interface KeyAlgorithm {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name +

    Properties

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.KeyScheduleParams.html b/interfaces/_divviup_dap._internal_.KeyScheduleParams.html index 1d82ef9e5..24b9e6ff5 100644 --- a/interfaces/_divviup_dap._internal_.KeyScheduleParams.html +++ b/interfaces/_divviup_dap._internal_.KeyScheduleParams.html @@ -1,7 +1,7 @@ -KeyScheduleParams | Documentation

    Interface KeyScheduleParams

    The common parameters used to setup the EncryptionContext.

    -
    interface KeyScheduleParams {
        info?: ArrayBuffer;
        psk?: PreSharedKey;
    }

    Hierarchy (view full)

    Properties

    info? -psk? -

    Properties

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    -

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. +KeyScheduleParams | Documentation

    Interface KeyScheduleParams

    The common parameters used to setup the EncryptionContext.

    +
    interface KeyScheduleParams {
        info?: ArrayBuffer;
        psk?: PreSharedKey;
    }

    Hierarchy (view full)

    Properties

    info? +psk? +

    Properties

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    +

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.KnownVdafs.html b/interfaces/_divviup_dap._internal_.KnownVdafs.html index 9bc5e9b06..7807d32cd 100644 --- a/interfaces/_divviup_dap._internal_.KnownVdafs.html +++ b/interfaces/_divviup_dap._internal_.KnownVdafs.html @@ -1,5 +1,5 @@ -KnownVdafs | Documentation

    Interface KnownVdafs

    interface KnownVdafs {
        count: typeof Prio3Count;
        histogram: typeof Prio3Histogram;
        sum: typeof Prio3Sum;
        sumVec: typeof Prio3SumVec;
    }

    Properties

    count -histogram -sum -sumVec -

    Properties

    count

    count: typeof Prio3Count

    histogram

    histogram: typeof Prio3Histogram

    sum

    sum: typeof Prio3Sum

    sumVec

    sumVec: typeof Prio3SumVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +KnownVdafs | Documentation

    Interface KnownVdafs

    interface KnownVdafs {
        count: typeof Prio3Count;
        histogram: typeof Prio3Histogram;
        sum: typeof Prio3Sum;
        sumVec: typeof Prio3SumVec;
    }

    Properties

    count +histogram +sum +sumVec +

    Properties

    count

    count: typeof Prio3Count

    histogram

    histogram: typeof Prio3Histogram

    sum

    sum: typeof Prio3Sum

    sumVec

    sumVec: typeof Prio3SumVec

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Parseable.html b/interfaces/_divviup_dap._internal_.Parseable.html index 2cb3c1738..845e7f25d 100644 --- a/interfaces/_divviup_dap._internal_.Parseable.html +++ b/interfaces/_divviup_dap._internal_.Parseable.html @@ -1,2 +1,2 @@ -Parseable | Documentation

    Interface Parseable<U>

    interface Parseable<U> {
        parse(source): U;
    }

    Type Parameters

    • U

    Methods

    parse -

    Methods

    parse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Parseable | Documentation

    Interface Parseable<U>

    interface Parseable<U> {
        parse(source): U;
    }

    Type Parameters

    • U

    Methods

    parse +

    Methods

    parse

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Pbkdf2Params.html b/interfaces/_divviup_dap._internal_.Pbkdf2Params.html index 29a6ecf9f..ee592cb67 100644 --- a/interfaces/_divviup_dap._internal_.Pbkdf2Params.html +++ b/interfaces/_divviup_dap._internal_.Pbkdf2Params.html @@ -1,5 +1,5 @@ -Pbkdf2Params | Documentation

    Interface Pbkdf2Params

    interface Pbkdf2Params {
        hash: AlgorithmIdentifier;
        iterations: number;
        name: string;
        salt: BufferSource;
    }

    Hierarchy (view full)

    Properties

    hash -iterations -name -salt -

    Properties

    hash

    hash: AlgorithmIdentifier

    iterations

    iterations: number

    name

    name: string

    salt

    salt: BufferSource

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Pbkdf2Params | Documentation

    Interface Pbkdf2Params

    interface Pbkdf2Params {
        hash: AlgorithmIdentifier;
        iterations: number;
        name: string;
        salt: BufferSource;
    }

    Hierarchy (view full)

    Properties

    hash +iterations +name +salt +

    Properties

    hash

    hash: AlgorithmIdentifier

    iterations

    iterations: number

    name

    name: string

    salt

    salt: BufferSource

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.PreSharedKey.html b/interfaces/_divviup_dap._internal_.PreSharedKey.html index 701c54f33..c8d472076 100644 --- a/interfaces/_divviup_dap._internal_.PreSharedKey.html +++ b/interfaces/_divviup_dap._internal_.PreSharedKey.html @@ -1,6 +1,6 @@ -PreSharedKey | Documentation

    Interface PreSharedKey

    The pre-shared key interface.

    -
    interface PreSharedKey {
        id: ArrayBuffer;
        key: ArrayBuffer;
    }

    Properties

    id -key -

    Properties

    id

    id: ArrayBuffer

    The key identifier.

    -

    key

    key: ArrayBuffer

    The body of the pre-shared key.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +PreSharedKey | Documentation

    Interface PreSharedKey

    The pre-shared key interface.

    +
    interface PreSharedKey {
        id: ArrayBuffer;
        key: ArrayBuffer;
    }

    Properties

    id +key +

    Properties

    id

    id: ArrayBuffer

    The key identifier.

    +

    key

    key: ArrayBuffer

    The body of the pre-shared key.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.PrepTestVector.html b/interfaces/_divviup_dap._internal_.PrepTestVector.html index cdc8c4a55..3db0cb660 100644 --- a/interfaces/_divviup_dap._internal_.PrepTestVector.html +++ b/interfaces/_divviup_dap._internal_.PrepTestVector.html @@ -1,9 +1,9 @@ -PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares -measurement -nonce -out_shares -prep_messages -prep_shares -public_share -rand -

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares +measurement +nonce +out_shares +prep_messages +prep_shares +public_share +rand +

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.Problem.html b/interfaces/_divviup_dap._internal_.Problem.html index acb50ebf1..22258635f 100644 --- a/interfaces/_divviup_dap._internal_.Problem.html +++ b/interfaces/_divviup_dap._internal_.Problem.html @@ -1,7 +1,7 @@ -Problem | Documentation

    Interface Problem

    interface Problem {
        detail: string;
        instance: string;
        status: number;
        taskid: string;
        title: string;
        type: string;
    }

    Properties

    detail -instance -status -taskid -title -type -

    Properties

    detail

    detail: string

    instance

    instance: string

    status

    status: number

    taskid

    taskid: string

    title

    title: string

    type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Problem | Documentation

    Interface Problem

    interface Problem {
        detail: string;
        instance: string;
        status: number;
        taskid: string;
        title: string;
        type: string;
    }

    Properties

    detail +instance +status +taskid +title +type +

    Properties

    detail

    detail: string

    instance

    instance: string

    status

    status: number

    taskid

    taskid: string

    title

    title: string

    type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RecipientContextParams.html b/interfaces/_divviup_dap._internal_.RecipientContextParams.html index 9840619cc..0de39ce1c 100644 --- a/interfaces/_divviup_dap._internal_.RecipientContextParams.html +++ b/interfaces/_divviup_dap._internal_.RecipientContextParams.html @@ -1,13 +1,13 @@ -RecipientContextParams | Documentation

    Interface RecipientContextParams

    The parameters used to setup the RecipientContext.

    -
    interface RecipientContextParams {
        enc: ArrayBuffer;
        info?: ArrayBuffer;
        psk?: PreSharedKey;
        recipientKey: CryptoKey | CryptoKeyPair;
        senderPublicKey?: CryptoKey;
    }

    Hierarchy (view full)

    Properties

    enc -info? -psk? -recipientKey -senderPublicKey? -

    Properties

    enc

    enc: ArrayBuffer

    A byte string of the encapsulated key received from a sender.

    -

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    -

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. +RecipientContextParams | Documentation

    Interface RecipientContextParams

    The parameters used to setup the RecipientContext.

    +
    interface RecipientContextParams {
        enc: ArrayBuffer;
        info?: ArrayBuffer;
        psk?: PreSharedKey;
        recipientKey: CryptoKey | CryptoKeyPair;
        senderPublicKey?: CryptoKey;
    }

    Hierarchy (view full)

    Properties

    enc +info? +psk? +recipientKey +senderPublicKey? +

    Properties

    enc

    enc: ArrayBuffer

    A byte string of the encapsulated key received from a sender.

    +

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    +

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

    -

    recipientKey

    recipientKey: CryptoKey | CryptoKeyPair

    A recipient private key or a key pair.

    -

    Optional senderPublicKey

    senderPublicKey?: CryptoKey

    A sender public key for Auth mode.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    recipientKey

    recipientKey: CryptoKey | CryptoKeyPair

    A recipient private key or a key pair.

    +

    Optional senderPublicKey

    senderPublicKey?: CryptoKey

    A sender public key for Auth mode.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaHashedImportParams.html b/interfaces/_divviup_dap._internal_.RsaHashedImportParams.html index 97b9eac3b..48ee7b757 100644 --- a/interfaces/_divviup_dap._internal_.RsaHashedImportParams.html +++ b/interfaces/_divviup_dap._internal_.RsaHashedImportParams.html @@ -1,3 +1,3 @@ -RsaHashedImportParams | Documentation

    Interface RsaHashedImportParams

    interface RsaHashedImportParams {
        hash: AlgorithmIdentifier;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash -name -

    Properties

    hash

    hash: AlgorithmIdentifier

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaHashedImportParams | Documentation

    Interface RsaHashedImportParams

    interface RsaHashedImportParams {
        hash: AlgorithmIdentifier;
        name: string;
    }

    Hierarchy (view full)

    Properties

    hash +name +

    Properties

    hash

    hash: AlgorithmIdentifier

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaHashedKeyGenParams.html b/interfaces/_divviup_dap._internal_.RsaHashedKeyGenParams.html index a8eff2c5a..c8622b40e 100644 --- a/interfaces/_divviup_dap._internal_.RsaHashedKeyGenParams.html +++ b/interfaces/_divviup_dap._internal_.RsaHashedKeyGenParams.html @@ -1,5 +1,5 @@ -RsaHashedKeyGenParams | Documentation

    Interface RsaHashedKeyGenParams

    interface RsaHashedKeyGenParams {
        hash: AlgorithmIdentifier;
        modulusLength: number;
        name: string;
        publicExponent: Uint8Array;
    }

    Hierarchy (view full)

    Properties

    hash -modulusLength -name -publicExponent -

    Properties

    hash

    hash: AlgorithmIdentifier

    modulusLength

    modulusLength: number

    name

    name: string

    publicExponent

    publicExponent: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaHashedKeyGenParams | Documentation

    Interface RsaHashedKeyGenParams

    interface RsaHashedKeyGenParams {
        hash: AlgorithmIdentifier;
        modulusLength: number;
        name: string;
        publicExponent: Uint8Array;
    }

    Hierarchy (view full)

    Properties

    hash +modulusLength +name +publicExponent +

    Properties

    hash

    hash: AlgorithmIdentifier

    modulusLength

    modulusLength: number

    name

    name: string

    publicExponent

    publicExponent: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaKeyGenParams.html b/interfaces/_divviup_dap._internal_.RsaKeyGenParams.html index a716bb398..953eed7ca 100644 --- a/interfaces/_divviup_dap._internal_.RsaKeyGenParams.html +++ b/interfaces/_divviup_dap._internal_.RsaKeyGenParams.html @@ -1,4 +1,4 @@ -RsaKeyGenParams | Documentation

    Interface RsaKeyGenParams

    interface RsaKeyGenParams {
        modulusLength: number;
        name: string;
        publicExponent: Uint8Array;
    }

    Hierarchy (view full)

    Properties

    modulusLength -name -publicExponent -

    Properties

    modulusLength

    modulusLength: number

    name

    name: string

    publicExponent

    publicExponent: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaKeyGenParams | Documentation

    Interface RsaKeyGenParams

    interface RsaKeyGenParams {
        modulusLength: number;
        name: string;
        publicExponent: Uint8Array;
    }

    Hierarchy (view full)

    Properties

    modulusLength +name +publicExponent +

    Properties

    modulusLength

    modulusLength: number

    name

    name: string

    publicExponent

    publicExponent: Uint8Array

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaOaepParams.html b/interfaces/_divviup_dap._internal_.RsaOaepParams.html index 95d0e01f3..137e02497 100644 --- a/interfaces/_divviup_dap._internal_.RsaOaepParams.html +++ b/interfaces/_divviup_dap._internal_.RsaOaepParams.html @@ -1,3 +1,3 @@ -RsaOaepParams | Documentation

    Interface RsaOaepParams

    interface RsaOaepParams {
        label?: BufferSource;
        name: string;
    }

    Hierarchy (view full)

    Properties

    label? -name -

    Properties

    Optional label

    label?: BufferSource

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaOaepParams | Documentation

    Interface RsaOaepParams

    interface RsaOaepParams {
        label?: BufferSource;
        name: string;
    }

    Hierarchy (view full)

    Properties

    label? +name +

    Properties

    Optional label

    label?: BufferSource

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaOtherPrimesInfo.html b/interfaces/_divviup_dap._internal_.RsaOtherPrimesInfo.html index 814f52815..adaf95df3 100644 --- a/interfaces/_divviup_dap._internal_.RsaOtherPrimesInfo.html +++ b/interfaces/_divviup_dap._internal_.RsaOtherPrimesInfo.html @@ -1,4 +1,4 @@ -RsaOtherPrimesInfo | Documentation

    Interface RsaOtherPrimesInfo

    interface RsaOtherPrimesInfo {
        d?: string;
        r?: string;
        t?: string;
    }

    Properties

    d? -r? -t? -

    Properties

    Optional d

    d?: string

    Optional r

    r?: string

    Optional t

    t?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaOtherPrimesInfo | Documentation

    Interface RsaOtherPrimesInfo

    interface RsaOtherPrimesInfo {
        d?: string;
        r?: string;
        t?: string;
    }

    Properties

    d? +r? +t? +

    Properties

    Optional d

    d?: string

    Optional r

    r?: string

    Optional t

    t?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.RsaPssParams.html b/interfaces/_divviup_dap._internal_.RsaPssParams.html index edb724272..21cd58d94 100644 --- a/interfaces/_divviup_dap._internal_.RsaPssParams.html +++ b/interfaces/_divviup_dap._internal_.RsaPssParams.html @@ -1,3 +1,3 @@ -RsaPssParams | Documentation

    Interface RsaPssParams

    interface RsaPssParams {
        name: string;
        saltLength: number;
    }

    Hierarchy (view full)

    Properties

    name -saltLength -

    Properties

    name

    name: string

    saltLength

    saltLength: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RsaPssParams | Documentation

    Interface RsaPssParams

    interface RsaPssParams {
        name: string;
        saltLength: number;
    }

    Hierarchy (view full)

    Properties

    name +saltLength +

    Properties

    name

    name: string

    saltLength

    saltLength: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SenderContext.html b/interfaces/_divviup_dap._internal_.SenderContext.html index 56913bb67..45a0079f9 100644 --- a/interfaces/_divviup_dap._internal_.SenderContext.html +++ b/interfaces/_divviup_dap._internal_.SenderContext.html @@ -1,25 +1,25 @@ -SenderContext | Documentation

    Interface SenderContext

    The sender encryption context.

    -
    interface SenderContext {
        enc: ArrayBuffer;
        export(exporterContext, len): Promise<ArrayBuffer>;
        open(data, aad?): Promise<ArrayBuffer>;
        seal(data, aad?): Promise<ArrayBuffer>;
    }

    Hierarchy (view full)

    Properties

    enc -

    Methods

    export -open -seal -

    Properties

    enc

    enc: ArrayBuffer

    The encapsulated key generated by the sender.

    -

    Methods

    export

    • export(exporterContext, len): Promise<ArrayBuffer>

    • Exports a secret using a variable-length pseudorandom function.

      +SenderContext | Documentation

      Interface SenderContext

      The sender encryption context.

      +
      interface SenderContext {
          enc: ArrayBuffer;
          export(exporterContext, len): Promise<ArrayBuffer>;
          open(data, aad?): Promise<ArrayBuffer>;
          seal(data, aad?): Promise<ArrayBuffer>;
      }

      Hierarchy (view full)

      Properties

      enc +

      Methods

      export +open +seal +

      Properties

      enc

      enc: ArrayBuffer

      The encapsulated key generated by the sender.

      +

      Methods

      export

      • export(exporterContext, len): Promise<ArrayBuffer>

      • Exports a secret using a variable-length pseudorandom function.

        If the error occurred, throws ExportError.

        Parameters

        • exporterContext: ArrayBuffer

          An exporter context string as bytes. The maximum length is 128 bytes.

        • len: number

          A desired length in bytes of the output secret.

        Returns Promise<ArrayBuffer>

        A secret string as bytes.

        Throws

        ExportError

        -

      open

      • open(data, aad?): Promise<ArrayBuffer>

      • Decrypts data.

        +

      open

      • open(data, aad?): Promise<ArrayBuffer>

      • Decrypts data.

        If the error occurred, throws OpenError.

        Parameters

        • data: ArrayBuffer

          An encrypted text as bytes to be decrypted.

        • Optional aad: ArrayBuffer

          Additional authenticated data as bytes fed by an application.

        Returns Promise<ArrayBuffer>

        A decrypted plain text as bytes.

        Throws

        OpenError

        -

      seal

      • seal(data, aad?): Promise<ArrayBuffer>

      • Encrypts data.

        +

      seal

      • seal(data, aad?): Promise<ArrayBuffer>

      • Encrypts data.

        If the error occurred, throws SealError | MessageLimitReachedError.

        Parameters

        • data: ArrayBuffer

          A plain text as bytes to be encrypted.

        • Optional aad: ArrayBuffer

          Additional authenticated data as bytes fed by an application.

        Returns Promise<ArrayBuffer>

        A cipher text as bytes.

        Throws

        MessageLimitReachedError, SealError

        -

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SenderContextParams.html b/interfaces/_divviup_dap._internal_.SenderContextParams.html index a2a7a277f..043a953b6 100644 --- a/interfaces/_divviup_dap._internal_.SenderContextParams.html +++ b/interfaces/_divviup_dap._internal_.SenderContextParams.html @@ -1,13 +1,13 @@ -SenderContextParams | Documentation

    Interface SenderContextParams

    The parameters used to setup the SenderContext.

    -
    interface SenderContextParams {
        ekm?: ArrayBuffer | CryptoKeyPair;
        info?: ArrayBuffer;
        psk?: PreSharedKey;
        recipientPublicKey: CryptoKey;
        senderKey?: CryptoKey | CryptoKeyPair;
    }

    Hierarchy (view full)

    Properties

    ekm? -info? -psk? -recipientPublicKey -senderKey? -

    Properties

    Optional ekm

    ekm?: ArrayBuffer | CryptoKeyPair

    DO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.

    -

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    -

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. +SenderContextParams | Documentation

    Interface SenderContextParams

    The parameters used to setup the SenderContext.

    +
    interface SenderContextParams {
        ekm?: ArrayBuffer | CryptoKeyPair;
        info?: ArrayBuffer;
        psk?: PreSharedKey;
        recipientPublicKey: CryptoKey;
        senderKey?: CryptoKey | CryptoKeyPair;
    }

    Hierarchy (view full)

    Properties

    ekm? +info? +psk? +recipientPublicKey +senderKey? +

    Properties

    Optional ekm

    ekm?: ArrayBuffer | CryptoKeyPair

    DO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.

    +

    Optional info

    info?: ArrayBuffer

    Application supplied information. The maximum length is 128 bytes.

    +

    Optional psk

    psk?: PreSharedKey

    A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

    -

    recipientPublicKey

    recipientPublicKey: CryptoKey

    A recipient public key.

    -

    Optional senderKey

    senderKey?: CryptoKey | CryptoKeyPair

    A sender private key or a key pair for Auth mode.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    recipientPublicKey

    recipientPublicKey: CryptoKey

    A recipient public key.

    +

    Optional senderKey

    senderKey?: CryptoKey | CryptoKeyPair

    A sender private key or a key pair for Auth mode.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SharedArrayBuffer.html b/interfaces/_divviup_dap._internal_.SharedArrayBuffer.html index 1cd46ec08..cd212cae6 100644 --- a/interfaces/_divviup_dap._internal_.SharedArrayBuffer.html +++ b/interfaces/_divviup_dap._internal_.SharedArrayBuffer.html @@ -1,7 +1,7 @@ -SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] -[toStringTag] -byteLength -

    Methods

    slice -

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    -

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      -

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] +[toStringTag] +byteLength +

    Methods

    slice +

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    +

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      +

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SharedArrayBufferConstructor.html b/interfaces/_divviup_dap._internal_.SharedArrayBufferConstructor.html index 6c63d6a15..c5cfa70e3 100644 --- a/interfaces/_divviup_dap._internal_.SharedArrayBufferConstructor.html +++ b/interfaces/_divviup_dap._internal_.SharedArrayBufferConstructor.html @@ -1,3 +1,3 @@ -SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor -

    Properties

    prototype -

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor +

    Properties

    prototype +

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SubtleCrypto.html b/interfaces/_divviup_dap._internal_.SubtleCrypto.html index dea3d4290..7fd481bb1 100644 --- a/interfaces/_divviup_dap._internal_.SubtleCrypto.html +++ b/interfaces/_divviup_dap._internal_.SubtleCrypto.html @@ -1,28 +1,28 @@ -SubtleCrypto | Documentation

    Interface SubtleCrypto

    This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto). +SubtleCrypto | Documentation

    Interface SubtleCrypto

    This Web Crypto API interface provides a number of low-level cryptographic functions. It is accessed via the Crypto.subtle properties available in a window context (via Window.crypto). Available only in secure contexts.

    MDN Reference

    -
    interface SubtleCrypto {
        decrypt(algorithm, key, data): Promise<ArrayBuffer>;
        deriveBits(algorithm, baseKey, length): Promise<ArrayBuffer>;
        deriveKey(algorithm, baseKey, derivedKeyType, extractable, keyUsages): Promise<CryptoKey>;
        digest(algorithm, data): Promise<ArrayBuffer>;
        encrypt(algorithm, key, data): Promise<ArrayBuffer>;
        exportKey(format, key): Promise<JsonWebKey>;
        exportKey(format, key): Promise<ArrayBuffer>;
        exportKey(format, key): Promise<ArrayBuffer | JsonWebKey>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKey>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKey | CryptoKeyPair>;
        importKey(format, keyData, algorithm, extractable, keyUsages): Promise<CryptoKey>;
        importKey(format, keyData, algorithm, extractable, keyUsages): Promise<CryptoKey>;
        sign(algorithm, key, data): Promise<ArrayBuffer>;
        unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgorithm, unwrappedKeyAlgorithm, extractable, keyUsages): Promise<CryptoKey>;
        verify(algorithm, key, signature, data): Promise<boolean>;
        wrapKey(format, key, wrappingKey, wrapAlgorithm): Promise<ArrayBuffer>;
    }

    Methods

    decrypt -deriveBits -deriveKey -digest -encrypt -exportKey -generateKey -importKey -sign -unwrapKey -verify -wrapKey -

    Methods

    decrypt

    deriveBits

    deriveKey

    digest

    encrypt

    exportKey

    • exportKey(format, key): Promise<JsonWebKey>

    • MDN Reference

      -

      Parameters

      Returns Promise<JsonWebKey>

    • exportKey(format, key): Promise<ArrayBuffer>

    • Parameters

      • format: "raw" | "pkcs8" | "spki"
      • key: CryptoKey

      Returns Promise<ArrayBuffer>

    • exportKey(format, key): Promise<ArrayBuffer | JsonWebKey>

    • Parameters

      Returns Promise<ArrayBuffer | JsonWebKey>

    generateKey

    importKey

    sign

    unwrapKey

    verify

    wrapKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface SubtleCrypto {
        decrypt(algorithm, key, data): Promise<ArrayBuffer>;
        deriveBits(algorithm, baseKey, length): Promise<ArrayBuffer>;
        deriveKey(algorithm, baseKey, derivedKeyType, extractable, keyUsages): Promise<CryptoKey>;
        digest(algorithm, data): Promise<ArrayBuffer>;
        encrypt(algorithm, key, data): Promise<ArrayBuffer>;
        exportKey(format, key): Promise<JsonWebKey>;
        exportKey(format, key): Promise<ArrayBuffer>;
        exportKey(format, key): Promise<ArrayBuffer | JsonWebKey>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKey>;
        generateKey(algorithm, extractable, keyUsages): Promise<CryptoKey | CryptoKeyPair>;
        importKey(format, keyData, algorithm, extractable, keyUsages): Promise<CryptoKey>;
        importKey(format, keyData, algorithm, extractable, keyUsages): Promise<CryptoKey>;
        sign(algorithm, key, data): Promise<ArrayBuffer>;
        unwrapKey(format, wrappedKey, unwrappingKey, unwrapAlgorithm, unwrappedKeyAlgorithm, extractable, keyUsages): Promise<CryptoKey>;
        verify(algorithm, key, signature, data): Promise<boolean>;
        wrapKey(format, key, wrappingKey, wrapAlgorithm): Promise<ArrayBuffer>;
    }

    Methods

    decrypt +deriveBits +deriveKey +digest +encrypt +exportKey +generateKey +importKey +sign +unwrapKey +verify +wrapKey +

    Methods

    decrypt

    deriveBits

    deriveKey

    digest

    encrypt

    exportKey

    • exportKey(format, key): Promise<JsonWebKey>

    • MDN Reference

      +

      Parameters

      Returns Promise<JsonWebKey>

    • exportKey(format, key): Promise<ArrayBuffer>

    • Parameters

      • format: "raw" | "pkcs8" | "spki"
      • key: CryptoKey

      Returns Promise<ArrayBuffer>

    • exportKey(format, key): Promise<ArrayBuffer | JsonWebKey>

    • Parameters

      Returns Promise<ArrayBuffer | JsonWebKey>

    generateKey

    importKey

    sign

    unwrapKey

    verify

    wrapKey

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.SumVecArgs.html b/interfaces/_divviup_dap._internal_.SumVecArgs.html index 57cd6768b..63eb7c41b 100644 --- a/interfaces/_divviup_dap._internal_.SumVecArgs.html +++ b/interfaces/_divviup_dap._internal_.SumVecArgs.html @@ -1,5 +1,5 @@ -SumVecArgs | Documentation

    Interface SumVecArgs

    interface SumVecArgs {
        bits: number;
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    bits -chunkLength -length -shares -

    Properties

    bits

    bits: number

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SumVecArgs | Documentation

    Interface SumVecArgs

    interface SumVecArgs {
        bits: number;
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    bits +chunkLength +length +shares +

    Properties

    bits

    bits: number

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.TestVector.html b/interfaces/_divviup_dap._internal_.TestVector.html index 7a5e2b19c..9e49e0ba5 100644 --- a/interfaces/_divviup_dap._internal_.TestVector.html +++ b/interfaces/_divviup_dap._internal_.TestVector.html @@ -1,7 +1,7 @@ -TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param -agg_result -agg_shares -prep -shares -verify_key -

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param +agg_result +agg_shares +prep +shares +verify_key +

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_dap._internal_.XofConstructor.html b/interfaces/_divviup_dap._internal_.XofConstructor.html index c94c0b313..ede84753b 100644 --- a/interfaces/_divviup_dap._internal_.XofConstructor.html +++ b/interfaces/_divviup_dap._internal_.XofConstructor.html @@ -1,5 +1,5 @@ -XofConstructor | Documentation

    Interface XofConstructor

    interface XofConstructor {
        new XofConstructornew (seed, dst, binder): Xof;
        seedSize: number;
        deriveSeed(seed, dst, binder): Promise<Uint8Array>;
        expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>;
    }

    Constructors

    constructor -

    Properties

    seedSize -

    Methods

    deriveSeed -expandIntoVec -

    Constructors

    constructor

    • new XofConstructor(seed, dst, binder): Xof

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Xof

    Properties

    seedSize

    seedSize: number

    Methods

    deriveSeed

    • deriveSeed(seed, dst, binder): Promise<Uint8Array>

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Promise<Uint8Array>

    expandIntoVec

    • expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>

    • Parameters

      • field: Field
      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array
      • length: number

      Returns Promise<bigint[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +XofConstructor | Documentation

    Interface XofConstructor

    interface XofConstructor {
        new XofConstructornew (seed, dst, binder): Xof;
        seedSize: number;
        deriveSeed(seed, dst, binder): Promise<Uint8Array>;
        expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>;
    }

    Constructors

    constructor +

    Properties

    seedSize +

    Methods

    deriveSeed +expandIntoVec +

    Constructors

    constructor

    • new XofConstructor(seed, dst, binder): Xof

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Xof

    Properties

    seedSize

    seedSize: number

    Methods

    deriveSeed

    • deriveSeed(seed, dst, binder): Promise<Uint8Array>

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Promise<Uint8Array>

    expandIntoVec

    • expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>

    • Parameters

      • field: Field
      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array
      • length: number

      Returns Promise<bigint[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_field._internal_.ArithmeticOperation.html b/interfaces/_divviup_field._internal_.ArithmeticOperation.html index a9b942545..386914bed 100644 --- a/interfaces/_divviup_field._internal_.ArithmeticOperation.html +++ b/interfaces/_divviup_field._internal_.ArithmeticOperation.html @@ -1 +1 @@ -ArithmeticOperation | Documentation

    Interface ArithmeticOperation

    interface ArithmeticOperation ((this, a, b) => bigint)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArithmeticOperation | Documentation

    Interface ArithmeticOperation

    interface ArithmeticOperation ((this, a, b) => bigint)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_field._internal_.FieldConstructorArgs.html b/interfaces/_divviup_field._internal_.FieldConstructorArgs.html index 6fd444ecc..2b033eb44 100644 --- a/interfaces/_divviup_field._internal_.FieldConstructorArgs.html +++ b/interfaces/_divviup_field._internal_.FieldConstructorArgs.html @@ -1,5 +1,5 @@ -FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize -genOrder -generator -modulus -

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize +genOrder +generator +modulus +

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.ArrayLike.html b/interfaces/_divviup_prio3._internal_.ArrayLike.html index d9bade39c..ba9fc0e2e 100644 --- a/interfaces/_divviup_prio3._internal_.ArrayLike.html +++ b/interfaces/_divviup_prio3._internal_.ArrayLike.html @@ -1,2 +1,2 @@ -ArrayLike | Documentation

    Interface ArrayLike<T>

    interface ArrayLike<T> {
        length: number;
        [n: number]: T;
    }

    Type Parameters

    • T

    Indexable

    [n: number]: T

    Properties

    length -

    Properties

    Readonly length

    length: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +ArrayLike | Documentation

    Interface ArrayLike<T>

    interface ArrayLike<T> {
        length: number;
        [n: number]: T;
    }

    Type Parameters

    • T

    Indexable

    [n: number]: T

    Properties

    length +

    Properties

    Readonly length

    length: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.Buffer.html b/interfaces/_divviup_prio3._internal_.Buffer.html index 06082f2da..17c3ac0fd 100644 --- a/interfaces/_divviup_prio3._internal_.Buffer.html +++ b/interfaces/_divviup_prio3._internal_.Buffer.html @@ -1,116 +1,116 @@ -Buffer | Documentation

    Interface Buffer

    interface Buffer {
        BYTES_PER_ELEMENT: number;
        [toStringTag]: "Uint8Array";
        buffer: ArrayBufferLike;
        byteLength: number;
        byteOffset: number;
        length: number;
        [iterator](): IterableIterator<number>;
        at(index): undefined | number;
        compare(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): -1 | 0 | 1;
        copy(target, targetStart?, sourceStart?, sourceEnd?): number;
        copyWithin(target, start, end?): this;
        entries(): IterableIterator<[number, number]>;
        equals(otherBuffer): boolean;
        every(predicate, thisArg?): boolean;
        fill(value, offset?, end?, encoding?): this;
        filter(predicate, thisArg?): Uint8Array;
        find(predicate, thisArg?): undefined | number;
        findIndex(predicate, thisArg?): number;
        forEach(callbackfn, thisArg?): void;
        includes(value, byteOffset?, encoding?): boolean;
        indexOf(value, byteOffset?, encoding?): number;
        join(separator?): string;
        keys(): IterableIterator<number>;
        lastIndexOf(value, byteOffset?, encoding?): number;
        map(callbackfn, thisArg?): Uint8Array;
        readBigInt64BE(offset?): bigint;
        readBigInt64LE(offset?): bigint;
        readBigUInt64BE(offset?): bigint;
        readBigUInt64LE(offset?): bigint;
        readBigUint64BE(offset?): bigint;
        readBigUint64LE(offset?): bigint;
        readDoubleBE(offset?): number;
        readDoubleLE(offset?): number;
        readFloatBE(offset?): number;
        readFloatLE(offset?): number;
        readInt16BE(offset?): number;
        readInt16LE(offset?): number;
        readInt32BE(offset?): number;
        readInt32LE(offset?): number;
        readInt8(offset?): number;
        readIntBE(offset, byteLength): number;
        readIntLE(offset, byteLength): number;
        readUInt16BE(offset?): number;
        readUInt16LE(offset?): number;
        readUInt32BE(offset?): number;
        readUInt32LE(offset?): number;
        readUInt8(offset?): number;
        readUIntBE(offset, byteLength): number;
        readUIntLE(offset, byteLength): number;
        readUint16BE(offset?): number;
        readUint16LE(offset?): number;
        readUint32BE(offset?): number;
        readUint32LE(offset?): number;
        readUint8(offset?): number;
        readUintBE(offset, byteLength): number;
        readUintLE(offset, byteLength): number;
        reduce(callbackfn): number;
        reduce(callbackfn, initialValue): number;
        reduce<U>(callbackfn, initialValue): U;
        reduceRight(callbackfn): number;
        reduceRight(callbackfn, initialValue): number;
        reduceRight<U>(callbackfn, initialValue): U;
        reverse(): this;
        set(array, offset?): void;
        slice(start?, end?): Buffer;
        some(predicate, thisArg?): boolean;
        sort(compareFn?): this;
        subarray(start?, end?): Buffer;
        swap16(): Buffer;
        swap32(): Buffer;
        swap64(): Buffer;
        toJSON(): {
            data: number[];
            type: "Buffer";
        };
        toLocaleString(): string;
        toString(encoding?, start?, end?): string;
        valueOf(): Uint8Array;
        values(): IterableIterator<number>;
        write(string, encoding?): number;
        write(string, offset, encoding?): number;
        write(string, offset, length, encoding?): number;
        writeBigInt64BE(value, offset?): number;
        writeBigInt64LE(value, offset?): number;
        writeBigUInt64BE(value, offset?): number;
        writeBigUInt64LE(value, offset?): number;
        writeBigUint64BE(value, offset?): number;
        writeBigUint64LE(value, offset?): number;
        writeDoubleBE(value, offset?): number;
        writeDoubleLE(value, offset?): number;
        writeFloatBE(value, offset?): number;
        writeFloatLE(value, offset?): number;
        writeInt16BE(value, offset?): number;
        writeInt16LE(value, offset?): number;
        writeInt32BE(value, offset?): number;
        writeInt32LE(value, offset?): number;
        writeInt8(value, offset?): number;
        writeIntBE(value, offset, byteLength): number;
        writeIntLE(value, offset, byteLength): number;
        writeUInt16BE(value, offset?): number;
        writeUInt16LE(value, offset?): number;
        writeUInt32BE(value, offset?): number;
        writeUInt32LE(value, offset?): number;
        writeUInt8(value, offset?): number;
        writeUIntBE(value, offset, byteLength): number;
        writeUIntLE(value, offset, byteLength): number;
        writeUint16BE(value, offset?): number;
        writeUint16LE(value, offset?): number;
        writeUint32BE(value, offset?): number;
        writeUint32LE(value, offset?): number;
        writeUint8(value, offset?): number;
        writeUintBE(value, offset, byteLength): number;
        writeUintLE(value, offset, byteLength): number;
    }

    Hierarchy

    • Uint8Array
      • Buffer

    Properties

    BYTES_PER_ELEMENT -[toStringTag] -buffer -byteLength -byteOffset -length -

    Methods

    [iterator] -at -compare -copy -copyWithin -entries -equals -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -readBigInt64BE -readBigInt64LE -readBigUInt64BE -readBigUInt64LE -readBigUint64BE -readBigUint64LE -readDoubleBE -readDoubleLE -readFloatBE -readFloatLE -readInt16BE -readInt16LE -readInt32BE -readInt32LE -readInt8 -readIntBE -readIntLE -readUInt16BE -readUInt16LE -readUInt32BE -readUInt32LE -readUInt8 -readUIntBE -readUIntLE -readUint16BE -readUint16LE -readUint32BE -readUint32LE -readUint8 -readUintBE -readUintLE -reduce -reduceRight -reverse -set -slice -some -sort -subarray -swap16 -swap32 -swap64 -toJSON -toLocaleString -toString -valueOf -values -write -writeBigInt64BE -writeBigInt64LE -writeBigUInt64BE -writeBigUInt64LE -writeBigUint64BE -writeBigUint64LE -writeDoubleBE -writeDoubleLE -writeFloatBE -writeFloatLE -writeInt16BE -writeInt16LE -writeInt32BE -writeInt32LE -writeInt8 -writeIntBE -writeIntLE -writeUInt16BE -writeUInt16LE -writeUInt32BE -writeUInt32LE -writeUInt8 -writeUIntBE -writeUIntLE -writeUint16BE -writeUint16LE -writeUint32BE -writeUint32LE -writeUint8 -writeUintBE -writeUintLE -

    Properties

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Uint8Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Methods

    [iterator]

    • [iterator](): IterableIterator<number>

    • Returns IterableIterator<number>

    at

    copy

    • copy(target, targetStart?, sourceStart?, sourceEnd?): number

    • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

      +

    copy

    • copy(target, targetStart?, sourceStart?, sourceEnd?): number

    • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

      TypedArray.prototype.set() performs the same operation, and is available for all TypedArrays, including Node.js Buffers, although it takes different function arguments.

      @@ -143,30 +143,30 @@
    • Optional sourceEnd: number

      The offset within buf at which to stop copying (not inclusive).

    Returns number

    The number of bytes copied.

    Since

    v0.1.90

    -

    copyWithin

    • copyWithin(target, start, end?): this

    • Returns the this object after copying a section of the array identified by start and end +

    copyWithin

    • copyWithin(target, start, end?): this

    • 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.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: number

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

        -

      Returns this

    entries

    Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Creates and returns an iterator of [index, byte] pairs from the contents of buf.

      import { Buffer } from 'node:buffer';

      // Log the entire contents of a `Buffer`.

      const buf = Buffer.from('buffer');

      for (const pair of buf.entries()) {
        console.log(pair);
      }
      // Prints:
      //   [0, 98]
      //   [1, 117]
      //   [2, 102]
      //   [3, 102]
      //   [4, 101]
      //   [5, 114]

      Returns IterableIterator<[number, number]>

      Since

      v1.1.0

      -

    equals

    • equals(otherBuffer): boolean

    • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

      +

    equals

    • equals(otherBuffer): boolean

    • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from('ABC');
      const buf2 = Buffer.from('414243', 'hex');
      const buf3 = Buffer.from('ABCD');

      console.log(buf1.equals(buf2));
      // Prints: true
      console.log(buf1.equals(buf3));
      // Prints: false

      Parameters

      • otherBuffer: Uint8Array

        A Buffer or Uint8Array with which to compare buf.

      Returns boolean

      Since

      v0.11.13

      -

    every

    • every(predicate, thisArg?): boolean

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

      +

    every

    • every(predicate, thisArg?): boolean

    • 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

    fill

    • fill(value, offset?, end?, encoding?): this

    • Fills buf with the specified value. If the offset and end are not given, +

    Returns boolean

    fill

    • fill(value, offset?, end?, encoding?): this

    • Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled:

      import { Buffer } from 'node:buffer';

      // Fill a `Buffer` with the ASCII character 'h'.

      const b = Buffer.allocUnsafe(50).fill('h');

      console.log(b.toString());
      // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

      // Fill a buffer with empty string
      const c = Buffer.allocUnsafe(5).fill('');

      console.log(c.fill(''));
      // Prints: <Buffer 00 00 00 00 00>
      @@ -187,31 +187,31 @@
    • Optional encoding: BufferEncoding

      The encoding for value if value is a string.

    Returns this

    A reference to buf.

    Since

    v0.5.0

    -

    filter

    • filter(predicate, thisArg?): Uint8Array

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

      +

    filter

    • filter(predicate, thisArg?): Uint8Array

    • 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

    find

    • find(predicate, thisArg?): undefined | number

    • Returns the value of the first element in the array where predicate is true, and undefined +

    Returns Uint8Array

    find

    • find(predicate, thisArg?): undefined | number

    • 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

    findIndex

    • findIndex(predicate, thisArg?): number

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

    Returns undefined | number

    findIndex

    • findIndex(predicate, thisArg?): 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

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      +

    Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • 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

    includes

    • includes(value, byteOffset?, encoding?): boolean

    • Equivalent to buf.indexOf() !== -1.

      +

    Returns void

    includes

    • includes(value, byteOffset?, encoding?): boolean

    • Equivalent to buf.indexOf() !== -1.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('this is a buffer');

      console.log(buf.includes('this'));
      // Prints: true
      console.log(buf.includes('is'));
      // Prints: true
      console.log(buf.includes(Buffer.from('a buffer')));
      // Prints: true
      console.log(buf.includes(97));
      // Prints: true (97 is the decimal ASCII value for 'a')
      console.log(buf.includes(Buffer.from('a buffer example')));
      // Prints: false
      console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
      // Prints: true
      console.log(buf.includes('this', 4));
      // Prints: false

      Parameters

      • value: string | number | Buffer

        What to search for.

        @@ -219,7 +219,7 @@
      • Optional encoding: BufferEncoding

        If value is a string, this is its encoding.

      Returns boolean

      true if value was found in buf, false otherwise.

      Since

      v5.3.0

      -

    indexOf

    • indexOf(value, byteOffset?, encoding?): number

    • If value is:

      +

    indexOf

    • indexOf(value, byteOffset?, encoding?): number

    • If value is:

      • a string, value is interpreted according to the character encoding inencoding.
      • a Buffer or Uint8Array, value will be used in its entirety. @@ -243,14 +243,14 @@
    • Optional encoding: BufferEncoding

      If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

    Returns number

    The index of the first occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v1.5.0

    -

    join

    • join(separator?): string

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

      +

    join

    • join(separator?): string

    • 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

    keys

    Returns string

    keys

    • keys(): IterableIterator<number>

    • Creates and returns an iterator of buf keys (indices).

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('buffer');

      for (const key of buf.keys()) {
        console.log(key);
      }
      // Prints:
      //   0
      //   1
      //   2
      //   3
      //   4
      //   5

      Returns IterableIterator<number>

      Since

      v1.1.0

      -

    lastIndexOf

    • lastIndexOf(value, byteOffset?, encoding?): number

    • Identical to buf.indexOf(), except the last occurrence of value is found +

    lastIndexOf

    • lastIndexOf(value, byteOffset?, encoding?): number

    • Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('this buffer is a buffer');

      console.log(buf.lastIndexOf('this'));
      // Prints: 0
      console.log(buf.lastIndexOf('buffer'));
      // Prints: 17
      console.log(buf.lastIndexOf(Buffer.from('buffer')));
      // Prints: 17
      console.log(buf.lastIndexOf(97));
      // Prints: 15 (97 is the decimal ASCII value for 'a')
      console.log(buf.lastIndexOf(Buffer.from('yolo')));
      // Prints: -1
      console.log(buf.lastIndexOf('buffer', 5));
      // Prints: 5
      console.log(buf.lastIndexOf('buffer', 4));
      // Prints: -1

      const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

      console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
      // Prints: 6
      console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
      // Prints: 4
      @@ -267,133 +267,133 @@
    • Optional encoding: BufferEncoding

      If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

    Returns number

    The index of the last occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v6.0.0

    -

    map

    • map(callbackfn, thisArg?): Uint8Array

    • Calls a defined callback function on each element of an array, and returns an array that +

    map

    • map(callbackfn, thisArg?): Uint8Array

    • 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

    readBigInt64BE

    • readBigInt64BE(offset?): bigint

    • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

      +

    Returns Uint8Array

    readBigInt64BE

    • readBigInt64BE(offset?): bigint

    • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigInt64LE

    • readBigInt64LE(offset?): bigint

    • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigInt64LE

    • readBigInt64LE(offset?): bigint

    • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUInt64BE

    • readBigUInt64BE(offset?): bigint

    • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigUInt64BE

    • readBigUInt64BE(offset?): bigint

    • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

      This function is also available under the readBigUint64BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

      console.log(buf.readBigUInt64BE(0));
      // Prints: 4294967295n

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUInt64LE

    • readBigUInt64LE(offset?): bigint

    • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigUInt64LE

    • readBigUInt64LE(offset?): bigint

    • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

      This function is also available under the readBigUint64LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

      console.log(buf.readBigUInt64LE(0));
      // Prints: 18446744069414584320n

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUint64BE

    • readBigUint64BE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64BE

      +

    readBigUint64BE

    • readBigUint64BE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64BE

      Since

      v14.10.0, v12.19.0

      -

    readBigUint64LE

    • readBigUint64LE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64LE

      +

    readBigUint64LE

    • readBigUint64LE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64LE

      Since

      v14.10.0, v12.19.0

      -

    readDoubleBE

    • readDoubleBE(offset?): number

    • Reads a 64-bit, big-endian double from buf at the specified offset.

      +

    readDoubleBE

    • readDoubleBE(offset?): number

    • Reads a 64-bit, big-endian double from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

      console.log(buf.readDoubleBE(0));
      // Prints: 8.20788039913184e-304

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

      Returns number

      Since

      v0.11.15

      -

    readDoubleLE

    • readDoubleLE(offset?): number

    • Reads a 64-bit, little-endian double from buf at the specified offset.

      +

    readDoubleLE

    • readDoubleLE(offset?): number

    • Reads a 64-bit, little-endian double from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

      console.log(buf.readDoubleLE(0));
      // Prints: 5.447603722011605e-270
      console.log(buf.readDoubleLE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

      Returns number

      Since

      v0.11.15

      -

    readFloatBE

    • readFloatBE(offset?): number

    • Reads a 32-bit, big-endian float from buf at the specified offset.

      +

    readFloatBE

    • readFloatBE(offset?): number

    • Reads a 32-bit, big-endian float from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4]);

      console.log(buf.readFloatBE(0));
      // Prints: 2.387939260590663e-38

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.11.15

      -

    readFloatLE

    • readFloatLE(offset?): number

    • Reads a 32-bit, little-endian float from buf at the specified offset.

      +

    readFloatLE

    • readFloatLE(offset?): number

    • Reads a 32-bit, little-endian float from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4]);

      console.log(buf.readFloatLE(0));
      // Prints: 1.539989614439558e-36
      console.log(buf.readFloatLE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.11.15

      -

    readInt16BE

    • readInt16BE(offset?): number

    • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

      +

    readInt16BE

    • readInt16BE(offset?): number

    • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 5]);

      console.log(buf.readInt16BE(0));
      // Prints: 5

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readInt16LE

    • readInt16LE(offset?): number

    • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

      +

    readInt16LE

    • readInt16LE(offset?): number

    • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 5]);

      console.log(buf.readInt16LE(0));
      // Prints: 1280
      console.log(buf.readInt16LE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readInt32BE

    • readInt32BE(offset?): number

    • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

      +

    readInt32BE

    • readInt32BE(offset?): number

    • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 0, 0, 5]);

      console.log(buf.readInt32BE(0));
      // Prints: 5

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readInt32LE

    • readInt32LE(offset?): number

    • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

      +

    readInt32LE

    • readInt32LE(offset?): number

    • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 0, 0, 5]);

      console.log(buf.readInt32LE(0));
      // Prints: 83886080
      console.log(buf.readInt32LE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readInt8

    • readInt8(offset?): number

    • Reads a signed 8-bit integer from buf at the specified offset.

      +

    readInt8

    • readInt8(offset?): number

    • Reads a signed 8-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([-1, 5]);

      console.log(buf.readInt8(0));
      // Prints: -1
      console.log(buf.readInt8(1));
      // Prints: 5
      console.log(buf.readInt8(2));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

      Returns number

      Since

      v0.5.0

      -

    readIntBE

    • readIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value +

    readIntBE

    • readIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readIntBE(0, 6).toString(16));
      // Prints: 1234567890ab
      console.log(buf.readIntBE(1, 6).toString(16));
      // Throws ERR_OUT_OF_RANGE.
      console.log(buf.readIntBE(1, 0).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readIntLE

    • readIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value +

    readIntLE

    • readIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readIntLE(0, 6).toString(16));
      // Prints: -546f87a9cbee

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUInt16BE

    • readUInt16BE(offset?): number

    • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

      +

    readUInt16BE

    • readUInt16BE(offset?): number

    • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint16BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56]);

      console.log(buf.readUInt16BE(0).toString(16));
      // Prints: 1234
      console.log(buf.readUInt16BE(1).toString(16));
      // Prints: 3456

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readUInt16LE

    • readUInt16LE(offset?): number

    • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

      +

    readUInt16LE

    • readUInt16LE(offset?): number

    • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint16LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56]);

      console.log(buf.readUInt16LE(0).toString(16));
      // Prints: 3412
      console.log(buf.readUInt16LE(1).toString(16));
      // Prints: 5634
      console.log(buf.readUInt16LE(2).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readUInt32BE

    • readUInt32BE(offset?): number

    • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

      +

    readUInt32BE

    • readUInt32BE(offset?): number

    • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint32BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

      console.log(buf.readUInt32BE(0).toString(16));
      // Prints: 12345678

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readUInt32LE

    • readUInt32LE(offset?): number

    • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

      +

    readUInt32LE

    • readUInt32LE(offset?): number

    • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint32LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

      console.log(buf.readUInt32LE(0).toString(16));
      // Prints: 78563412
      console.log(buf.readUInt32LE(1).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readUInt8

    • readUInt8(offset?): number

    • Reads an unsigned 8-bit integer from buf at the specified offset.

      +

    readUInt8

    • readUInt8(offset?): number

    • Reads an unsigned 8-bit integer from buf at the specified offset.

      This function is also available under the readUint8 alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, -2]);

      console.log(buf.readUInt8(0));
      // Prints: 1
      console.log(buf.readUInt8(1));
      // Prints: 254
      console.log(buf.readUInt8(2));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

      Returns number

      Since

      v0.5.0

      -

    readUIntBE

    • readUIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting +

    readUIntBE

    • readUIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.

      This function is also available under the readUintBE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readUIntBE(0, 6).toString(16));
      // Prints: 1234567890ab
      console.log(buf.readUIntBE(1, 6).toString(16));
      // Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ 
      Since
      v14.10.0, v12.19.0

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUIntLE

    • readUIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting +

    readUIntLE

    • readUIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.

      This function is also available under the readUintLE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readUIntLE(0, 6).toString(16));
      // Prints: ab9078563412
@@ -409,26 +409,26 @@ 
      Since
      v14.10.0, v12.19.0

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUint16BE

    • readUint16BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16BE

      +

    readUint16BE

    • readUint16BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16BE

      Since

      v14.9.0, v12.19.0

      -

    readUint16LE

    • readUint16LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16LE

      +

    readUint16LE

    • readUint16LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16LE

      Since

      v14.9.0, v12.19.0

      -

    readUint32BE

    • readUint32BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32BE

      +

    readUint32BE

    • readUint32BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32BE

      Since

      v14.9.0, v12.19.0

      -

    readUint32LE

    • readUint32LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32LE

      +

    readUint32LE

    • readUint32LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32LE

      Since

      v14.9.0, v12.19.0

      -

    readUint8

    • readUint8(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt8

      +

    readUint8

    • readUint8(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt8

      Since

      v14.9.0, v12.19.0

      -

    readUintBE

    • readUintBE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntBE

      +

    readUintBE

    • readUintBE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntBE

      Since

      v14.9.0, v12.19.0

      -

    readUintLE

    • readUintLE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntLE

      +

    readUintLE

    • readUintLE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntLE

      Since

      v14.9.0, v12.19.0

      -

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of +

    reduce

    • reduce(callbackfn): 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.

      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

    • reduce(callbackfn, initialValue): 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

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of +

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

        • Parameters

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

          Returns number

    Returns number

  • reduce(callbackfn, initialValue): 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

  • reduce<U>(callbackfn, initialValue): U

  • 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 @@ -436,12 +436,12 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. +

    Returns U

    reduceRight

    • reduceRight(callbackfn): 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.

      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

    • reduceRight(callbackfn, initialValue): 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

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. +

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

        • Parameters

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

          Returns number

    Returns number

  • reduceRight(callbackfn, initialValue): 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

  • reduceRight<U>(callbackfn, initialValue): 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.

    Type Parameters

    • U

    Parameters

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

      A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      +

    Returns U

    reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • 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

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

    Returns void

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      This method is not compatible with the Uint8Array.prototype.slice(), which is a superclass of Buffer. To copy the slice, useUint8Array.prototype.slice().

      @@ -462,19 +462,19 @@

      Since

      v14.9.0, v12.19.0

    • Optional end: number

      Where the new Buffer will end (not inclusive).

    Returns Buffer

    Since

    v0.3.0

    Deprecated

    Use subarray instead.

    -

    some

    • some(predicate, thisArg?): boolean

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

      +

    some

    • some(predicate, thisArg?): boolean

    • 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

    sort

    • sort(compareFn?): this

    • Sorts an array.

      +

    Returns boolean

    sort

    • sort(compareFn?): this

    • 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 this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

        • (a, b): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      Specifying end greater than buf.length will return the same result as that of end equal to buf.length.

      @@ -489,7 +489,7 @@

      Deprecated

      Use subarray instead.

      Parameters

      • Optional start: number

        Where the new Buffer will start.

      • Optional end: number

        Where the new Buffer will end (not inclusive).

      Returns Buffer

      Since

      v3.0.0

      -

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the +

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 2.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap16();

      console.log(buf1);
      // Prints: <Buffer 02 01 04 03 06 05 08 07>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap16();
      // Throws ERR_INVALID_BUFFER_SIZE.
      @@ -499,27 +499,27 @@

      Deprecated

      Use subarray instead.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the +

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 4.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap32();

      console.log(buf1);
      // Prints: <Buffer 04 03 02 01 08 07 06 05>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap32();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. +

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 8.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap64();

      console.log(buf1);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap64();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v6.3.0

      -

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls +

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls this function when stringifying a Buffer instance.

      Buffer.from() accepts objects in the format returned from this method. In particular, Buffer.from(buf.toJSON()) works like Buffer.from(buf).

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
      const json = JSON.stringify(buf);

      console.log(json);
      // Prints: {"type":"Buffer","data":[1,2,3,4,5]}

      const copy = JSON.parse(json, (key, value) => {
        return value &#x26;&#x26; value.type === 'Buffer' ?
          Buffer.from(value) :
          value;
      });

      console.log(copy);
      // Prints: <Buffer 01 02 03 04 05>

      Returns {
          data: number[];
          type: "Buffer";
      }

      • data: number[]
      • type: "Buffer"

      Since

      v0.9.2

      -

    toLocaleString

    • toLocaleString(): string

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

      -

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      +

    toLocaleString

    • toLocaleString(): string

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

      +

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8, then each invalid byte is replaced with the replacement character U+FFFD.

      The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@

      Deprecated

      Use subarray instead.

    • Optional start: number

      The byte offset to start decoding at.

    • Optional end: number

      The byte offset to stop decoding at (not inclusive).

    Returns string

    Since

    v0.1.90

    -

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      -

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is +

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      +

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is called automatically when a Buffer is used in a for..of statement.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('buffer');

      for (const value of buf.values()) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      for (const value of buf) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      Returns IterableIterator<number>

      Since

      v1.1.0

      -

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did +

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did not contain enough space to fit the entire string, only part of string will be written. However, partially encoded characters will not be written.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(256);

      const len = buf.write('\u00bd + \u00bc = \u00be', 0);

      console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
      // Prints: 12 bytes: ½ + ¼ = ¾

      const buffer = Buffer.alloc(10);

      const length = buffer.write('abcd', 8);

      console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
      // Prints: 2 bytes : ab
@@ -545,7 +545,7 @@ 
      Deprecated
      Use subarray instead.
    • Optional encoding: BufferEncoding

      The character encoding of string.

    Returns number

    Number of bytes written.

    Since

    v0.1.90

    -
  • write(string, offset, encoding?): number

  • Parameters

    Returns number

  • write(string, offset, length, encoding?): number

  • Parameters

    • string: string
    • offset: number
    • length: number
    • Optional encoding: BufferEncoding

    Returns number

    • writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +
    • write(string, offset, encoding?): number

    • Parameters

      Returns number

    • write(string, offset, length, encoding?): number

    • Parameters

      • string: string
      • offset: number
      • length: number
      • Optional encoding: BufferEncoding

      Returns number

    writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64BE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>
      @@ -553,7 +553,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      +

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64LE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>
      @@ -561,7 +561,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      This function is also available under the writeBigUint64BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de ca fa fe ca ce fa de>
      @@ -569,7 +569,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      +

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de fa ce ca fe fa ca de>

      This function is also available under the writeBigUint64LE alias.

      @@ -577,11 +577,11 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      +

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      Since

      v14.10.0, v12.19.0

      -

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      +

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      Since

      v14.10.0, v12.19.0

      -

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleBE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
      @@ -589,7 +589,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleLE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
      @@ -597,7 +597,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is +

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatBE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer 4f 4a fe bb>
      @@ -605,7 +605,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is +

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatLE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer bb fe 4a 4f>
      @@ -613,7 +613,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16BE(0x0102, 0);

      console.log(buf);
      // Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16LE(0x0304, 0);

      console.log(buf);
      // Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32BE(0x01020304, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32LE(0x05060708, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid +

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid signed 8-bit integer. Behavior is undefined when value is anything other than a signed 8-bit integer.

      value is interpreted and written as a two's complement signed integer.

      @@ -659,7 +659,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a +

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
      @@ -668,7 +668,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
      @@ -677,7 +677,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16BE(0xdead, 0);
      buf.writeUInt16BE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is +

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16LE(0xdead, 0);
      buf.writeUInt16LE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32BE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is +

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32LE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a +

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer. Behavior is undefined when value is anything other than an unsigned 8-bit integer.

      This function is also available under the writeUint8 alias.

      @@ -723,7 +723,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintBE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintLE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      +

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      +

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      +

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      +

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      +

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      Since

      v14.9.0, v12.19.0

      -

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      +

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      Since

      v14.9.0, v12.19.0

      -

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      +

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      Since

      v14.9.0, v12.19.0

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.BufferConstructor.html b/interfaces/_divviup_prio3._internal_.BufferConstructor.html index 556cac943..e7b5aeb8a 100644 --- a/interfaces/_divviup_prio3._internal_.BufferConstructor.html +++ b/interfaces/_divviup_prio3._internal_.BufferConstructor.html @@ -1,43 +1,43 @@ -BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. +BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'

    -
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor -

    Properties

    poolSize -

    Methods

    alloc -allocUnsafe -allocUnsafeSlow -byteLength -compare -concat -copyBytesFrom -from -isBuffer -isEncoding -of -

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      +
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor +

    Properties

    poolSize +

    Methods

    alloc +allocUnsafe +allocUnsafeSlow +byteLength +compare +concat +copyBytesFrom +from +isBuffer +isEncoding +of +

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: BufferEncoding

        encoding to use, optional. Default is 'utf8'

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

      -
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      +
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as +

    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.

      Parameters

      • arrayBuffer: ArrayBuffer | SharedArrayBuffer

        The ArrayBuffer with which to share memory.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: readonly any[]

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      +
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(buffer) instead.

      -

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used +

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used for pooling. This value may be modified.

    Since

    v0.11.3

    -

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      +

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(5);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00>

      If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      @@ -56,7 +56,7 @@
    • Optional fill: string | number | Uint8Array

      A value to pre-fill the new Buffer with.

    • Optional encoding: BufferEncoding

      If fill is a string, this is its encoding.

    Returns Buffer

    Since

    v5.10.0

    -

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      +

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use Buffer.alloc() instead to initializeBuffer instances with zeroes.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(10);

      console.log(buf);
      // Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

      buf.fill(0);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
 additional performance that Buffer.allocUnsafe() provides.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.10.0

      -

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if +

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if size is 0.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use buf.fill(0) to initialize @@ -93,7 +93,7 @@

      A TypeError will be thrown if size is not a number.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.12.0

      -

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. +

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. This is not the same as String.prototype.length, which does not account for the encoding that is used to convert the string into bytes.

      For 'base64', 'base64url', and 'hex', this function assumes valid input. @@ -110,12 +110,12 @@

    • Optional encoding: BufferEncoding

      If string is a string, this is its encoding.

    Returns number

    The number of bytes contained within string.

    Since

    v0.1.90

    -

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      +

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from('1234');
      const buf2 = Buffer.from('0123');
      const arr = [buf1, buf2];

      console.log(arr.sort(Buffer.compare));
      // Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
      // (This result is equal to: [buf2, buf1].)

      Parameters

      • buf1: Uint8Array
      • buf2: Uint8Array

      Returns -1 | 0 | 1

      Either -1, 0, or 1, depending on the result of the comparison. See compare for details.

      Since

      v0.11.13

      -

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      +

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      If the list has no items, or if the totalLength is 0, then a new zero-lengthBuffer is returned.

      If totalLength is not provided, it is calculated from the Buffer instances in list by adding their lengths.

      @@ -128,14 +128,14 @@

      Parameters

      • list: readonly Uint8Array[]

        List of Buffer or Uint8Array instances to concatenate.

      • Optional totalLength: number

        Total length of the Buffer instances in list when concatenated.

      Returns Buffer

      Since

      v0.7.11

      -

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      +

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      const u16 = new Uint16Array([0, 0xffff]);
      const buf = Buffer.copyBytesFrom(u16, 1, 1);
      u16[1] = 0;
      console.log(buf.length); // 2
      console.log(buf[0]); // 255
      console.log(buf[1]); // 255

      Parameters

      • view: TypedArray

        The {TypedArray} to copy.

      • Optional offset: number

        The starting offset within view.

      • Optional length: number

        The number of elements from view to copy.

      Returns Buffer

      Since

      v19.8.0

      -

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. +

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.

      import { Buffer } from 'node:buffer';

      // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
      const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
      @@ -146,20 +146,20 @@ appropriate for Buffer.from() variants.

      Buffer.from(array) and Buffer.from(string) may also use the internalBuffer pool like Buffer.allocUnsafe() does.

      Parameters

      Returns Buffer

      Since

      v5.10.0

      -
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      +
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      Parameters

      • data: Uint8Array | readonly number[]

        data to create a new Buffer

        -

      Returns Buffer

    • from(data): Buffer

    • Parameters

      Returns Buffer

    • from(str, encoding?): Buffer

    • Creates a new Buffer containing the given JavaScript string {str}. +

    Returns Buffer

  • from(data): Buffer

  • Parameters

    Returns Buffer

  • from(str, encoding?): Buffer

  • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

    -

    Parameters

    Returns Buffer

    • isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      +

      Parameters

      Returns Buffer

    isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      import { Buffer } from 'node:buffer';

      Buffer.isBuffer(Buffer.alloc(10)); // true
      Buffer.isBuffer(Buffer.from('foo')); // true
      Buffer.isBuffer('a string'); // false
      Buffer.isBuffer([]); // false
      Buffer.isBuffer(new Uint8Array(1024)); // false

      Parameters

      • obj: any

      Returns obj is Buffer

      Since

      v0.1.101

      -

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, +

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, or false otherwise.

      import { Buffer } from 'node:buffer';

      console.log(Buffer.isEncoding('utf8'));
      // Prints: true

      console.log(Buffer.isEncoding('hex'));
      // Prints: true

      console.log(Buffer.isEncoding('utf/8'));
      // Prints: false

      console.log(Buffer.isEncoding(''));
      // Prints: false

      Parameters

      • encoding: string

        A character encoding name to check.

      Returns encoding is BufferEncoding

      Since

      v0.9.1

      -

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      -

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      +

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.FieldConstructorArgs.html b/interfaces/_divviup_prio3._internal_.FieldConstructorArgs.html index 494b54f2c..ca6a2310a 100644 --- a/interfaces/_divviup_prio3._internal_.FieldConstructorArgs.html +++ b/interfaces/_divviup_prio3._internal_.FieldConstructorArgs.html @@ -1,5 +1,5 @@ -FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize -genOrder -generator -modulus -

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +FieldConstructorArgs | Documentation

    Interface FieldConstructorArgs

    interface FieldConstructorArgs {
        encodedSize: number;
        genOrder: bigint;
        generator: {
            base: bigint;
            exponent: bigint;
        };
        modulus: bigint;
    }

    Properties

    encodedSize +genOrder +generator +modulus +

    Properties

    encodedSize

    encodedSize: number

    genOrder

    genOrder: bigint

    generator

    generator: {
        base: bigint;
        exponent: bigint;
    }

    Type declaration

    • base: bigint
    • exponent: bigint

    modulus

    modulus: bigint

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.Flp.html b/interfaces/_divviup_prio3._internal_.Flp.html index 159550e76..08388cffb 100644 --- a/interfaces/_divviup_prio3._internal_.Flp.html +++ b/interfaces/_divviup_prio3._internal_.Flp.html @@ -1,15 +1,15 @@ -Flp | Documentation

    Interface Flp<Measurement, AggResult>

    interface Flp<Measurement, AggResult> {
        field: Field;
        jointRandLen: number;
        measurementLen: number;
        outputLen: number;
        proofLen: number;
        proveRandLen: number;
        queryRandLen: number;
        verifierLen: number;
        decide(verifier): boolean;
        decode(output, numMeasurements): AggResult;
        encode(measurement): bigint[];
        prove(encodedMeasurement, proveRand, jointRand): bigint[];
        query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[];
        truncate(encodedMeasurement): bigint[];
    }

    Type Parameters

    • Measurement
    • AggResult

    Properties

    field -jointRandLen -measurementLen -outputLen -proofLen -proveRandLen -queryRandLen -verifierLen -

    Methods

    decide -decode -encode -prove -query -truncate -

    Properties

    field

    field: Field

    jointRandLen

    jointRandLen: number

    measurementLen

    measurementLen: number

    outputLen

    outputLen: number

    proofLen

    proofLen: number

    proveRandLen

    proveRandLen: number

    queryRandLen

    queryRandLen: number

    verifierLen

    verifierLen: number

    Methods

    decide

    decode

    encode

    prove

    • prove(encodedMeasurement, proveRand, jointRand): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proveRand: bigint[]
      • jointRand: bigint[]

      Returns bigint[]

    query

    • query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proof: bigint[]
      • queryRand: bigint[]
      • jointRand: bigint[]
      • shares: number

      Returns bigint[]

    truncate

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Flp | Documentation

    Interface Flp<Measurement, AggResult>

    interface Flp<Measurement, AggResult> {
        field: Field;
        jointRandLen: number;
        measurementLen: number;
        outputLen: number;
        proofLen: number;
        proveRandLen: number;
        queryRandLen: number;
        verifierLen: number;
        decide(verifier): boolean;
        decode(output, numMeasurements): AggResult;
        encode(measurement): bigint[];
        prove(encodedMeasurement, proveRand, jointRand): bigint[];
        query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[];
        truncate(encodedMeasurement): bigint[];
    }

    Type Parameters

    • Measurement
    • AggResult

    Properties

    field +jointRandLen +measurementLen +outputLen +proofLen +proveRandLen +queryRandLen +verifierLen +

    Methods

    decide +decode +encode +prove +query +truncate +

    Properties

    field

    field: Field

    jointRandLen

    jointRandLen: number

    measurementLen

    measurementLen: number

    outputLen

    outputLen: number

    proofLen

    proofLen: number

    proveRandLen

    proveRandLen: number

    queryRandLen

    queryRandLen: number

    verifierLen

    verifierLen: number

    Methods

    decide

    decode

    encode

    prove

    • prove(encodedMeasurement, proveRand, jointRand): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proveRand: bigint[]
      • jointRand: bigint[]

      Returns bigint[]

    query

    • query(encodedMeasurement, proof, queryRand, jointRand, shares): bigint[]

    • Parameters

      • encodedMeasurement: bigint[]
      • proof: bigint[]
      • queryRand: bigint[]
      • jointRand: bigint[]
      • shares: number

      Returns bigint[]

    truncate

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.HistogramArgs.html b/interfaces/_divviup_prio3._internal_.HistogramArgs.html index 0cd90f8be..39b220a81 100644 --- a/interfaces/_divviup_prio3._internal_.HistogramArgs.html +++ b/interfaces/_divviup_prio3._internal_.HistogramArgs.html @@ -1,4 +1,4 @@ -HistogramArgs | Documentation

    Interface HistogramArgs

    interface HistogramArgs {
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    chunkLength -length -shares -

    Properties

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +HistogramArgs | Documentation

    Interface HistogramArgs

    interface HistogramArgs {
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    chunkLength +length +shares +

    Properties

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.IterableIterator.html b/interfaces/_divviup_prio3._internal_.IterableIterator.html index c02dd9f98..7235040b3 100644 --- a/interfaces/_divviup_prio3._internal_.IterableIterator.html +++ b/interfaces/_divviup_prio3._internal_.IterableIterator.html @@ -1,5 +1,5 @@ -IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] -next -return? -throw? -

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] +next +return? +throw? +

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.Iterator.html b/interfaces/_divviup_prio3._internal_.Iterator.html index d38df496f..6def212bf 100644 --- a/interfaces/_divviup_prio3._internal_.Iterator.html +++ b/interfaces/_divviup_prio3._internal_.Iterator.html @@ -1,4 +1,4 @@ -Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next -return? -throw? -

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next +return? +throw? +

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.IteratorReturnResult.html b/interfaces/_divviup_prio3._internal_.IteratorReturnResult.html index 694fe2296..1c269cc9d 100644 --- a/interfaces/_divviup_prio3._internal_.IteratorReturnResult.html +++ b/interfaces/_divviup_prio3._internal_.IteratorReturnResult.html @@ -1,3 +1,3 @@ -IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done -value -

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done +value +

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.IteratorYieldResult.html b/interfaces/_divviup_prio3._internal_.IteratorYieldResult.html index e8c9f50bb..5ca2ecbcd 100644 --- a/interfaces/_divviup_prio3._internal_.IteratorYieldResult.html +++ b/interfaces/_divviup_prio3._internal_.IteratorYieldResult.html @@ -1,3 +1,3 @@ -IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? -value -

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? +value +

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.PrepTestVector.html b/interfaces/_divviup_prio3._internal_.PrepTestVector.html index 20bd470d8..4002a5821 100644 --- a/interfaces/_divviup_prio3._internal_.PrepTestVector.html +++ b/interfaces/_divviup_prio3._internal_.PrepTestVector.html @@ -1,9 +1,9 @@ -PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares -measurement -nonce -out_shares -prep_messages -prep_shares -public_share -rand -

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares +measurement +nonce +out_shares +prep_messages +prep_shares +public_share +rand +

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.SharedArrayBuffer.html b/interfaces/_divviup_prio3._internal_.SharedArrayBuffer.html index 2e941f784..0177e1179 100644 --- a/interfaces/_divviup_prio3._internal_.SharedArrayBuffer.html +++ b/interfaces/_divviup_prio3._internal_.SharedArrayBuffer.html @@ -1,7 +1,7 @@ -SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] -[toStringTag] -byteLength -

    Methods

    slice -

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    -

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      -

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] +[toStringTag] +byteLength +

    Methods

    slice +

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    +

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      +

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.SharedArrayBufferConstructor.html b/interfaces/_divviup_prio3._internal_.SharedArrayBufferConstructor.html index c6cf0eb64..83384f915 100644 --- a/interfaces/_divviup_prio3._internal_.SharedArrayBufferConstructor.html +++ b/interfaces/_divviup_prio3._internal_.SharedArrayBufferConstructor.html @@ -1,3 +1,3 @@ -SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor -

    Properties

    prototype -

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor +

    Properties

    prototype +

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.SumVecArgs.html b/interfaces/_divviup_prio3._internal_.SumVecArgs.html index 70cefc792..725c54efe 100644 --- a/interfaces/_divviup_prio3._internal_.SumVecArgs.html +++ b/interfaces/_divviup_prio3._internal_.SumVecArgs.html @@ -1,5 +1,5 @@ -SumVecArgs | Documentation

    Interface SumVecArgs

    interface SumVecArgs {
        bits: number;
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    bits -chunkLength -length -shares -

    Properties

    bits

    bits: number

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SumVecArgs | Documentation

    Interface SumVecArgs

    interface SumVecArgs {
        bits: number;
        chunkLength: number;
        length: number;
        shares: number;
    }

    Properties

    bits +chunkLength +length +shares +

    Properties

    bits

    bits: number

    chunkLength

    chunkLength: number

    length

    length: number

    shares

    shares: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.TestVector.html b/interfaces/_divviup_prio3._internal_.TestVector.html index 6869f73a8..15bd16bb8 100644 --- a/interfaces/_divviup_prio3._internal_.TestVector.html +++ b/interfaces/_divviup_prio3._internal_.TestVector.html @@ -1,7 +1,7 @@ -TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param -agg_result -agg_shares -prep -shares -verify_key -

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param +agg_result +agg_shares +prep +shares +verify_key +

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_prio3._internal_.XofConstructor.html b/interfaces/_divviup_prio3._internal_.XofConstructor.html index ac7218dd6..69774fb8a 100644 --- a/interfaces/_divviup_prio3._internal_.XofConstructor.html +++ b/interfaces/_divviup_prio3._internal_.XofConstructor.html @@ -1,5 +1,5 @@ -XofConstructor | Documentation

    Interface XofConstructor

    interface XofConstructor {
        new XofConstructornew (seed, dst, binder): Xof;
        seedSize: number;
        deriveSeed(seed, dst, binder): Promise<Uint8Array>;
        expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>;
    }

    Constructors

    constructor -

    Properties

    seedSize -

    Methods

    deriveSeed -expandIntoVec -

    Constructors

    constructor

    • new XofConstructor(seed, dst, binder): Xof

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Xof

    Properties

    seedSize

    seedSize: number

    Methods

    deriveSeed

    • deriveSeed(seed, dst, binder): Promise<Uint8Array>

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Promise<Uint8Array>

    expandIntoVec

    • expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>

    • Parameters

      • field: Field
      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array
      • length: number

      Returns Promise<bigint[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +XofConstructor | Documentation

    Interface XofConstructor

    interface XofConstructor {
        new XofConstructornew (seed, dst, binder): Xof;
        seedSize: number;
        deriveSeed(seed, dst, binder): Promise<Uint8Array>;
        expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>;
    }

    Constructors

    constructor +

    Properties

    seedSize +

    Methods

    deriveSeed +expandIntoVec +

    Constructors

    constructor

    • new XofConstructor(seed, dst, binder): Xof

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Xof

    Properties

    seedSize

    seedSize: number

    Methods

    deriveSeed

    • deriveSeed(seed, dst, binder): Promise<Uint8Array>

    • Parameters

      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array

      Returns Promise<Uint8Array>

    expandIntoVec

    • expandIntoVec(field, seed, dst, binder, length): Promise<bigint[]>

    • Parameters

      • field: Field
      • seed: Uint8Array
      • dst: Uint8Array
      • binder: Uint8Array
      • length: number

      Returns Promise<bigint[]>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf.ClientVdaf.html b/interfaces/_divviup_vdaf.ClientVdaf.html index bf1864e99..6f7f37384 100644 --- a/interfaces/_divviup_vdaf.ClientVdaf.html +++ b/interfaces/_divviup_vdaf.ClientVdaf.html @@ -1,6 +1,6 @@ -ClientVdaf | Documentation

    Interface ClientVdaf<Measurement>

    interface ClientVdaf<Measurement> {
        nonceSize: number;
        randSize: number;
        rounds: number;
        shares: number;
        shardEncoded(measurement, nonce, rand): Promise<{
            inputShares: Buffer[];
            publicShare: Buffer;
        }>;
    }

    Type Parameters

    • Measurement

    Properties

    nonceSize -randSize -rounds -shares -

    Methods

    shardEncoded -

    Properties

    nonceSize

    nonceSize: number

    randSize

    randSize: number

    rounds

    rounds: number

    shares

    shares: number

    Methods

    shardEncoded

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +ClientVdaf | Documentation

    Interface ClientVdaf<Measurement>

    interface ClientVdaf<Measurement> {
        nonceSize: number;
        randSize: number;
        rounds: number;
        shares: number;
        shardEncoded(measurement, nonce, rand): Promise<{
            inputShares: Buffer[];
            publicShare: Buffer;
        }>;
    }

    Type Parameters

    • Measurement

    Properties

    nonceSize +randSize +rounds +shares +

    Methods

    shardEncoded +

    Properties

    nonceSize

    nonceSize: number

    randSize

    randSize: number

    rounds

    rounds: number

    shares

    shares: number

    Methods

    shardEncoded

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf.PrepTestVector.html b/interfaces/_divviup_vdaf.PrepTestVector.html index d2f22e9b8..ccce253ca 100644 --- a/interfaces/_divviup_vdaf.PrepTestVector.html +++ b/interfaces/_divviup_vdaf.PrepTestVector.html @@ -1,9 +1,9 @@ -PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares -measurement -nonce -out_shares -prep_messages -prep_shares -public_share -rand -

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +PrepTestVector | Documentation

    Interface PrepTestVector<M>

    interface PrepTestVector<M> {
        input_shares: string[];
        measurement: M;
        nonce: string;
        out_shares: string[][];
        prep_messages: string[];
        prep_shares: string[][];
        public_share: string;
        rand: string;
    }

    Type Parameters

    • M

    Properties

    input_shares +measurement +nonce +out_shares +prep_messages +prep_shares +public_share +rand +

    Properties

    input_shares

    input_shares: string[]

    measurement

    measurement: M

    nonce

    nonce: string

    out_shares

    out_shares: string[][]

    prep_messages

    prep_messages: string[]

    prep_shares

    prep_shares: string[][]

    public_share

    public_share: string

    rand

    rand: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf.TestVector.html b/interfaces/_divviup_vdaf.TestVector.html index 9d22f3806..fa23fcb05 100644 --- a/interfaces/_divviup_vdaf.TestVector.html +++ b/interfaces/_divviup_vdaf.TestVector.html @@ -1,7 +1,7 @@ -TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param -agg_result -agg_shares -prep -shares -verify_key -

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +TestVector | Documentation

    Interface TestVector<AP, M, AR>

    interface TestVector<AP, M, AR> {
        agg_param: AP;
        agg_result: AR;
        agg_shares: string[];
        prep: PrepTestVector<M>[];
        shares: number;
        verify_key: string;
    }

    Type Parameters

    • AP
    • M
    • AR

    Properties

    agg_param +agg_result +agg_shares +prep +shares +verify_key +

    Properties

    agg_param

    agg_param: AP

    agg_result

    agg_result: AR

    agg_shares

    agg_shares: string[]

    prep

    prep: PrepTestVector<M>[]

    shares

    shares: number

    verify_key

    verify_key: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.ArrayLike.html b/interfaces/_divviup_vdaf._internal_.ArrayLike.html index b5d722efb..df5dda802 100644 --- a/interfaces/_divviup_vdaf._internal_.ArrayLike.html +++ b/interfaces/_divviup_vdaf._internal_.ArrayLike.html @@ -1,2 +1,2 @@ -ArrayLike | Documentation

    Interface ArrayLike<T>

    interface ArrayLike<T> {
        length: number;
        [n: number]: T;
    }

    Type Parameters

    • T

    Indexable

    [n: number]: T

    Properties

    length -

    Properties

    Readonly length

    length: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +ArrayLike | Documentation

    Interface ArrayLike<T>

    interface ArrayLike<T> {
        length: number;
        [n: number]: T;
    }

    Type Parameters

    • T

    Indexable

    [n: number]: T

    Properties

    length +

    Properties

    Readonly length

    length: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.Buffer.html b/interfaces/_divviup_vdaf._internal_.Buffer.html index a2f489f96..579fe85ce 100644 --- a/interfaces/_divviup_vdaf._internal_.Buffer.html +++ b/interfaces/_divviup_vdaf._internal_.Buffer.html @@ -1,116 +1,116 @@ -Buffer | Documentation

    Interface Buffer

    interface Buffer {
        BYTES_PER_ELEMENT: number;
        [toStringTag]: "Uint8Array";
        buffer: ArrayBufferLike;
        byteLength: number;
        byteOffset: number;
        length: number;
        [iterator](): IterableIterator<number>;
        at(index): undefined | number;
        compare(target, targetStart?, targetEnd?, sourceStart?, sourceEnd?): -1 | 0 | 1;
        copy(target, targetStart?, sourceStart?, sourceEnd?): number;
        copyWithin(target, start, end?): this;
        entries(): IterableIterator<[number, number]>;
        equals(otherBuffer): boolean;
        every(predicate, thisArg?): boolean;
        fill(value, offset?, end?, encoding?): this;
        filter(predicate, thisArg?): Uint8Array;
        find(predicate, thisArg?): undefined | number;
        findIndex(predicate, thisArg?): number;
        forEach(callbackfn, thisArg?): void;
        includes(value, byteOffset?, encoding?): boolean;
        indexOf(value, byteOffset?, encoding?): number;
        join(separator?): string;
        keys(): IterableIterator<number>;
        lastIndexOf(value, byteOffset?, encoding?): number;
        map(callbackfn, thisArg?): Uint8Array;
        readBigInt64BE(offset?): bigint;
        readBigInt64LE(offset?): bigint;
        readBigUInt64BE(offset?): bigint;
        readBigUInt64LE(offset?): bigint;
        readBigUint64BE(offset?): bigint;
        readBigUint64LE(offset?): bigint;
        readDoubleBE(offset?): number;
        readDoubleLE(offset?): number;
        readFloatBE(offset?): number;
        readFloatLE(offset?): number;
        readInt16BE(offset?): number;
        readInt16LE(offset?): number;
        readInt32BE(offset?): number;
        readInt32LE(offset?): number;
        readInt8(offset?): number;
        readIntBE(offset, byteLength): number;
        readIntLE(offset, byteLength): number;
        readUInt16BE(offset?): number;
        readUInt16LE(offset?): number;
        readUInt32BE(offset?): number;
        readUInt32LE(offset?): number;
        readUInt8(offset?): number;
        readUIntBE(offset, byteLength): number;
        readUIntLE(offset, byteLength): number;
        readUint16BE(offset?): number;
        readUint16LE(offset?): number;
        readUint32BE(offset?): number;
        readUint32LE(offset?): number;
        readUint8(offset?): number;
        readUintBE(offset, byteLength): number;
        readUintLE(offset, byteLength): number;
        reduce(callbackfn): number;
        reduce(callbackfn, initialValue): number;
        reduce<U>(callbackfn, initialValue): U;
        reduceRight(callbackfn): number;
        reduceRight(callbackfn, initialValue): number;
        reduceRight<U>(callbackfn, initialValue): U;
        reverse(): this;
        set(array, offset?): void;
        slice(start?, end?): Buffer;
        some(predicate, thisArg?): boolean;
        sort(compareFn?): this;
        subarray(start?, end?): Buffer;
        swap16(): Buffer;
        swap32(): Buffer;
        swap64(): Buffer;
        toJSON(): {
            data: number[];
            type: "Buffer";
        };
        toLocaleString(): string;
        toString(encoding?, start?, end?): string;
        valueOf(): Uint8Array;
        values(): IterableIterator<number>;
        write(string, encoding?): number;
        write(string, offset, encoding?): number;
        write(string, offset, length, encoding?): number;
        writeBigInt64BE(value, offset?): number;
        writeBigInt64LE(value, offset?): number;
        writeBigUInt64BE(value, offset?): number;
        writeBigUInt64LE(value, offset?): number;
        writeBigUint64BE(value, offset?): number;
        writeBigUint64LE(value, offset?): number;
        writeDoubleBE(value, offset?): number;
        writeDoubleLE(value, offset?): number;
        writeFloatBE(value, offset?): number;
        writeFloatLE(value, offset?): number;
        writeInt16BE(value, offset?): number;
        writeInt16LE(value, offset?): number;
        writeInt32BE(value, offset?): number;
        writeInt32LE(value, offset?): number;
        writeInt8(value, offset?): number;
        writeIntBE(value, offset, byteLength): number;
        writeIntLE(value, offset, byteLength): number;
        writeUInt16BE(value, offset?): number;
        writeUInt16LE(value, offset?): number;
        writeUInt32BE(value, offset?): number;
        writeUInt32LE(value, offset?): number;
        writeUInt8(value, offset?): number;
        writeUIntBE(value, offset, byteLength): number;
        writeUIntLE(value, offset, byteLength): number;
        writeUint16BE(value, offset?): number;
        writeUint16LE(value, offset?): number;
        writeUint32BE(value, offset?): number;
        writeUint32LE(value, offset?): number;
        writeUint8(value, offset?): number;
        writeUintBE(value, offset, byteLength): number;
        writeUintLE(value, offset, byteLength): number;
    }

    Hierarchy

    • Uint8Array
      • Buffer

    Properties

    BYTES_PER_ELEMENT -[toStringTag] -buffer -byteLength -byteOffset -length -

    Methods

    [iterator] -at -compare -copy -copyWithin -entries -equals -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -readBigInt64BE -readBigInt64LE -readBigUInt64BE -readBigUInt64LE -readBigUint64BE -readBigUint64LE -readDoubleBE -readDoubleLE -readFloatBE -readFloatLE -readInt16BE -readInt16LE -readInt32BE -readInt32LE -readInt8 -readIntBE -readIntLE -readUInt16BE -readUInt16LE -readUInt32BE -readUInt32LE -readUInt8 -readUIntBE -readUIntLE -readUint16BE -readUint16LE -readUint32BE -readUint32LE -readUint8 -readUintBE -readUintLE -reduce -reduceRight -reverse -set -slice -some -sort -subarray -swap16 -swap32 -swap64 -toJSON -toLocaleString -toString -valueOf -values -write -writeBigInt64BE -writeBigInt64LE -writeBigUInt64BE -writeBigUInt64LE -writeBigUint64BE -writeBigUint64LE -writeDoubleBE -writeDoubleLE -writeFloatBE -writeFloatLE -writeInt16BE -writeInt16LE -writeInt32BE -writeInt32LE -writeInt8 -writeIntBE -writeIntLE -writeUInt16BE -writeUInt16LE -writeUInt32BE -writeUInt32LE -writeUInt8 -writeUIntBE -writeUIntLE -writeUint16BE -writeUint16LE -writeUint32BE -writeUint32LE -writeUint8 -writeUintBE -writeUintLE -

    Properties

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Uint8Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Methods

    [iterator]

    • [iterator](): IterableIterator<number>

    • Returns IterableIterator<number>

    at

    copy

    • copy(target, targetStart?, sourceStart?, sourceEnd?): number

    • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

      +

    copy

    • copy(target, targetStart?, sourceStart?, sourceEnd?): number

    • Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

      TypedArray.prototype.set() performs the same operation, and is available for all TypedArrays, including Node.js Buffers, although it takes different function arguments.

      @@ -143,30 +143,30 @@
    • Optional sourceEnd: number

      The offset within buf at which to stop copying (not inclusive).

    Returns number

    The number of bytes copied.

    Since

    v0.1.90

    -

    copyWithin

    • copyWithin(target, start, end?): this

    • Returns the this object after copying a section of the array identified by start and end +

    copyWithin

    • copyWithin(target, start, end?): this

    • 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.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: number

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

        -

      Returns this

    entries

    Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Creates and returns an iterator of [index, byte] pairs from the contents of buf.

      import { Buffer } from 'node:buffer';

      // Log the entire contents of a `Buffer`.

      const buf = Buffer.from('buffer');

      for (const pair of buf.entries()) {
        console.log(pair);
      }
      // Prints:
      //   [0, 98]
      //   [1, 117]
      //   [2, 102]
      //   [3, 102]
      //   [4, 101]
      //   [5, 114]

      Returns IterableIterator<[number, number]>

      Since

      v1.1.0

      -

    equals

    • equals(otherBuffer): boolean

    • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

      +

    equals

    • equals(otherBuffer): boolean

    • Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from('ABC');
      const buf2 = Buffer.from('414243', 'hex');
      const buf3 = Buffer.from('ABCD');

      console.log(buf1.equals(buf2));
      // Prints: true
      console.log(buf1.equals(buf3));
      // Prints: false

      Parameters

      • otherBuffer: Uint8Array

        A Buffer or Uint8Array with which to compare buf.

      Returns boolean

      Since

      v0.11.13

      -

    every

    • every(predicate, thisArg?): boolean

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

      +

    every

    • every(predicate, thisArg?): boolean

    • 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

    fill

    • fill(value, offset?, end?, encoding?): this

    • Fills buf with the specified value. If the offset and end are not given, +

    Returns boolean

    fill

    • fill(value, offset?, end?, encoding?): this

    • Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled:

      import { Buffer } from 'node:buffer';

      // Fill a `Buffer` with the ASCII character 'h'.

      const b = Buffer.allocUnsafe(50).fill('h');

      console.log(b.toString());
      // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

      // Fill a buffer with empty string
      const c = Buffer.allocUnsafe(5).fill('');

      console.log(c.fill(''));
      // Prints: <Buffer 00 00 00 00 00>
      @@ -187,31 +187,31 @@
    • Optional encoding: BufferEncoding

      The encoding for value if value is a string.

    Returns this

    A reference to buf.

    Since

    v0.5.0

    -

    filter

    • filter(predicate, thisArg?): Uint8Array

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

      +

    filter

    • filter(predicate, thisArg?): Uint8Array

    • 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

    find

    • find(predicate, thisArg?): undefined | number

    • Returns the value of the first element in the array where predicate is true, and undefined +

    Returns Uint8Array

    find

    • find(predicate, thisArg?): undefined | number

    • 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

    findIndex

    • findIndex(predicate, thisArg?): number

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

    Returns undefined | number

    findIndex

    • findIndex(predicate, thisArg?): 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

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      +

    Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • 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

    includes

    • includes(value, byteOffset?, encoding?): boolean

    • Equivalent to buf.indexOf() !== -1.

      +

    Returns void

    includes

    • includes(value, byteOffset?, encoding?): boolean

    • Equivalent to buf.indexOf() !== -1.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('this is a buffer');

      console.log(buf.includes('this'));
      // Prints: true
      console.log(buf.includes('is'));
      // Prints: true
      console.log(buf.includes(Buffer.from('a buffer')));
      // Prints: true
      console.log(buf.includes(97));
      // Prints: true (97 is the decimal ASCII value for 'a')
      console.log(buf.includes(Buffer.from('a buffer example')));
      // Prints: false
      console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
      // Prints: true
      console.log(buf.includes('this', 4));
      // Prints: false

      Parameters

      • value: string | number | Buffer

        What to search for.

        @@ -219,7 +219,7 @@
      • Optional encoding: BufferEncoding

        If value is a string, this is its encoding.

      Returns boolean

      true if value was found in buf, false otherwise.

      Since

      v5.3.0

      -

    indexOf

    • indexOf(value, byteOffset?, encoding?): number

    • If value is:

      +

    indexOf

    • indexOf(value, byteOffset?, encoding?): number

    • If value is:

      • a string, value is interpreted according to the character encoding inencoding.
      • a Buffer or Uint8Array, value will be used in its entirety. @@ -243,14 +243,14 @@
    • Optional encoding: BufferEncoding

      If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

    Returns number

    The index of the first occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v1.5.0

    -

    join

    • join(separator?): string

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

      +

    join

    • join(separator?): string

    • 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

    keys

    Returns string

    keys

    • keys(): IterableIterator<number>

    • Creates and returns an iterator of buf keys (indices).

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('buffer');

      for (const key of buf.keys()) {
        console.log(key);
      }
      // Prints:
      //   0
      //   1
      //   2
      //   3
      //   4
      //   5

      Returns IterableIterator<number>

      Since

      v1.1.0

      -

    lastIndexOf

    • lastIndexOf(value, byteOffset?, encoding?): number

    • Identical to buf.indexOf(), except the last occurrence of value is found +

    lastIndexOf

    • lastIndexOf(value, byteOffset?, encoding?): number

    • Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('this buffer is a buffer');

      console.log(buf.lastIndexOf('this'));
      // Prints: 0
      console.log(buf.lastIndexOf('buffer'));
      // Prints: 17
      console.log(buf.lastIndexOf(Buffer.from('buffer')));
      // Prints: 17
      console.log(buf.lastIndexOf(97));
      // Prints: 15 (97 is the decimal ASCII value for 'a')
      console.log(buf.lastIndexOf(Buffer.from('yolo')));
      // Prints: -1
      console.log(buf.lastIndexOf('buffer', 5));
      // Prints: 5
      console.log(buf.lastIndexOf('buffer', 4));
      // Prints: -1

      const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

      console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
      // Prints: 6
      console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
      // Prints: 4
      @@ -267,133 +267,133 @@
    • Optional encoding: BufferEncoding

      If value is a string, this is the encoding used to determine the binary representation of the string that will be searched for in buf.

    Returns number

    The index of the last occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v6.0.0

    -

    map

    • map(callbackfn, thisArg?): Uint8Array

    • Calls a defined callback function on each element of an array, and returns an array that +

    map

    • map(callbackfn, thisArg?): Uint8Array

    • 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

    readBigInt64BE

    • readBigInt64BE(offset?): bigint

    • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

      +

    Returns Uint8Array

    readBigInt64BE

    • readBigInt64BE(offset?): bigint

    • Reads a signed, big-endian 64-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigInt64LE

    • readBigInt64LE(offset?): bigint

    • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigInt64LE

    • readBigInt64LE(offset?): bigint

    • Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUInt64BE

    • readBigUInt64BE(offset?): bigint

    • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigUInt64BE

    • readBigUInt64BE(offset?): bigint

    • Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

      This function is also available under the readBigUint64BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

      console.log(buf.readBigUInt64BE(0));
      // Prints: 4294967295n

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUInt64LE

    • readBigUInt64LE(offset?): bigint

    • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

      +

    readBigUInt64LE

    • readBigUInt64LE(offset?): bigint

    • Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

      This function is also available under the readBigUint64LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

      console.log(buf.readBigUInt64LE(0));
      // Prints: 18446744069414584320n

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy: 0 <= offset <= buf.length - 8.

      Returns bigint

      Since

      v12.0.0, v10.20.0

      -

    readBigUint64BE

    • readBigUint64BE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64BE

      +

    readBigUint64BE

    • readBigUint64BE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64BE

      Since

      v14.10.0, v12.19.0

      -

    readBigUint64LE

    • readBigUint64LE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64LE

      +

    readBigUint64LE

    • readBigUint64LE(offset?): bigint

    • Parameters

      • Optional offset: number

      Returns bigint

      Alias

      Buffer.readBigUInt64LE

      Since

      v14.10.0, v12.19.0

      -

    readDoubleBE

    • readDoubleBE(offset?): number

    • Reads a 64-bit, big-endian double from buf at the specified offset.

      +

    readDoubleBE

    • readDoubleBE(offset?): number

    • Reads a 64-bit, big-endian double from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

      console.log(buf.readDoubleBE(0));
      // Prints: 8.20788039913184e-304

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

      Returns number

      Since

      v0.11.15

      -

    readDoubleLE

    • readDoubleLE(offset?): number

    • Reads a 64-bit, little-endian double from buf at the specified offset.

      +

    readDoubleLE

    • readDoubleLE(offset?): number

    • Reads a 64-bit, little-endian double from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

      console.log(buf.readDoubleLE(0));
      // Prints: 5.447603722011605e-270
      console.log(buf.readDoubleLE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 8.

      Returns number

      Since

      v0.11.15

      -

    readFloatBE

    • readFloatBE(offset?): number

    • Reads a 32-bit, big-endian float from buf at the specified offset.

      +

    readFloatBE

    • readFloatBE(offset?): number

    • Reads a 32-bit, big-endian float from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4]);

      console.log(buf.readFloatBE(0));
      // Prints: 2.387939260590663e-38

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.11.15

      -

    readFloatLE

    • readFloatLE(offset?): number

    • Reads a 32-bit, little-endian float from buf at the specified offset.

      +

    readFloatLE

    • readFloatLE(offset?): number

    • Reads a 32-bit, little-endian float from buf at the specified offset.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, 2, 3, 4]);

      console.log(buf.readFloatLE(0));
      // Prints: 1.539989614439558e-36
      console.log(buf.readFloatLE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.11.15

      -

    readInt16BE

    • readInt16BE(offset?): number

    • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

      +

    readInt16BE

    • readInt16BE(offset?): number

    • Reads a signed, big-endian 16-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 5]);

      console.log(buf.readInt16BE(0));
      // Prints: 5

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readInt16LE

    • readInt16LE(offset?): number

    • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

      +

    readInt16LE

    • readInt16LE(offset?): number

    • Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 5]);

      console.log(buf.readInt16LE(0));
      // Prints: 1280
      console.log(buf.readInt16LE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readInt32BE

    • readInt32BE(offset?): number

    • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

      +

    readInt32BE

    • readInt32BE(offset?): number

    • Reads a signed, big-endian 32-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 0, 0, 5]);

      console.log(buf.readInt32BE(0));
      // Prints: 5

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readInt32LE

    • readInt32LE(offset?): number

    • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

      +

    readInt32LE

    • readInt32LE(offset?): number

    • Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0, 0, 0, 5]);

      console.log(buf.readInt32LE(0));
      // Prints: 83886080
      console.log(buf.readInt32LE(1));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readInt8

    • readInt8(offset?): number

    • Reads a signed 8-bit integer from buf at the specified offset.

      +

    readInt8

    • readInt8(offset?): number

    • Reads a signed 8-bit integer from buf at the specified offset.

      Integers read from a Buffer are interpreted as two's complement signed values.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([-1, 5]);

      console.log(buf.readInt8(0));
      // Prints: -1
      console.log(buf.readInt8(1));
      // Prints: 5
      console.log(buf.readInt8(2));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

      Returns number

      Since

      v0.5.0

      -

    readIntBE

    • readIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value +

    readIntBE

    • readIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readIntBE(0, 6).toString(16));
      // Prints: 1234567890ab
      console.log(buf.readIntBE(1, 6).toString(16));
      // Throws ERR_OUT_OF_RANGE.
      console.log(buf.readIntBE(1, 0).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readIntLE

    • readIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value +

    readIntLE

    • readIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readIntLE(0, 6).toString(16));
      // Prints: -546f87a9cbee

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUInt16BE

    • readUInt16BE(offset?): number

    • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

      +

    readUInt16BE

    • readUInt16BE(offset?): number

    • Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint16BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56]);

      console.log(buf.readUInt16BE(0).toString(16));
      // Prints: 1234
      console.log(buf.readUInt16BE(1).toString(16));
      // Prints: 3456

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readUInt16LE

    • readUInt16LE(offset?): number

    • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

      +

    readUInt16LE

    • readUInt16LE(offset?): number

    • Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint16LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56]);

      console.log(buf.readUInt16LE(0).toString(16));
      // Prints: 3412
      console.log(buf.readUInt16LE(1).toString(16));
      // Prints: 5634
      console.log(buf.readUInt16LE(2).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 2.

      Returns number

      Since

      v0.5.5

      -

    readUInt32BE

    • readUInt32BE(offset?): number

    • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

      +

    readUInt32BE

    • readUInt32BE(offset?): number

    • Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint32BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

      console.log(buf.readUInt32BE(0).toString(16));
      // Prints: 12345678

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readUInt32LE

    • readUInt32LE(offset?): number

    • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

      +

    readUInt32LE

    • readUInt32LE(offset?): number

    • Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

      This function is also available under the readUint32LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

      console.log(buf.readUInt32LE(0).toString(16));
      // Prints: 78563412
      console.log(buf.readUInt32LE(1).toString(16));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 4.

      Returns number

      Since

      v0.5.5

      -

    readUInt8

    • readUInt8(offset?): number

    • Reads an unsigned 8-bit integer from buf at the specified offset.

      +

    readUInt8

    • readUInt8(offset?): number

    • Reads an unsigned 8-bit integer from buf at the specified offset.

      This function is also available under the readUint8 alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([1, -2]);

      console.log(buf.readUInt8(0));
      // Prints: 1
      console.log(buf.readUInt8(1));
      // Prints: 254
      console.log(buf.readUInt8(2));
      // Throws ERR_OUT_OF_RANGE.

      Parameters

      • Optional offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - 1.

      Returns number

      Since

      v0.5.0

      -

    readUIntBE

    • readUIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting +

    readUIntBE

    • readUIntBE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.

      This function is also available under the readUintBE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readUIntBE(0, 6).toString(16));
      // Prints: 1234567890ab
      console.log(buf.readUIntBE(1, 6).toString(16));
      // Throws ERR_OUT_OF_RANGE.
@@ -401,7 +401,7 @@ 
      Since
      v14.10.0, v12.19.0

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUIntLE

    • readUIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting +

    readUIntLE

    • readUIntLE(offset, byteLength): number

    • Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.

      This function is also available under the readUintLE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

      console.log(buf.readUIntLE(0, 6).toString(16));
      // Prints: ab9078563412
@@ -409,26 +409,26 @@ 
      Since
      v14.10.0, v12.19.0

      Parameters

      • offset: number

        Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      • byteLength: number

        Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      Returns number

      Since

      v0.11.15

      -

    readUint16BE

    • readUint16BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16BE

      +

    readUint16BE

    • readUint16BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16BE

      Since

      v14.9.0, v12.19.0

      -

    readUint16LE

    • readUint16LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16LE

      +

    readUint16LE

    • readUint16LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt16LE

      Since

      v14.9.0, v12.19.0

      -

    readUint32BE

    • readUint32BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32BE

      +

    readUint32BE

    • readUint32BE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32BE

      Since

      v14.9.0, v12.19.0

      -

    readUint32LE

    • readUint32LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32LE

      +

    readUint32LE

    • readUint32LE(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt32LE

      Since

      v14.9.0, v12.19.0

      -

    readUint8

    • readUint8(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt8

      +

    readUint8

    • readUint8(offset?): number

    • Parameters

      • Optional offset: number

      Returns number

      Alias

      Buffer.readUInt8

      Since

      v14.9.0, v12.19.0

      -

    readUintBE

    • readUintBE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntBE

      +

    readUintBE

    • readUintBE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntBE

      Since

      v14.9.0, v12.19.0

      -

    readUintLE

    • readUintLE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntLE

      +

    readUintLE

    • readUintLE(offset, byteLength): number

    • Parameters

      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.readUIntLE

      Since

      v14.9.0, v12.19.0

      -

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of +

    reduce

    • reduce(callbackfn): 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.

      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

    • reduce(callbackfn, initialValue): 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

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of +

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

        • Parameters

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

          Returns number

    Returns number

  • reduce(callbackfn, initialValue): 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

  • reduce<U>(callbackfn, initialValue): U

  • 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 @@ -436,12 +436,12 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. +

    Returns U

    reduceRight

    • reduceRight(callbackfn): 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.

      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

    • reduceRight(callbackfn, initialValue): 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

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. +

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

        • Parameters

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

          Returns number

    Returns number

  • reduceRight(callbackfn, initialValue): 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

  • reduceRight<U>(callbackfn, initialValue): 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.

    Type Parameters

    • U

    Parameters

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

      A function that accepts up to four arguments. The reduceRight method calls @@ -449,10 +449,10 @@

      Since

      v14.9.0, v12.19.0

        • (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

    • reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      +

    Returns U

    reverse

    • reverse(): this

    • Returns this

    set

    • set(array, offset?): void

    • 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

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

    Returns void

    slice

    • slice(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      This method is not compatible with the Uint8Array.prototype.slice(), which is a superclass of Buffer. To copy the slice, useUint8Array.prototype.slice().

      @@ -462,19 +462,19 @@

      Since

      v14.9.0, v12.19.0

    • Optional end: number

      Where the new Buffer will end (not inclusive).

    Returns Buffer

    Since

    v0.3.0

    Deprecated

    Use subarray instead.

    -

    some

    • some(predicate, thisArg?): boolean

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

      +

    some

    • some(predicate, thisArg?): boolean

    • 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

    sort

    • sort(compareFn?): this

    • Sorts an array.

      +

    Returns boolean

    sort

    • sort(compareFn?): this

    • 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 this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but +

        • (a, b): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns this

    subarray

    • subarray(start?, end?): Buffer

    • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

      Specifying end greater than buf.length will return the same result as that of end equal to buf.length.

      @@ -489,7 +489,7 @@

      Deprecated

      Use subarray instead.

      Parameters

      • Optional start: number

        Where the new Buffer will start.

      • Optional end: number

        Where the new Buffer will end (not inclusive).

      Returns Buffer

      Since

      v3.0.0

      -

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the +

    swap16

    • swap16(): Buffer

    • Interprets buf as an array of unsigned 16-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 2.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap16();

      console.log(buf1);
      // Prints: <Buffer 02 01 04 03 06 05 08 07>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap16();
      // Throws ERR_INVALID_BUFFER_SIZE.
      @@ -499,27 +499,27 @@

      Deprecated

      Use subarray instead.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the +

    swap32

    • swap32(): Buffer

    • Interprets buf as an array of unsigned 32-bit integers and swaps the byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 4.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap32();

      console.log(buf1);
      // Prints: <Buffer 04 03 02 01 08 07 06 05>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap32();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v5.10.0

      -

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. +

    swap64

    • swap64(): Buffer

    • Interprets buf as an array of 64-bit numbers and swaps byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 8.

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

      console.log(buf1);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>

      buf1.swap64();

      console.log(buf1);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>

      const buf2 = Buffer.from([0x1, 0x2, 0x3]);

      buf2.swap64();
      // Throws ERR_INVALID_BUFFER_SIZE.

      Returns Buffer

      A reference to buf.

      Since

      v6.3.0

      -

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls +

    toJSON

    • toJSON(): {
          data: number[];
          type: "Buffer";
      }

    • Returns a JSON representation of buf. JSON.stringify() implicitly calls this function when stringifying a Buffer instance.

      Buffer.from() accepts objects in the format returned from this method. In particular, Buffer.from(buf.toJSON()) works like Buffer.from(buf).

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
      const json = JSON.stringify(buf);

      console.log(json);
      // Prints: {"type":"Buffer","data":[1,2,3,4,5]}

      const copy = JSON.parse(json, (key, value) => {
        return value &#x26;&#x26; value.type === 'Buffer' ?
          Buffer.from(value) :
          value;
      });

      console.log(copy);
      // Prints: <Buffer 01 02 03 04 05>

      Returns {
          data: number[];
          type: "Buffer";
      }

      • data: number[]
      • type: "Buffer"

      Since

      v0.9.2

      -

    toLocaleString

    • toLocaleString(): string

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

      -

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      +

    toLocaleString

    • toLocaleString(): string

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

      +

      Returns string

    toString

    • toString(encoding?, start?, end?): string

    • Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

      If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8, then each invalid byte is replaced with the replacement character U+FFFD.

      The maximum length of a string instance (in UTF-16 code units) is available @@ -530,13 +530,13 @@

      Deprecated

      Use subarray instead.

    • Optional start: number

      The byte offset to start decoding at.

    • Optional end: number

      The byte offset to stop decoding at (not inclusive).

    Returns string

    Since

    v0.1.90

    -

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      -

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is +

    valueOf

    • valueOf(): Uint8Array

    • Returns the primitive value of the specified object.

      +

      Returns Uint8Array

    values

    • values(): IterableIterator<number>

    • Creates and returns an iterator for buf values (bytes). This function is called automatically when a Buffer is used in a for..of statement.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.from('buffer');

      for (const value of buf.values()) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      for (const value of buf) {
        console.log(value);
      }
      // Prints:
      //   98
      //   117
      //   102
      //   102
      //   101
      //   114

      Returns IterableIterator<number>

      Since

      v1.1.0

      -

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did +

    write

    • write(string, encoding?): number

    • Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did not contain enough space to fit the entire string, only part of string will be written. However, partially encoded characters will not be written.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(256);

      const len = buf.write('\u00bd + \u00bc = \u00be', 0);

      console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
      // Prints: 12 bytes: ½ + ¼ = ¾

      const buffer = Buffer.alloc(10);

      const length = buffer.write('abcd', 8);

      console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
      // Prints: 2 bytes : ab
@@ -545,7 +545,7 @@ 
      Deprecated
      Use subarray instead.
    • Optional encoding: BufferEncoding

      The character encoding of string.

    Returns number

    Number of bytes written.

    Since

    v0.1.90

    -
  • write(string, offset, encoding?): number

  • Parameters

    Returns number

  • write(string, offset, length, encoding?): number

  • Parameters

    • string: string
    • offset: number
    • length: number
    • Optional encoding: BufferEncoding

    Returns number

    • writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +
    • write(string, offset, encoding?): number

    • Parameters

      Returns number

    • write(string, offset, length, encoding?): number

    • Parameters

      • string: string
      • offset: number
      • length: number
      • Optional encoding: BufferEncoding

      Returns number

    writeBigInt64BE

    • writeBigInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64BE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04 05 06 07 08>
      @@ -553,7 +553,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      +

    writeBigInt64LE

    • writeBigInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian.

      value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigInt64LE(0x0102030405060708n, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05 04 03 02 01>
      @@ -561,7 +561,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      +

    writeBigUInt64BE

    • writeBigUInt64BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian.

      This function is also available under the writeBigUint64BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de ca fa fe ca ce fa de>
      @@ -569,7 +569,7 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      +

    writeBigUInt64LE

    • writeBigUInt64LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

      console.log(buf);
      // Prints: <Buffer de fa ce ca fe fa ca de>

      This function is also available under the writeBigUint64LE alias.

      @@ -577,11 +577,11 @@

      Deprecated

      Use subarray instead.

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy: 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

    -

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      +

    writeBigUint64BE

    • writeBigUint64BE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64BE

      Since

      v14.10.0, v12.19.0

      -

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      +

    writeBigUint64LE

    • writeBigUint64LE(value, offset?): number

    • Parameters

      • value: bigint
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeBigUInt64LE

      Since

      v14.10.0, v12.19.0

      -

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleBE

    • writeDoubleBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleBE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
      @@ -589,7 +589,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything +

    writeDoubleLE

    • writeDoubleLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(8);

      buf.writeDoubleLE(123.456, 0);

      console.log(buf);
      // Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
      @@ -597,7 +597,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 8.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is +

    writeFloatBE

    • writeFloatBE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatBE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer 4f 4a fe bb>
      @@ -605,7 +605,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is +

    writeFloatLE

    • writeFloatLE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. Behavior is undefined when value is anything other than a JavaScript number.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeFloatLE(0xcafebabe, 0);

      console.log(buf);
      // Prints: <Buffer bb fe 4a 4f>
      @@ -613,7 +613,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16BE

    • writeInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16BE(0x0102, 0);

      console.log(buf);
      // Prints: <Buffer 01 02>
@@ -622,7 +622,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is +

    writeInt16LE

    • writeInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(2);

      buf.writeInt16LE(0x0304, 0);

      console.log(buf);
      // Prints: <Buffer 04 03>
@@ -631,7 +631,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32BE

    • writeInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32BE(0x01020304, 0);

      console.log(buf);
      // Prints: <Buffer 01 02 03 04>
@@ -640,7 +640,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is +

    writeInt32LE

    • writeInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

      The value is interpreted and written as a two's complement signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeInt32LE(0x05060708, 0);

      console.log(buf);
      // Prints: <Buffer 08 07 06 05>
@@ -649,7 +649,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid +

    writeInt8

    • writeInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid signed 8-bit integer. Behavior is undefined when value is anything other than a signed 8-bit integer.

      value is interpreted and written as a two's complement signed integer.

      @@ -659,7 +659,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a +

    writeIntBE

    • writeIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
      @@ -668,7 +668,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeIntLE

    • writeIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than a signed integer.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
      @@ -677,7 +677,7 @@

      Since

      v14.10.0, v12.19.0

    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.11.15

    -

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt16BE

    • writeUInt16BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16BE(0xdead, 0);
      buf.writeUInt16BE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer de ad be ef>
@@ -686,7 +686,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is +

    writeUInt16LE

    • writeUInt16LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is anything other than an unsigned 16-bit integer.

      This function is also available under the writeUint16LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt16LE(0xdead, 0);
      buf.writeUInt16LE(0xbeef, 2);

      console.log(buf);
      // Prints: <Buffer ad de ef be>
@@ -695,7 +695,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 2.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an +

    writeUInt32BE

    • writeUInt32BE(value, offset?): number

    • Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32BE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32BE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer fe ed fa ce>
@@ -704,7 +704,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is +

    writeUInt32LE

    • writeUInt32LE(value, offset?): number

    • Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is anything other than an unsigned 32-bit integer.

      This function is also available under the writeUint32LE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(4);

      buf.writeUInt32LE(0xfeedface, 0);

      console.log(buf);
      // Prints: <Buffer ce fa ed fe>
@@ -713,7 +713,7 @@ 
      Since
      v14.10.0, v12.19.0
    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 4.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a +

    writeUInt8

    • writeUInt8(value, offset?): number

    • Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer. Behavior is undefined when value is anything other than an unsigned 8-bit integer.

      This function is also available under the writeUint8 alias.

      @@ -723,7 +723,7 @@

      Since

      v14.10.0, v12.19.0

    • Optional offset: number

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - 1.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.0

    -

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntBE

    • writeUIntBE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintBE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntBE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer 12 34 56 78 90 ab>
@@ -733,7 +733,7 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined +

    writeUIntLE

    • writeUIntLE(value, offset, byteLength): number

    • Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

      This function is also available under the writeUintLE alias.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(6);

      buf.writeUIntLE(0x1234567890ab, 0, 6);

      console.log(buf);
      // Prints: <Buffer ab 90 78 56 34 12>
@@ -743,18 +743,18 @@ 
      Since
      v14.10.0, v12.19.0
    • byteLength: number

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    Returns number

    offset plus the number of bytes written.

    Since

    v0.5.5

    -

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      +

    writeUint16BE

    • writeUint16BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      +

    writeUint16LE

    • writeUint16LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt16LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      +

    writeUint32BE

    • writeUint32BE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32BE

      Since

      v14.9.0, v12.19.0

      -

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      +

    writeUint32LE

    • writeUint32LE(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt32LE

      Since

      v14.9.0, v12.19.0

      -

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      +

    writeUint8

    • writeUint8(value, offset?): number

    • Parameters

      • value: number
      • Optional offset: number

      Returns number

      Alias

      Buffer.writeUInt8

      Since

      v14.9.0, v12.19.0

      -

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      +

    writeUintBE

    • writeUintBE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntBE

      Since

      v14.9.0, v12.19.0

      -

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      +

    writeUintLE

    • writeUintLE(value, offset, byteLength): number

    • Parameters

      • value: number
      • offset: number
      • byteLength: number

      Returns number

      Alias

      Buffer.writeUIntLE

      Since

      v14.9.0, v12.19.0

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.BufferConstructor.html b/interfaces/_divviup_vdaf._internal_.BufferConstructor.html index 8c3b41126..95200db33 100644 --- a/interfaces/_divviup_vdaf._internal_.BufferConstructor.html +++ b/interfaces/_divviup_vdaf._internal_.BufferConstructor.html @@ -1,43 +1,43 @@ -BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. +BufferConstructor | Documentation

    Interface BufferConstructor

    Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'

    -
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor -

    Properties

    poolSize -

    Methods

    alloc -allocUnsafe -allocUnsafeSlow -byteLength -compare -concat -copyBytesFrom -from -isBuffer -isEncoding -of -

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      +
    interface BufferConstructor {
        new BufferConstructornew (str, encoding?): Buffer;
        new BufferConstructornew (size): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (arrayBuffer): Buffer;
        new BufferConstructornew (array): Buffer;
        new BufferConstructornew (buffer): Buffer;
        poolSize: number;
        alloc(size, fill?, encoding?): Buffer;
        allocUnsafe(size): Buffer;
        allocUnsafeSlow(size): Buffer;
        byteLength(string, encoding?): number;
        compare(buf1, buf2): -1 | 0 | 1;
        concat(list, totalLength?): Buffer;
        copyBytesFrom(view, offset?, length?): Buffer;
        from(arrayBuffer, byteOffset?, length?): Buffer;
        from(data): Buffer;
        from(data): Buffer;
        from(str, encoding?): Buffer;
        isBuffer(obj): obj is Buffer;
        isEncoding(encoding): encoding is BufferEncoding;
        of(...items): Buffer;
    }

    Constructors

    constructor +

    Properties

    poolSize +

    Methods

    alloc +allocUnsafe +allocUnsafeSlow +byteLength +compare +concat +copyBytesFrom +from +isBuffer +isEncoding +of +

    Constructors

    constructor

    • new BufferConstructor(str, encoding?): Buffer

    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: BufferEncoding

        encoding to use, optional. Default is 'utf8'

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

      -
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      +
    • new BufferConstructor(size): Buffer

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as +

    • new BufferConstructor(arrayBuffer): Buffer

    • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.

      Parameters

      • arrayBuffer: ArrayBuffer | SharedArrayBuffer

        The ArrayBuffer with which to share memory.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

      -
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      +
    • new BufferConstructor(array): Buffer

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: readonly any[]

        The octets to store.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(array) instead.

      -
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      +
    • new BufferConstructor(buffer): Buffer

    • Copies the passed {buffer} data onto a new {Buffer} instance.

      Parameters

      • buffer: Buffer

        The buffer to copy.

      Returns Buffer

      Deprecated

      since v10.0.0 - Use Buffer.from(buffer) instead.

      -

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used +

    Properties

    poolSize

    poolSize: number

    This is the size (in bytes) of pre-allocated internal Buffer instances used for pooling. This value may be modified.

    Since

    v0.11.3

    -

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      +

    Methods

    alloc

    • alloc(size, fill?, encoding?): Buffer

    • Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.alloc(5);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00>

      If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      @@ -56,7 +56,7 @@
    • Optional fill: string | number | Uint8Array

      A value to pre-fill the new Buffer with.

    • Optional encoding: BufferEncoding

      If fill is a string, this is its encoding.

    Returns Buffer

    Since

    v5.10.0

    -

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      +

    allocUnsafe

    • allocUnsafe(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use Buffer.alloc() instead to initializeBuffer instances with zeroes.

      import { Buffer } from 'node:buffer';

      const buf = Buffer.allocUnsafe(10);

      console.log(buf);
      // Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

      buf.fill(0);

      console.log(buf);
      // Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
@@ -73,7 +73,7 @@
 additional performance that Buffer.allocUnsafe() provides.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.10.0

      -

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if +

    allocUnsafeSlow

    • allocUnsafeSlow(size): Buffer

    • Allocates a new Buffer of size bytes. If size is larger than constants.MAX_LENGTH or smaller than 0, ERR_OUT_OF_RANGE is thrown. A zero-length Buffer is created if size is 0.

      The underlying memory for Buffer instances created in this way is not initialized. The contents of the newly created Buffer are unknown and may contain sensitive data. Use buf.fill(0) to initialize @@ -93,7 +93,7 @@

      A TypeError will be thrown if size is not a number.

      Parameters

      • size: number

        The desired length of the new Buffer.

      Returns Buffer

      Since

      v5.12.0

      -

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. +

    byteLength

    • byteLength(string, encoding?): number

    • Returns the byte length of a string when encoded using encoding. This is not the same as String.prototype.length, which does not account for the encoding that is used to convert the string into bytes.

      For 'base64', 'base64url', and 'hex', this function assumes valid input. @@ -110,12 +110,12 @@

    • Optional encoding: BufferEncoding

      If string is a string, this is its encoding.

    Returns number

    The number of bytes contained within string.

    Since

    v0.1.90

    -

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      +

    compare

    • compare(buf1, buf2): -1 | 0 | 1

    • Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

      import { Buffer } from 'node:buffer';

      const buf1 = Buffer.from('1234');
      const buf2 = Buffer.from('0123');
      const arr = [buf1, buf2];

      console.log(arr.sort(Buffer.compare));
      // Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
      // (This result is equal to: [buf2, buf1].)

      Parameters

      • buf1: Uint8Array
      • buf2: Uint8Array

      Returns -1 | 0 | 1

      Either -1, 0, or 1, depending on the result of the comparison. See compare for details.

      Since

      v0.11.13

      -

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      +

    concat

    • concat(list, totalLength?): Buffer

    • Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

      If the list has no items, or if the totalLength is 0, then a new zero-lengthBuffer is returned.

      If totalLength is not provided, it is calculated from the Buffer instances in list by adding their lengths.

      @@ -128,14 +128,14 @@

      Parameters

      • list: readonly Uint8Array[]

        List of Buffer or Uint8Array instances to concatenate.

      • Optional totalLength: number

        Total length of the Buffer instances in list when concatenated.

      Returns Buffer

      Since

      v0.7.11

      -

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      +

    copyBytesFrom

    • copyBytesFrom(view, offset?, length?): Buffer

    • Copies the underlying memory of view into a new Buffer.

      const u16 = new Uint16Array([0, 0xffff]);
      const buf = Buffer.copyBytesFrom(u16, 1, 1);
      u16[1] = 0;
      console.log(buf.length); // 2
      console.log(buf[0]); // 255
      console.log(buf[1]); // 255

      Parameters

      • view: TypedArray

        The {TypedArray} to copy.

      • Optional offset: number

        The starting offset within view.

      • Optional length: number

        The number of elements from view to copy.

      Returns Buffer

      Since

      v19.8.0

      -

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. +

    from

    • from(arrayBuffer, byteOffset?, length?): Buffer

    • Allocates a new Buffer using an array of bytes in the range 0 – 255. Array entries outside that range will be truncated to fit into it.

      import { Buffer } from 'node:buffer';

      // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
      const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
      @@ -146,20 +146,20 @@ appropriate for Buffer.from() variants.

      Buffer.from(array) and Buffer.from(string) may also use the internalBuffer pool like Buffer.allocUnsafe() does.

      Parameters

      Returns Buffer

      Since

      v5.10.0

      -
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      +
    • from(data): Buffer

    • Creates a new Buffer using the passed {data}

      Parameters

      • data: Uint8Array | readonly number[]

        data to create a new Buffer

        -

      Returns Buffer

    • from(data): Buffer

    • Parameters

      Returns Buffer

    • from(str, encoding?): Buffer

    • Creates a new Buffer containing the given JavaScript string {str}. +

    Returns Buffer

  • from(data): Buffer

  • Parameters

    Returns Buffer

  • from(str, encoding?): Buffer

  • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

    -

    Parameters

    Returns Buffer

    • isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      +

      Parameters

      Returns Buffer

    isBuffer

    • isBuffer(obj): obj is Buffer

    • Returns true if obj is a Buffer, false otherwise.

      import { Buffer } from 'node:buffer';

      Buffer.isBuffer(Buffer.alloc(10)); // true
      Buffer.isBuffer(Buffer.from('foo')); // true
      Buffer.isBuffer('a string'); // false
      Buffer.isBuffer([]); // false
      Buffer.isBuffer(new Uint8Array(1024)); // false

      Parameters

      • obj: any

      Returns obj is Buffer

      Since

      v0.1.101

      -

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, +

    isEncoding

    • isEncoding(encoding): encoding is BufferEncoding

    • Returns true if encoding is the name of a supported character encoding, or false otherwise.

      import { Buffer } from 'node:buffer';

      console.log(Buffer.isEncoding('utf8'));
      // Prints: true

      console.log(Buffer.isEncoding('hex'));
      // Prints: true

      console.log(Buffer.isEncoding('utf/8'));
      // Prints: false

      console.log(Buffer.isEncoding(''));
      // Prints: false

      Parameters

      • encoding: string

        A character encoding name to check.

      Returns encoding is BufferEncoding

      Since

      v0.9.1

      -

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      -

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    of

    • of(...items): Buffer

    • Creates a new Buffer using the passed {data}

      +

      Parameters

      • Rest ...items: number[]

      Returns Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.IterableIterator.html b/interfaces/_divviup_vdaf._internal_.IterableIterator.html index 2c8f9bbc8..c20e236fb 100644 --- a/interfaces/_divviup_vdaf._internal_.IterableIterator.html +++ b/interfaces/_divviup_vdaf._internal_.IterableIterator.html @@ -1,5 +1,5 @@ -IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] -next -return? -throw? -

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IterableIterator | Documentation

    Interface IterableIterator<T>

    interface IterableIterator<T> {
        [iterator](): IterableIterator<T>;
        next(...args): IteratorResult<T, any>;
        return?(value?): IteratorResult<T, any>;
        throw?(e?): IteratorResult<T, any>;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Methods

    [iterator] +next +return? +throw? +

    Methods

    [iterator]

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.Iterator.html b/interfaces/_divviup_vdaf._internal_.Iterator.html index 61fc9c831..baebc18aa 100644 --- a/interfaces/_divviup_vdaf._internal_.Iterator.html +++ b/interfaces/_divviup_vdaf._internal_.Iterator.html @@ -1,4 +1,4 @@ -Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next -return? -throw? -

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +Iterator | Documentation

    Interface Iterator<T, TReturn, TNext>

    interface Iterator<T, TReturn, TNext> {
        next(...args): IteratorResult<T, TReturn>;
        return?(value?): IteratorResult<T, TReturn>;
        throw?(e?): IteratorResult<T, TReturn>;
    }

    Type Parameters

    • T
    • TReturn = any
    • TNext = undefined

    Hierarchy (view full)

    Methods

    next +return? +throw? +

    Methods

    next

    Optional return

    Optional throw

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.IteratorReturnResult.html b/interfaces/_divviup_vdaf._internal_.IteratorReturnResult.html index ea7811d72..befdc8b7e 100644 --- a/interfaces/_divviup_vdaf._internal_.IteratorReturnResult.html +++ b/interfaces/_divviup_vdaf._internal_.IteratorReturnResult.html @@ -1,3 +1,3 @@ -IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done -value -

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorReturnResult | Documentation

    Interface IteratorReturnResult<TReturn>

    interface IteratorReturnResult<TReturn> {
        done: true;
        value: TReturn;
    }

    Type Parameters

    • TReturn

    Properties

    done +value +

    Properties

    done

    done: true

    value

    value: TReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.IteratorYieldResult.html b/interfaces/_divviup_vdaf._internal_.IteratorYieldResult.html index b5956e07e..968721538 100644 --- a/interfaces/_divviup_vdaf._internal_.IteratorYieldResult.html +++ b/interfaces/_divviup_vdaf._internal_.IteratorYieldResult.html @@ -1,3 +1,3 @@ -IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? -value -

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +IteratorYieldResult | Documentation

    Interface IteratorYieldResult<TYield>

    interface IteratorYieldResult<TYield> {
        done?: false;
        value: TYield;
    }

    Type Parameters

    • TYield

    Properties

    done? +value +

    Properties

    Optional done

    done?: false

    value

    value: TYield

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.RunVdafArguments.html b/interfaces/_divviup_vdaf._internal_.RunVdafArguments.html index cd2e55fcc..5673871de 100644 --- a/interfaces/_divviup_vdaf._internal_.RunVdafArguments.html +++ b/interfaces/_divviup_vdaf._internal_.RunVdafArguments.html @@ -1,7 +1,7 @@ -RunVdafArguments | Documentation

    Interface RunVdafArguments<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>

    interface RunVdafArguments<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM> {
        aggregationParameter: AP;
        measurements: M[];
        nonces?: Buffer[];
        rands?: Buffer[];
        vdaf: Vdaf<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>;
        verifyKey?: Buffer;
    }

    Type Parameters

    • M
    • AP
    • PuSh
    • IS
    • OS
    • AS
    • AR
    • PrSt
    • PrSh
    • PM

    Properties

    aggregationParameter -measurements -nonces? -rands? -vdaf -verifyKey? -

    Properties

    aggregationParameter

    aggregationParameter: AP

    measurements

    measurements: M[]

    Optional nonces

    nonces?: Buffer[]

    Optional rands

    rands?: Buffer[]

    vdaf

    vdaf: Vdaf<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>

    Optional verifyKey

    verifyKey?: Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +RunVdafArguments | Documentation

    Interface RunVdafArguments<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>

    interface RunVdafArguments<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM> {
        aggregationParameter: AP;
        measurements: M[];
        nonces?: Buffer[];
        rands?: Buffer[];
        vdaf: Vdaf<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>;
        verifyKey?: Buffer;
    }

    Type Parameters

    • M
    • AP
    • PuSh
    • IS
    • OS
    • AS
    • AR
    • PrSt
    • PrSh
    • PM

    Properties

    aggregationParameter +measurements +nonces? +rands? +vdaf +verifyKey? +

    Properties

    aggregationParameter

    aggregationParameter: AP

    measurements

    measurements: M[]

    Optional nonces

    nonces?: Buffer[]

    Optional rands

    rands?: Buffer[]

    vdaf

    vdaf: Vdaf<M, AP, PuSh, IS, OS, AS, AR, PrSt, PrSh, PM>

    Optional verifyKey

    verifyKey?: Buffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.SharedArrayBuffer.html b/interfaces/_divviup_vdaf._internal_.SharedArrayBuffer.html index 919f7af5d..0be95b361 100644 --- a/interfaces/_divviup_vdaf._internal_.SharedArrayBuffer.html +++ b/interfaces/_divviup_vdaf._internal_.SharedArrayBuffer.html @@ -1,7 +1,7 @@ -SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] -[toStringTag] -byteLength -

    Methods

    slice -

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    -

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      -

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Interface SharedArrayBuffer

    interface SharedArrayBuffer {
        [species]: SharedArrayBuffer;
        [toStringTag]: "SharedArrayBuffer";
        byteLength: number;
        slice(begin, end?): SharedArrayBuffer;
    }

    Properties

    [species] +[toStringTag] +byteLength +

    Methods

    slice +

    Properties

    Readonly [species]

    [species]: SharedArrayBuffer

    Readonly [toStringTag]

    [toStringTag]: "SharedArrayBuffer"

    Readonly byteLength

    byteLength: number

    Read-only. The length of the ArrayBuffer (in bytes).

    +

    Methods

    slice

    • slice(begin, end?): SharedArrayBuffer

    • Returns a section of an SharedArrayBuffer.

      +

      Parameters

      • begin: number
      • Optional end: number

      Returns SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_divviup_vdaf._internal_.SharedArrayBufferConstructor.html b/interfaces/_divviup_vdaf._internal_.SharedArrayBufferConstructor.html index e85304531..cf41067eb 100644 --- a/interfaces/_divviup_vdaf._internal_.SharedArrayBufferConstructor.html +++ b/interfaces/_divviup_vdaf._internal_.SharedArrayBufferConstructor.html @@ -1,3 +1,3 @@ -SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor -

    Properties

    prototype -

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBufferConstructor | Documentation

    Interface SharedArrayBufferConstructor

    interface SharedArrayBufferConstructor {
        new SharedArrayBufferConstructornew (byteLength): SharedArrayBuffer;
        prototype: SharedArrayBuffer;
    }

    Constructors

    constructor +

    Properties

    prototype +

    Constructors

    constructor

    • new SharedArrayBufferConstructor(byteLength): SharedArrayBuffer

    • Parameters

      • byteLength: number

      Returns SharedArrayBuffer

    Properties

    Readonly prototype

    prototype: SharedArrayBuffer

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_common.html b/modules/_divviup_common.html index c5aa923fc..b7991cb9a 100644 --- a/modules/_divviup_common.html +++ b/modules/_divviup_common.html @@ -1,4 +1,4 @@ -@divviup/common | Documentation

    Module @divviup/common

    DivviUp Typescript Client

    Coverage Status +@divviup/common | Documentation

    Module @divviup/common

    DivviUp Typescript Client

    Coverage Status CI

    docs for main

    Protocol Versions and Release Branches

    The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,4 +104,4 @@

    UNPKG

    <script
        src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
        crossorigin="anonymous"
        integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
    </script>
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_dap._internal_.html b/modules/_divviup_dap._internal_.html index 89641bf7c..548f2136f 100644 --- a/modules/_divviup_dap._internal_.html +++ b/modules/_divviup_dap._internal_.html @@ -1,130 +1,130 @@ -<internal> | Documentation

    Module <internal>

    Enumerations

    Role -

    Enumeration Members

    TBD -

    Classes

    Aggregator -CipherSuite -CipherSuiteNative -Extension -Field -HpkeCiphertext -HpkeConfigList -InputShareAad -NativeAlgorithm -Parser -PlaintextInputShare -Prio3 -Prio3Count -Prio3Histogram -Prio3Sum -Prio3SumVec -Report -ReportId -ReportMetadata -Vdaf -Xof -

    Interfaces

    AeadEncryptionContext -AeadInterface -AesCbcParams -AesCtrParams -AesDerivedKeyParams -AesGcmParams -AesKeyAlgorithm -AesKeyGenParams -Algorithm -ArrayBufferView -ArrayLike -Buffer -BufferConstructor -CallSite -CipherSuiteParams -CipherSuiteSealResponse -ClientParameters -ClientVdaf -CryptoKey -CryptoKeyPair -EcKeyGenParams -EcKeyImportParams -EcdhKeyDeriveParams -EcdsaParams -Encodable -EncryptionContext -Error -Exporter -FieldConstructorArgs -Flp -HistogramArgs -HkdfParams -HmacImportParams -HmacKeyGenParams -IterableIterator -Iterator -IteratorReturnResult -IteratorYieldResult -JsonWebKey -KdfInterface -KemInterface -KeyAlgorithm -KeyScheduleParams -KnownVdafs -Parseable -Pbkdf2Params -PreSharedKey -PrepTestVector -Problem -RecipientContextParams -RsaHashedImportParams -RsaHashedKeyGenParams -RsaKeyGenParams -RsaOaepParams -RsaOtherPrimesInfo -RsaPssParams -SenderContext -SenderContextParams -SharedArrayBuffer -SharedArrayBufferConstructor -SubtleCrypto -SumVecArgs -TestVector -XofConstructor -

    Type Aliases

    AeadId -AggregationParameter -AggregatorShare -AlgorithmIdentifier -ArrayBufferLike -ArrayBufferView -BufferEncoding -BufferSource -ConstructorParameters -Exclude -Fetch -InputShare -InstanceType -IteratorResult -KdfId -KemId -KeyFormat -KeyType -KeyUsage -KnownVdaf -KnownVdafNames -Omit -OutputShare -Parameters -ParseSource -Pick -PreparationMessage -PreparationShare -PreparationState -PublicShare -RequestInfo -TypedArray -VdafInstance -WithImplicitCoercion -

    Variables

    AeadId -Buffer -CryptoKey -Error -KdfId -KemId -SharedArrayBuffer -SubtleCrypto -

    Enumeration Members

    TBD

    TBD: 0

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +<internal> | Documentation

    Module <internal>

    Enumerations

    Role +

    Enumeration Members

    TBD +

    Classes

    Aggregator +CipherSuite +CipherSuiteNative +Extension +Field +HpkeCiphertext +HpkeConfigList +InputShareAad +NativeAlgorithm +Parser +PlaintextInputShare +Prio3 +Prio3Count +Prio3Histogram +Prio3Sum +Prio3SumVec +Report +ReportId +ReportMetadata +Vdaf +Xof +

    Interfaces

    AeadEncryptionContext +AeadInterface +AesCbcParams +AesCtrParams +AesDerivedKeyParams +AesGcmParams +AesKeyAlgorithm +AesKeyGenParams +Algorithm +ArrayBufferView +ArrayLike +Buffer +BufferConstructor +CallSite +CipherSuiteParams +CipherSuiteSealResponse +ClientParameters +ClientVdaf +CryptoKey +CryptoKeyPair +EcKeyGenParams +EcKeyImportParams +EcdhKeyDeriveParams +EcdsaParams +Encodable +EncryptionContext +Error +Exporter +FieldConstructorArgs +Flp +HistogramArgs +HkdfParams +HmacImportParams +HmacKeyGenParams +IterableIterator +Iterator +IteratorReturnResult +IteratorYieldResult +JsonWebKey +KdfInterface +KemInterface +KeyAlgorithm +KeyScheduleParams +KnownVdafs +Parseable +Pbkdf2Params +PreSharedKey +PrepTestVector +Problem +RecipientContextParams +RsaHashedImportParams +RsaHashedKeyGenParams +RsaKeyGenParams +RsaOaepParams +RsaOtherPrimesInfo +RsaPssParams +SenderContext +SenderContextParams +SharedArrayBuffer +SharedArrayBufferConstructor +SubtleCrypto +SumVecArgs +TestVector +XofConstructor +

    Type Aliases

    AeadId +AggregationParameter +AggregatorShare +AlgorithmIdentifier +ArrayBufferLike +ArrayBufferView +BufferEncoding +BufferSource +ConstructorParameters +Exclude +Fetch +InputShare +InstanceType +IteratorResult +KdfId +KemId +KeyFormat +KeyType +KeyUsage +KnownVdaf +KnownVdafNames +Omit +OutputShare +Parameters +ParseSource +Pick +PreparationMessage +PreparationShare +PreparationState +PublicShare +RequestInfo +TypedArray +VdafInstance +WithImplicitCoercion +

    Variables

    AeadId +Buffer +CryptoKey +Error +KdfId +KemId +SharedArrayBuffer +SubtleCrypto +

    Enumeration Members

    TBD

    TBD: 0

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_dap.html b/modules/_divviup_dap.html index a99d795ea..7aea5f1aa 100644 --- a/modules/_divviup_dap.html +++ b/modules/_divviup_dap.html @@ -1,4 +1,4 @@ -@divviup/dap | Documentation

    Module @divviup/dap

    DivviUp Typescript Client

    Coverage Status +@divviup/dap | Documentation

    Module @divviup/dap

    DivviUp Typescript Client

    Coverage Status CI

    docs for main

    Protocol Versions and Release Branches

    The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,13 +104,13 @@

    UNPKG

    <script
        src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
        crossorigin="anonymous"
        integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
    </script>
    -

    References

    default -

    Modules

    <internal> -

    Classes

    DAPError -HpkeConfig -Task -TaskId -

    Interfaces

    ReportOptions -

    Type Aliases

    KnownVdafSpec -VdafMeasurement -

    References

    default

    Renames and re-exports Task

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    References

    default +

    Modules

    <internal> +

    Classes

    DAPError +HpkeConfig +Task +TaskId +

    Interfaces

    ReportOptions +

    Type Aliases

    KnownVdafSpec +VdafMeasurement +

    References

    default

    Renames and re-exports Task

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_field._internal_.html b/modules/_divviup_field._internal_.html index 9783eb423..de18e1daa 100644 --- a/modules/_divviup_field._internal_.html +++ b/modules/_divviup_field._internal_.html @@ -1,4 +1,4 @@ -<internal> | Documentation

    Module <internal>

    Index

    Classes

    PrimeField -

    Interfaces

    ArithmeticOperation -FieldConstructorArgs -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +<internal> | Documentation

    Module <internal>

    Index

    Classes

    PrimeField +

    Interfaces

    ArithmeticOperation +FieldConstructorArgs +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_field.html b/modules/_divviup_field.html index 680db7687..a02df6027 100644 --- a/modules/_divviup_field.html +++ b/modules/_divviup_field.html @@ -1,4 +1,4 @@ -@divviup/field | Documentation

    Module @divviup/field

    DivviUp Typescript Client

    Coverage Status +@divviup/field | Documentation

    Module @divviup/field

    DivviUp Typescript Client

    Coverage Status CI

    docs for main

    Protocol Versions and Release Branches

    The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,10 +104,10 @@

    UNPKG

    <script
        src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
        crossorigin="anonymous"
        integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
    </script>
    -

    Index

    Modules

    <internal> -

    Classes

    Field -Field128 -Field64 -Field96 -Vector -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Index

    Modules

    <internal> +

    Classes

    Field +Field128 +Field64 +Field96 +Vector +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_prio3._internal_.html b/modules/_divviup_prio3._internal_.html index ff7826114..0ce0e61b1 100644 --- a/modules/_divviup_prio3._internal_.html +++ b/modules/_divviup_prio3._internal_.html @@ -1,41 +1,41 @@ -<internal> | Documentation

    Module <internal>

    Index

    Enumerations

    Usage -

    Classes

    Field -Vdaf -Xof -

    Interfaces

    ArrayLike -Buffer -BufferConstructor -FieldConstructorArgs -Flp -HistogramArgs -IterableIterator -Iterator -IteratorReturnResult -IteratorYieldResult -PrepTestVector -SharedArrayBuffer -SharedArrayBufferConstructor -SumVecArgs -TestVector -XofConstructor -

    Type Aliases

    AggregationParameter -AggregatorShare -ArrayBufferLike -ArrayBufferView -BufferEncoding -Exclude -InputShare -IteratorResult -Omit -OutputShare -Pick -PreparationMessage -PreparationShare -PreparationState -PublicShare -Share -TypedArray -WithImplicitCoercion -

    Variables

    Buffer -SharedArrayBuffer -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +<internal> | Documentation

    Module <internal>

    Index

    Enumerations

    Usage +

    Classes

    Field +Vdaf +Xof +

    Interfaces

    ArrayLike +Buffer +BufferConstructor +FieldConstructorArgs +Flp +HistogramArgs +IterableIterator +Iterator +IteratorReturnResult +IteratorYieldResult +PrepTestVector +SharedArrayBuffer +SharedArrayBufferConstructor +SumVecArgs +TestVector +XofConstructor +

    Type Aliases

    AggregationParameter +AggregatorShare +ArrayBufferLike +ArrayBufferView +BufferEncoding +Exclude +InputShare +IteratorResult +Omit +OutputShare +Pick +PreparationMessage +PreparationShare +PreparationState +PublicShare +Share +TypedArray +WithImplicitCoercion +

    Variables

    Buffer +SharedArrayBuffer +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_prio3.html b/modules/_divviup_prio3.html index 1c86ac0b6..3a38dc515 100644 --- a/modules/_divviup_prio3.html +++ b/modules/_divviup_prio3.html @@ -1,4 +1,4 @@ -@divviup/prio3 | Documentation

    Module @divviup/prio3

    DivviUp Typescript Client

    Coverage Status +@divviup/prio3 | Documentation

    Module @divviup/prio3

    DivviUp Typescript Client

    Coverage Status CI

    docs for main

    Protocol Versions and Release Branches

    The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,10 +104,10 @@

    UNPKG

    <script
        src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
        crossorigin="anonymous"
        integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
    </script>
    -

    Index

    Modules

    <internal> -

    Classes

    Prio3 -Prio3Count -Prio3Histogram -Prio3Sum -Prio3SumVec -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Index

    Modules

    <internal> +

    Classes

    Prio3 +Prio3Count +Prio3Histogram +Prio3Sum +Prio3SumVec +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_vdaf._internal_.html b/modules/_divviup_vdaf._internal_.html index df6b4622d..249caf3c3 100644 --- a/modules/_divviup_vdaf._internal_.html +++ b/modules/_divviup_vdaf._internal_.html @@ -1,19 +1,19 @@ -<internal> | Documentation

    Module <internal>

    Index

    Interfaces

    ArrayLike -Buffer -BufferConstructor -IterableIterator -Iterator -IteratorReturnResult -IteratorYieldResult -RunVdafArguments -SharedArrayBuffer -SharedArrayBufferConstructor -

    Type Aliases

    ArrayBufferLike -ArrayBufferView -BufferEncoding -IteratorResult -TypedArray -WithImplicitCoercion -

    Variables

    Buffer -SharedArrayBuffer -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +<internal> | Documentation

    Module <internal>

    Index

    Interfaces

    ArrayLike +Buffer +BufferConstructor +IterableIterator +Iterator +IteratorReturnResult +IteratorYieldResult +RunVdafArguments +SharedArrayBuffer +SharedArrayBufferConstructor +

    Type Aliases

    ArrayBufferLike +ArrayBufferView +BufferEncoding +IteratorResult +TypedArray +WithImplicitCoercion +

    Variables

    Buffer +SharedArrayBuffer +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_divviup_vdaf.html b/modules/_divviup_vdaf.html index 5962953e3..7090ee943 100644 --- a/modules/_divviup_vdaf.html +++ b/modules/_divviup_vdaf.html @@ -1,4 +1,4 @@ -@divviup/vdaf | Documentation

    Module @divviup/vdaf

    DivviUp Typescript Client

    Coverage Status +@divviup/vdaf | Documentation

    Module @divviup/vdaf

    DivviUp Typescript Client

    Coverage Status CI

    docs for main

    Protocol Versions and Release Branches

    The main branch is under continuous development and will usually be partway between DAP and VDAF @@ -104,12 +104,12 @@

    UNPKG

    <script
        src="https://unpkg.com/@divviup/dap@0.7.0/dist/browser.js"
        crossorigin="anonymous"
        integrity="sha384-vDbUcIcXsbrWLhKwkF/wwM0cnW+5y9fiPA695EnPd58okNZwWuLsR0NF98zzyNkT">
    </script>
    -

    Index

    Modules

    <internal> -

    Classes

    Vdaf -

    Interfaces

    ClientVdaf -PrepTestVector -TestVector -

    Variables

    VDAF_VERSION -

    Functions

    formatDomainSeparationTag -runVdaf -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Index

    Modules

    <internal> +

    Classes

    Vdaf +

    Interfaces

    ClientVdaf +PrepTestVector +TestVector +

    Variables

    VDAF_VERSION +

    Functions

    formatDomainSeparationTag +runVdaf +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap.KnownVdafSpec.html b/types/_divviup_dap.KnownVdafSpec.html index f3f2d4e55..5cb7d7a9b 100644 --- a/types/_divviup_dap.KnownVdafSpec.html +++ b/types/_divviup_dap.KnownVdafSpec.html @@ -1 +1 @@ -KnownVdafSpec | Documentation

    Type alias KnownVdafSpec

    KnownVdafSpec: {
        [Key in KnownVdafNames]: Omit<{
            type: Key;
        } & ConstructorParameters<KnownVdafs[Key]>[0], "shares">
    }[KnownVdafNames]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KnownVdafSpec | Documentation

    Type alias KnownVdafSpec

    KnownVdafSpec: {
        [Key in KnownVdafNames]: Omit<{
            type: Key;
        } & ConstructorParameters<KnownVdafs[Key]>[0], "shares">
    }[KnownVdafNames]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap.VdafMeasurement.html b/types/_divviup_dap.VdafMeasurement.html index 23e287f29..5f88f6653 100644 --- a/types/_divviup_dap.VdafMeasurement.html +++ b/types/_divviup_dap.VdafMeasurement.html @@ -1 +1 @@ -VdafMeasurement | Documentation

    Type alias VdafMeasurement<Spec>

    VdafMeasurement<Spec>: Parameters<VdafInstance<Spec>["shard"]>[0]

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +VdafMeasurement | Documentation

    Type alias VdafMeasurement<Spec>

    VdafMeasurement<Spec>: Parameters<VdafInstance<Spec>["shard"]>[0]

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.AeadId.html b/types/_divviup_dap._internal_.AeadId.html index 4b02ae0e1..190ea09e2 100644 --- a/types/_divviup_dap._internal_.AeadId.html +++ b/types/_divviup_dap._internal_.AeadId.html @@ -1,2 +1,2 @@ -AeadId | Documentation

    Type alias AeadId

    AeadId: typeof AeadId[keyof typeof AeadId]

    The type alias of the supported AEAD identifiers.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AeadId | Documentation

    Type alias AeadId

    AeadId: typeof AeadId[keyof typeof AeadId]

    The type alias of the supported AEAD identifiers.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.AggregationParameter.html b/types/_divviup_dap._internal_.AggregationParameter.html index f5e3cfed5..964a2bd62 100644 --- a/types/_divviup_dap._internal_.AggregationParameter.html +++ b/types/_divviup_dap._internal_.AggregationParameter.html @@ -1 +1 @@ -AggregationParameter | Documentation

    Type alias AggregationParameter

    AggregationParameter: null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregationParameter | Documentation

    Type alias AggregationParameter

    AggregationParameter: null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.AggregatorShare.html b/types/_divviup_dap._internal_.AggregatorShare.html index 76f24a1b2..d5ce41f0c 100644 --- a/types/_divviup_dap._internal_.AggregatorShare.html +++ b/types/_divviup_dap._internal_.AggregatorShare.html @@ -1 +1 @@ -AggregatorShare | Documentation

    Type alias AggregatorShare

    AggregatorShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregatorShare | Documentation

    Type alias AggregatorShare

    AggregatorShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.AlgorithmIdentifier.html b/types/_divviup_dap._internal_.AlgorithmIdentifier.html index 54b12bf81..b3afc0186 100644 --- a/types/_divviup_dap._internal_.AlgorithmIdentifier.html +++ b/types/_divviup_dap._internal_.AlgorithmIdentifier.html @@ -1 +1 @@ -AlgorithmIdentifier | Documentation

    Type alias AlgorithmIdentifier

    AlgorithmIdentifier: Algorithm | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AlgorithmIdentifier | Documentation

    Type alias AlgorithmIdentifier

    AlgorithmIdentifier: Algorithm | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.ArrayBufferLike.html b/types/_divviup_dap._internal_.ArrayBufferLike.html index 4e49a731d..94fc227ae 100644 --- a/types/_divviup_dap._internal_.ArrayBufferLike.html +++ b/types/_divviup_dap._internal_.ArrayBufferLike.html @@ -1 +1 @@ -ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.ArrayBufferView-1.html b/types/_divviup_dap._internal_.ArrayBufferView-1.html index de7de6da0..ac45e323f 100644 --- a/types/_divviup_dap._internal_.ArrayBufferView-1.html +++ b/types/_divviup_dap._internal_.ArrayBufferView-1.html @@ -1 +1 @@ -ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.BufferEncoding.html b/types/_divviup_dap._internal_.BufferEncoding.html index dff3bc33f..fbd77b92e 100644 --- a/types/_divviup_dap._internal_.BufferEncoding.html +++ b/types/_divviup_dap._internal_.BufferEncoding.html @@ -1 +1 @@ -BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.BufferSource.html b/types/_divviup_dap._internal_.BufferSource.html index c1cc9324a..2f761ef07 100644 --- a/types/_divviup_dap._internal_.BufferSource.html +++ b/types/_divviup_dap._internal_.BufferSource.html @@ -1 +1 @@ -BufferSource | Documentation

    Type alias BufferSource

    BufferSource: ArrayBufferView | ArrayBuffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BufferSource | Documentation

    Type alias BufferSource

    BufferSource: ArrayBufferView | ArrayBuffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.ConstructorParameters.html b/types/_divviup_dap._internal_.ConstructorParameters.html index ac81b7f75..d4d2e81e1 100644 --- a/types/_divviup_dap._internal_.ConstructorParameters.html +++ b/types/_divviup_dap._internal_.ConstructorParameters.html @@ -1,2 +1,2 @@ -ConstructorParameters | Documentation

    Type alias ConstructorParameters<T>

    ConstructorParameters<T>: T extends (abstract new (...args) => any)
        ? P
        : never

    Obtain the parameters of a constructor function type in a tuple

    -

    Type Parameters

    • T extends (abstract new (...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConstructorParameters | Documentation

    Type alias ConstructorParameters<T>

    ConstructorParameters<T>: T extends (abstract new (...args) => any)
        ? P
        : never

    Obtain the parameters of a constructor function type in a tuple

    +

    Type Parameters

    • T extends (abstract new (...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.Exclude.html b/types/_divviup_dap._internal_.Exclude.html index 42fedb920..2dbff7ca3 100644 --- a/types/_divviup_dap._internal_.Exclude.html +++ b/types/_divviup_dap._internal_.Exclude.html @@ -1,2 +1,2 @@ -Exclude | Documentation

    Type alias Exclude<T, U>

    Exclude<T, U>: T extends U
        ? never
        : T

    Exclude from T those types that are assignable to U

    -

    Type Parameters

    • T
    • U

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Exclude | Documentation

    Type alias Exclude<T, U>

    Exclude<T, U>: T extends U
        ? never
        : T

    Exclude from T those types that are assignable to U

    +

    Type Parameters

    • T
    • U

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.Fetch.html b/types/_divviup_dap._internal_.Fetch.html index dc3623429..70d3a5696 100644 --- a/types/_divviup_dap._internal_.Fetch.html +++ b/types/_divviup_dap._internal_.Fetch.html @@ -1 +1 @@ -Fetch | Documentation

    Type alias Fetch

    Fetch: ((input, init?) => Promise<Response>)

    Type declaration

      • (input, init?): Promise<Response>

      • Parameters

        Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Fetch | Documentation

    Type alias Fetch

    Fetch: ((input, init?) => Promise<Response>)

    Type declaration

      • (input, init?): Promise<Response>

      • Parameters

        Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.InputShare.html b/types/_divviup_dap._internal_.InputShare.html index d2f1ed60e..109decde4 100644 --- a/types/_divviup_dap._internal_.InputShare.html +++ b/types/_divviup_dap._internal_.InputShare.html @@ -1 +1 @@ -InputShare | Documentation

    Type alias InputShare

    InputShare: {
        blind: Buffer;
        measurementShare: bigint[];
        proofShare: bigint[];
        wireMeasurementShare: Buffer;
        wireProofShare: Buffer;
    }

    Type declaration

    • blind: Buffer
    • measurementShare: bigint[]
    • proofShare: bigint[]
    • wireMeasurementShare: Buffer
    • wireProofShare: Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +InputShare | Documentation

    Type alias InputShare

    InputShare: {
        blind: Buffer;
        measurementShare: bigint[];
        proofShare: bigint[];
        wireMeasurementShare: Buffer;
        wireProofShare: Buffer;
    }

    Type declaration

    • blind: Buffer
    • measurementShare: bigint[]
    • proofShare: bigint[]
    • wireMeasurementShare: Buffer
    • wireProofShare: Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.InstanceType.html b/types/_divviup_dap._internal_.InstanceType.html index b3f442a26..7bfb13fd1 100644 --- a/types/_divviup_dap._internal_.InstanceType.html +++ b/types/_divviup_dap._internal_.InstanceType.html @@ -1,2 +1,2 @@ -InstanceType | Documentation

    Type alias InstanceType<T>

    InstanceType<T>: T extends (abstract new (...args) => infer R)
        ? R
        : any

    Obtain the return type of a constructor function type

    -

    Type Parameters

    • T extends (abstract new (...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +InstanceType | Documentation

    Type alias InstanceType<T>

    InstanceType<T>: T extends (abstract new (...args) => infer R)
        ? R
        : any

    Obtain the return type of a constructor function type

    +

    Type Parameters

    • T extends (abstract new (...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.IteratorResult.html b/types/_divviup_dap._internal_.IteratorResult.html index 8c2e7c348..1c860e919 100644 --- a/types/_divviup_dap._internal_.IteratorResult.html +++ b/types/_divviup_dap._internal_.IteratorResult.html @@ -1 +1 @@ -IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KdfId.html b/types/_divviup_dap._internal_.KdfId.html index d98efd186..05f7bd2ce 100644 --- a/types/_divviup_dap._internal_.KdfId.html +++ b/types/_divviup_dap._internal_.KdfId.html @@ -1,2 +1,2 @@ -KdfId | Documentation

    Type alias KdfId

    KdfId: typeof KdfId[keyof typeof KdfId]

    The type alias of the supported KDF identifiers.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KdfId | Documentation

    Type alias KdfId

    KdfId: typeof KdfId[keyof typeof KdfId]

    The type alias of the supported KDF identifiers.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KemId.html b/types/_divviup_dap._internal_.KemId.html index 862d24d59..ac9b71367 100644 --- a/types/_divviup_dap._internal_.KemId.html +++ b/types/_divviup_dap._internal_.KemId.html @@ -1,2 +1,2 @@ -KemId | Documentation

    Type alias KemId

    KemId: typeof KemId[keyof typeof KemId]

    The type alias of the supported KEM identifiers.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KemId | Documentation

    Type alias KemId

    KemId: typeof KemId[keyof typeof KemId]

    The type alias of the supported KEM identifiers.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KeyFormat.html b/types/_divviup_dap._internal_.KeyFormat.html index dff745c01..64d46d50b 100644 --- a/types/_divviup_dap._internal_.KeyFormat.html +++ b/types/_divviup_dap._internal_.KeyFormat.html @@ -1 +1 @@ -KeyFormat | Documentation

    Type alias KeyFormat

    KeyFormat: "jwk" | "pkcs8" | "raw" | "spki"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KeyFormat | Documentation

    Type alias KeyFormat

    KeyFormat: "jwk" | "pkcs8" | "raw" | "spki"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KeyType.html b/types/_divviup_dap._internal_.KeyType.html index 5ddff8d9a..bb8a93b98 100644 --- a/types/_divviup_dap._internal_.KeyType.html +++ b/types/_divviup_dap._internal_.KeyType.html @@ -1 +1 @@ -KeyType | Documentation

    Type alias KeyType

    KeyType: "private" | "public" | "secret"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KeyType | Documentation

    Type alias KeyType

    KeyType: "private" | "public" | "secret"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KeyUsage.html b/types/_divviup_dap._internal_.KeyUsage.html index 437641ad1..09bf02499 100644 --- a/types/_divviup_dap._internal_.KeyUsage.html +++ b/types/_divviup_dap._internal_.KeyUsage.html @@ -1 +1 @@ -KeyUsage | Documentation

    Type alias KeyUsage

    KeyUsage: "decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KeyUsage | Documentation

    Type alias KeyUsage

    KeyUsage: "decrypt" | "deriveBits" | "deriveKey" | "encrypt" | "sign" | "unwrapKey" | "verify" | "wrapKey"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KnownVdaf.html b/types/_divviup_dap._internal_.KnownVdaf.html index be936e9e2..e6c6c4e55 100644 --- a/types/_divviup_dap._internal_.KnownVdaf.html +++ b/types/_divviup_dap._internal_.KnownVdaf.html @@ -1 +1 @@ -KnownVdaf | Documentation

    Type alias KnownVdaf<Spec>

    KnownVdaf<Spec>: KnownVdafs[Spec["type"]]

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KnownVdaf | Documentation

    Type alias KnownVdaf<Spec>

    KnownVdaf<Spec>: KnownVdafs[Spec["type"]]

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.KnownVdafNames.html b/types/_divviup_dap._internal_.KnownVdafNames.html index 6c9871ce7..de88478fa 100644 --- a/types/_divviup_dap._internal_.KnownVdafNames.html +++ b/types/_divviup_dap._internal_.KnownVdafNames.html @@ -1 +1 @@ -KnownVdafNames | Documentation

    Type alias KnownVdafNames

    KnownVdafNames: keyof KnownVdafs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KnownVdafNames | Documentation

    Type alias KnownVdafNames

    KnownVdafNames: keyof KnownVdafs

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.Omit.html b/types/_divviup_dap._internal_.Omit.html index a8e16e1ab..f7c0f65c0 100644 --- a/types/_divviup_dap._internal_.Omit.html +++ b/types/_divviup_dap._internal_.Omit.html @@ -1,2 +1,2 @@ -Omit | Documentation

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Construct a type with the properties of T except for those in type K.

    -

    Type Parameters

    • T
    • K extends keyof any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Omit | Documentation

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Construct a type with the properties of T except for those in type K.

    +

    Type Parameters

    • T
    • K extends keyof any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.OutputShare.html b/types/_divviup_dap._internal_.OutputShare.html index 1ec26cd2d..226fd2241 100644 --- a/types/_divviup_dap._internal_.OutputShare.html +++ b/types/_divviup_dap._internal_.OutputShare.html @@ -1 +1 @@ -OutputShare | Documentation

    Type alias OutputShare

    OutputShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OutputShare | Documentation

    Type alias OutputShare

    OutputShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.Parameters.html b/types/_divviup_dap._internal_.Parameters.html index 822b0c610..2575b75d2 100644 --- a/types/_divviup_dap._internal_.Parameters.html +++ b/types/_divviup_dap._internal_.Parameters.html @@ -1,2 +1,2 @@ -Parameters | Documentation

    Type alias Parameters<T>

    Parameters<T>: T extends ((...args) => any)
        ? P
        : never

    Obtain the parameters of a function type in a tuple

    -

    Type Parameters

    • T extends ((...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Parameters | Documentation

    Type alias Parameters<T>

    Parameters<T>: T extends ((...args) => any)
        ? P
        : never

    Obtain the parameters of a function type in a tuple

    +

    Type Parameters

    • T extends ((...args) => any)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.ParseSource.html b/types/_divviup_dap._internal_.ParseSource.html index 257e4baef..9b01919ce 100644 --- a/types/_divviup_dap._internal_.ParseSource.html +++ b/types/_divviup_dap._internal_.ParseSource.html @@ -1 +1 @@ -ParseSource | Documentation

    Type alias ParseSource

    ParseSource: Parser | ArrayBuffer | Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ParseSource | Documentation

    Type alias ParseSource

    ParseSource: Parser | ArrayBuffer | Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.Pick.html b/types/_divviup_dap._internal_.Pick.html index 31e922af2..f21623372 100644 --- a/types/_divviup_dap._internal_.Pick.html +++ b/types/_divviup_dap._internal_.Pick.html @@ -1,2 +1,2 @@ -Pick | Documentation

    Type alias Pick<T, K>

    Pick<T, K>: {
        [P in K]: T[P]
    }

    From T, pick a set of properties whose keys are in the union K

    -

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Pick | Documentation

    Type alias Pick<T, K>

    Pick<T, K>: {
        [P in K]: T[P]
    }

    From T, pick a set of properties whose keys are in the union K

    +

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.PreparationMessage.html b/types/_divviup_dap._internal_.PreparationMessage.html index 3b94f9978..688ad78c7 100644 --- a/types/_divviup_dap._internal_.PreparationMessage.html +++ b/types/_divviup_dap._internal_.PreparationMessage.html @@ -1 +1 @@ -PreparationMessage | Documentation

    Type alias PreparationMessage

    PreparationMessage: {
        jointRand: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationMessage | Documentation

    Type alias PreparationMessage

    PreparationMessage: {
        jointRand: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.PreparationShare.html b/types/_divviup_dap._internal_.PreparationShare.html index be3a85eb6..aa2b27cfe 100644 --- a/types/_divviup_dap._internal_.PreparationShare.html +++ b/types/_divviup_dap._internal_.PreparationShare.html @@ -1 +1 @@ -PreparationShare | Documentation

    Type alias PreparationShare

    PreparationShare: {
        jointRandomnessPart: Buffer;
        verifierShare: bigint[];
    }

    Type declaration

    • jointRandomnessPart: Buffer
    • verifierShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationShare | Documentation

    Type alias PreparationShare

    PreparationShare: {
        jointRandomnessPart: Buffer;
        verifierShare: bigint[];
    }

    Type declaration

    • jointRandomnessPart: Buffer
    • verifierShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.PreparationState.html b/types/_divviup_dap._internal_.PreparationState.html index 59800096c..aa82fcbc4 100644 --- a/types/_divviup_dap._internal_.PreparationState.html +++ b/types/_divviup_dap._internal_.PreparationState.html @@ -1 +1 @@ -PreparationState | Documentation

    Type alias PreparationState

    PreparationState: {
        correctedJointRandSeed: Buffer;
        outputShare: OutputShare;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationState | Documentation

    Type alias PreparationState

    PreparationState: {
        correctedJointRandSeed: Buffer;
        outputShare: OutputShare;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.PublicShare.html b/types/_divviup_dap._internal_.PublicShare.html index 854ec352c..894a58820 100644 --- a/types/_divviup_dap._internal_.PublicShare.html +++ b/types/_divviup_dap._internal_.PublicShare.html @@ -1 +1 @@ -PublicShare | Documentation

    Type alias PublicShare

    PublicShare: {
        jointRandParts: Buffer[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PublicShare | Documentation

    Type alias PublicShare

    PublicShare: {
        jointRandParts: Buffer[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.RequestInfo.html b/types/_divviup_dap._internal_.RequestInfo.html index d31ffcb53..a85a6d2cb 100644 --- a/types/_divviup_dap._internal_.RequestInfo.html +++ b/types/_divviup_dap._internal_.RequestInfo.html @@ -1 +1 @@ -RequestInfo | Documentation

    Type alias RequestInfo

    RequestInfo: Request | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +RequestInfo | Documentation

    Type alias RequestInfo

    RequestInfo: Request | string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.TypedArray.html b/types/_divviup_dap._internal_.TypedArray.html index de8fd0849..7ae0cd7fb 100644 --- a/types/_divviup_dap._internal_.TypedArray.html +++ b/types/_divviup_dap._internal_.TypedArray.html @@ -1 +1 @@ -TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.VdafInstance.html b/types/_divviup_dap._internal_.VdafInstance.html index 83cfe2f68..6cba6b95f 100644 --- a/types/_divviup_dap._internal_.VdafInstance.html +++ b/types/_divviup_dap._internal_.VdafInstance.html @@ -1 +1 @@ -VdafInstance | Documentation

    Type alias VdafInstance<Spec>

    VdafInstance<Spec>: InstanceType<KnownVdaf<Spec>>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +VdafInstance | Documentation

    Type alias VdafInstance<Spec>

    VdafInstance<Spec>: InstanceType<KnownVdaf<Spec>>

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_dap._internal_.WithImplicitCoercion.html b/types/_divviup_dap._internal_.WithImplicitCoercion.html index b71030114..887e5c261 100644 --- a/types/_divviup_dap._internal_.WithImplicitCoercion.html +++ b/types/_divviup_dap._internal_.WithImplicitCoercion.html @@ -1 +1 @@ -WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.AggregationParameter.html b/types/_divviup_prio3._internal_.AggregationParameter.html index 6155d71c6..d8f41d110 100644 --- a/types/_divviup_prio3._internal_.AggregationParameter.html +++ b/types/_divviup_prio3._internal_.AggregationParameter.html @@ -1 +1 @@ -AggregationParameter | Documentation

    Type alias AggregationParameter

    AggregationParameter: null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregationParameter | Documentation

    Type alias AggregationParameter

    AggregationParameter: null

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.AggregatorShare.html b/types/_divviup_prio3._internal_.AggregatorShare.html index bb76743b3..5e2b22bab 100644 --- a/types/_divviup_prio3._internal_.AggregatorShare.html +++ b/types/_divviup_prio3._internal_.AggregatorShare.html @@ -1 +1 @@ -AggregatorShare | Documentation

    Type alias AggregatorShare

    AggregatorShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AggregatorShare | Documentation

    Type alias AggregatorShare

    AggregatorShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.ArrayBufferLike.html b/types/_divviup_prio3._internal_.ArrayBufferLike.html index 1ad6b74fd..72aea1bb2 100644 --- a/types/_divviup_prio3._internal_.ArrayBufferLike.html +++ b/types/_divviup_prio3._internal_.ArrayBufferLike.html @@ -1 +1 @@ -ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.ArrayBufferView.html b/types/_divviup_prio3._internal_.ArrayBufferView.html index 34b3b4fe4..2e1eef714 100644 --- a/types/_divviup_prio3._internal_.ArrayBufferView.html +++ b/types/_divviup_prio3._internal_.ArrayBufferView.html @@ -1 +1 @@ -ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.BufferEncoding.html b/types/_divviup_prio3._internal_.BufferEncoding.html index ea9893d0d..0c277cd5a 100644 --- a/types/_divviup_prio3._internal_.BufferEncoding.html +++ b/types/_divviup_prio3._internal_.BufferEncoding.html @@ -1 +1 @@ -BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.Exclude.html b/types/_divviup_prio3._internal_.Exclude.html index d8120678c..5f82e39a7 100644 --- a/types/_divviup_prio3._internal_.Exclude.html +++ b/types/_divviup_prio3._internal_.Exclude.html @@ -1,2 +1,2 @@ -Exclude | Documentation

    Type alias Exclude<T, U>

    Exclude<T, U>: T extends U
        ? never
        : T

    Exclude from T those types that are assignable to U

    -

    Type Parameters

    • T
    • U

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Exclude | Documentation

    Type alias Exclude<T, U>

    Exclude<T, U>: T extends U
        ? never
        : T

    Exclude from T those types that are assignable to U

    +

    Type Parameters

    • T
    • U

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.InputShare.html b/types/_divviup_prio3._internal_.InputShare.html index 8f1ec18eb..f1f2dcb4b 100644 --- a/types/_divviup_prio3._internal_.InputShare.html +++ b/types/_divviup_prio3._internal_.InputShare.html @@ -1 +1 @@ -InputShare | Documentation

    Type alias InputShare

    InputShare: {
        blind: Buffer;
        measurementShare: bigint[];
        proofShare: bigint[];
        wireMeasurementShare: Buffer;
        wireProofShare: Buffer;
    }

    Type declaration

    • blind: Buffer
    • measurementShare: bigint[]
    • proofShare: bigint[]
    • wireMeasurementShare: Buffer
    • wireProofShare: Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +InputShare | Documentation

    Type alias InputShare

    InputShare: {
        blind: Buffer;
        measurementShare: bigint[];
        proofShare: bigint[];
        wireMeasurementShare: Buffer;
        wireProofShare: Buffer;
    }

    Type declaration

    • blind: Buffer
    • measurementShare: bigint[]
    • proofShare: bigint[]
    • wireMeasurementShare: Buffer
    • wireProofShare: Buffer

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.IteratorResult.html b/types/_divviup_prio3._internal_.IteratorResult.html index 66770d280..4b9f7a150 100644 --- a/types/_divviup_prio3._internal_.IteratorResult.html +++ b/types/_divviup_prio3._internal_.IteratorResult.html @@ -1 +1 @@ -IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.Omit.html b/types/_divviup_prio3._internal_.Omit.html index f5b596a48..ea1a27918 100644 --- a/types/_divviup_prio3._internal_.Omit.html +++ b/types/_divviup_prio3._internal_.Omit.html @@ -1,2 +1,2 @@ -Omit | Documentation

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Construct a type with the properties of T except for those in type K.

    -

    Type Parameters

    • T
    • K extends keyof any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Omit | Documentation

    Type alias Omit<T, K>

    Omit<T, K>: Pick<T, Exclude<keyof T, K>>

    Construct a type with the properties of T except for those in type K.

    +

    Type Parameters

    • T
    • K extends keyof any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.OutputShare.html b/types/_divviup_prio3._internal_.OutputShare.html index af650e8c8..9b285f434 100644 --- a/types/_divviup_prio3._internal_.OutputShare.html +++ b/types/_divviup_prio3._internal_.OutputShare.html @@ -1 +1 @@ -OutputShare | Documentation

    Type alias OutputShare

    OutputShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +OutputShare | Documentation

    Type alias OutputShare

    OutputShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.Pick.html b/types/_divviup_prio3._internal_.Pick.html index 4ab3e564f..9a6584020 100644 --- a/types/_divviup_prio3._internal_.Pick.html +++ b/types/_divviup_prio3._internal_.Pick.html @@ -1,2 +1,2 @@ -Pick | Documentation

    Type alias Pick<T, K>

    Pick<T, K>: {
        [P in K]: T[P]
    }

    From T, pick a set of properties whose keys are in the union K

    -

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Pick | Documentation

    Type alias Pick<T, K>

    Pick<T, K>: {
        [P in K]: T[P]
    }

    From T, pick a set of properties whose keys are in the union K

    +

    Type Parameters

    • T
    • K extends keyof T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.PreparationMessage.html b/types/_divviup_prio3._internal_.PreparationMessage.html index 5ca2136a0..b524ac16c 100644 --- a/types/_divviup_prio3._internal_.PreparationMessage.html +++ b/types/_divviup_prio3._internal_.PreparationMessage.html @@ -1 +1 @@ -PreparationMessage | Documentation

    Type alias PreparationMessage

    PreparationMessage: {
        jointRand: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationMessage | Documentation

    Type alias PreparationMessage

    PreparationMessage: {
        jointRand: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.PreparationShare.html b/types/_divviup_prio3._internal_.PreparationShare.html index 583f15ff8..fa36efcba 100644 --- a/types/_divviup_prio3._internal_.PreparationShare.html +++ b/types/_divviup_prio3._internal_.PreparationShare.html @@ -1 +1 @@ -PreparationShare | Documentation

    Type alias PreparationShare

    PreparationShare: {
        jointRandomnessPart: Buffer;
        verifierShare: bigint[];
    }

    Type declaration

    • jointRandomnessPart: Buffer
    • verifierShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationShare | Documentation

    Type alias PreparationShare

    PreparationShare: {
        jointRandomnessPart: Buffer;
        verifierShare: bigint[];
    }

    Type declaration

    • jointRandomnessPart: Buffer
    • verifierShare: bigint[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.PreparationState.html b/types/_divviup_prio3._internal_.PreparationState.html index 6f1e85e15..dd5eac0b5 100644 --- a/types/_divviup_prio3._internal_.PreparationState.html +++ b/types/_divviup_prio3._internal_.PreparationState.html @@ -1 +1 @@ -PreparationState | Documentation

    Type alias PreparationState

    PreparationState: {
        correctedJointRandSeed: Buffer;
        outputShare: OutputShare;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PreparationState | Documentation

    Type alias PreparationState

    PreparationState: {
        correctedJointRandSeed: Buffer;
        outputShare: OutputShare;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.PublicShare.html b/types/_divviup_prio3._internal_.PublicShare.html index 4df35be82..e8a22509d 100644 --- a/types/_divviup_prio3._internal_.PublicShare.html +++ b/types/_divviup_prio3._internal_.PublicShare.html @@ -1 +1 @@ -PublicShare | Documentation

    Type alias PublicShare

    PublicShare: {
        jointRandParts: Buffer[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PublicShare | Documentation

    Type alias PublicShare

    PublicShare: {
        jointRandParts: Buffer[];
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.Share.html b/types/_divviup_prio3._internal_.Share.html index 0572a00ba..3492b9652 100644 --- a/types/_divviup_prio3._internal_.Share.html +++ b/types/_divviup_prio3._internal_.Share.html @@ -1 +1 @@ -Share | Documentation

    Type alias Share

    Share: InputShare & {
        jointRandPart: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Share | Documentation

    Type alias Share

    Share: InputShare & {
        jointRandPart: Buffer;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.TypedArray.html b/types/_divviup_prio3._internal_.TypedArray.html index 94f06cbef..e5af4541e 100644 --- a/types/_divviup_prio3._internal_.TypedArray.html +++ b/types/_divviup_prio3._internal_.TypedArray.html @@ -1 +1 @@ -TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_prio3._internal_.WithImplicitCoercion.html b/types/_divviup_prio3._internal_.WithImplicitCoercion.html index bdec2292c..faacb114d 100644 --- a/types/_divviup_prio3._internal_.WithImplicitCoercion.html +++ b/types/_divviup_prio3._internal_.WithImplicitCoercion.html @@ -1 +1 @@ -WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.ArrayBufferLike.html b/types/_divviup_vdaf._internal_.ArrayBufferLike.html index 9cf0c8de2..32f74f2cd 100644 --- a/types/_divviup_vdaf._internal_.ArrayBufferLike.html +++ b/types/_divviup_vdaf._internal_.ArrayBufferLike.html @@ -1 +1 @@ -ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferLike | Documentation

    Type alias ArrayBufferLike

    ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.ArrayBufferView.html b/types/_divviup_vdaf._internal_.ArrayBufferView.html index cb0fe4128..ef73d2ff4 100644 --- a/types/_divviup_vdaf._internal_.ArrayBufferView.html +++ b/types/_divviup_vdaf._internal_.ArrayBufferView.html @@ -1 +1 @@ -ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ArrayBufferView | Documentation

    Type alias ArrayBufferView

    ArrayBufferView: TypedArray | DataView

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.BufferEncoding.html b/types/_divviup_vdaf._internal_.BufferEncoding.html index a93b0052e..fc599bc48 100644 --- a/types/_divviup_vdaf._internal_.BufferEncoding.html +++ b/types/_divviup_vdaf._internal_.BufferEncoding.html @@ -1 +1 @@ -BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +BufferEncoding | Documentation

    Type alias BufferEncoding

    BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.IteratorResult.html b/types/_divviup_vdaf._internal_.IteratorResult.html index 338f1c046..d4be17720 100644 --- a/types/_divviup_vdaf._internal_.IteratorResult.html +++ b/types/_divviup_vdaf._internal_.IteratorResult.html @@ -1 +1 @@ -IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +IteratorResult | Documentation

    Type alias IteratorResult<T, TReturn>

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

    Type Parameters

    • T
    • TReturn = any

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.TypedArray.html b/types/_divviup_vdaf._internal_.TypedArray.html index 7c27136a0..6ddb92e42 100644 --- a/types/_divviup_vdaf._internal_.TypedArray.html +++ b/types/_divviup_vdaf._internal_.TypedArray.html @@ -1 +1 @@ -TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +TypedArray | Documentation

    Type alias TypedArray

    TypedArray: Uint8Array | Uint8ClampedArray | Uint16Array | Uint32Array | Int8Array | Int16Array | Int32Array | BigUint64Array | BigInt64Array | Float32Array | Float64Array

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_divviup_vdaf._internal_.WithImplicitCoercion.html b/types/_divviup_vdaf._internal_.WithImplicitCoercion.html index 7ecde4940..a247c436f 100644 --- a/types/_divviup_vdaf._internal_.WithImplicitCoercion.html +++ b/types/_divviup_vdaf._internal_.WithImplicitCoercion.html @@ -1 +1 @@ -WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WithImplicitCoercion | Documentation

    Type alias WithImplicitCoercion<T>

    WithImplicitCoercion<T>: T | {
        valueOf(): T;
    }

    Type Parameters

    • T

    Type declaration

    • valueOf:function
      • valueOf(): T

      • Returns T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.AeadId-1.html b/variables/_divviup_dap._internal_.AeadId-1.html index 12dc39d02..29e67581e 100644 --- a/variables/_divviup_dap._internal_.AeadId-1.html +++ b/variables/_divviup_dap._internal_.AeadId-1.html @@ -1,2 +1,2 @@ -AeadId | Documentation

    Variable AeadIdConst

    AeadId: {
        Aes128Gcm: 1;
        Aes256Gcm: 2;
        Chacha20Poly1305: 3;
        ExportOnly: 65535;
    }

    The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

    -

    Type declaration

    • Readonly Aes128Gcm: 1
    • Readonly Aes256Gcm: 2
    • Readonly Chacha20Poly1305: 3
    • Readonly ExportOnly: 65535

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +AeadId | Documentation

    Variable AeadIdConst

    AeadId: {
        Aes128Gcm: 1;
        Aes256Gcm: 2;
        Chacha20Poly1305: 3;
        ExportOnly: 65535;
    }

    The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

    +

    Type declaration

    • Readonly Aes128Gcm: 1
    • Readonly Aes256Gcm: 2
    • Readonly Chacha20Poly1305: 3
    • Readonly ExportOnly: 65535

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.Buffer-1.html b/variables/_divviup_dap._internal_.Buffer-1.html index 9c81d6a42..51c464a09 100644 --- a/variables/_divviup_dap._internal_.Buffer-1.html +++ b/variables/_divviup_dap._internal_.Buffer-1.html @@ -1 +1 @@ -Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.CryptoKey-1.html b/variables/_divviup_dap._internal_.CryptoKey-1.html index 4a08c2199..ab139fed4 100644 --- a/variables/_divviup_dap._internal_.CryptoKey-1.html +++ b/variables/_divviup_dap._internal_.CryptoKey-1.html @@ -1 +1 @@ -CryptoKey | Documentation

    Variable CryptoKey

    CryptoKey: {
        prototype: CryptoKey;
        new (): CryptoKey;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CryptoKey | Documentation

    Variable CryptoKey

    CryptoKey: {
        prototype: CryptoKey;
        new (): CryptoKey;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.Error-1.html b/variables/_divviup_dap._internal_.Error-1.html index 15e000037..035619f22 100644 --- a/variables/_divviup_dap._internal_.Error-1.html +++ b/variables/_divviup_dap._internal_.Error-1.html @@ -1 +1 @@ -Error | Documentation

    Variable Error

    Error: ErrorConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Error | Documentation

    Variable Error

    Error: ErrorConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.KdfId-1.html b/variables/_divviup_dap._internal_.KdfId-1.html index 2b0ade6ba..eaebc8225 100644 --- a/variables/_divviup_dap._internal_.KdfId-1.html +++ b/variables/_divviup_dap._internal_.KdfId-1.html @@ -1,2 +1,2 @@ -KdfId | Documentation

    Variable KdfIdConst

    KdfId: {
        HkdfSha256: 1;
        HkdfSha384: 2;
        HkdfSha512: 3;
    }

    The supported Key Derivation Function (KDF) identifiers.

    -

    Type declaration

    • Readonly HkdfSha256: 1
    • Readonly HkdfSha384: 2
    • Readonly HkdfSha512: 3

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KdfId | Documentation

    Variable KdfIdConst

    KdfId: {
        HkdfSha256: 1;
        HkdfSha384: 2;
        HkdfSha512: 3;
    }

    The supported Key Derivation Function (KDF) identifiers.

    +

    Type declaration

    • Readonly HkdfSha256: 1
    • Readonly HkdfSha384: 2
    • Readonly HkdfSha512: 3

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.KemId-1.html b/variables/_divviup_dap._internal_.KemId-1.html index f1f3e3715..0d10f4d4a 100644 --- a/variables/_divviup_dap._internal_.KemId-1.html +++ b/variables/_divviup_dap._internal_.KemId-1.html @@ -1,2 +1,2 @@ -KemId | Documentation

    Variable KemIdConst

    KemId: {
        DhkemP256HkdfSha256: 16;
        DhkemP384HkdfSha384: 17;
        DhkemP521HkdfSha512: 18;
        DhkemSecp256k1HkdfSha256: 19;
        DhkemX25519HkdfSha256: 32;
        DhkemX448HkdfSha512: 33;
        HybridkemX25519Kyber768: 48;
        NotAssigned: 0;
    }

    The supported Key Encapsulation Mechanism (KEM) identifiers.

    -

    Type declaration

    • Readonly DhkemP256HkdfSha256: 16
    • Readonly DhkemP384HkdfSha384: 17
    • Readonly DhkemP521HkdfSha512: 18
    • Readonly DhkemSecp256k1HkdfSha256: 19
    • Readonly DhkemX25519HkdfSha256: 32
    • Readonly DhkemX448HkdfSha512: 33
    • Readonly HybridkemX25519Kyber768: 48
    • Readonly NotAssigned: 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KemId | Documentation

    Variable KemIdConst

    KemId: {
        DhkemP256HkdfSha256: 16;
        DhkemP384HkdfSha384: 17;
        DhkemP521HkdfSha512: 18;
        DhkemSecp256k1HkdfSha256: 19;
        DhkemX25519HkdfSha256: 32;
        DhkemX448HkdfSha512: 33;
        HybridkemX25519Kyber768: 48;
        NotAssigned: 0;
    }

    The supported Key Encapsulation Mechanism (KEM) identifiers.

    +

    Type declaration

    • Readonly DhkemP256HkdfSha256: 16
    • Readonly DhkemP384HkdfSha384: 17
    • Readonly DhkemP521HkdfSha512: 18
    • Readonly DhkemSecp256k1HkdfSha256: 19
    • Readonly DhkemX25519HkdfSha256: 32
    • Readonly DhkemX448HkdfSha512: 33
    • Readonly HybridkemX25519Kyber768: 48
    • Readonly NotAssigned: 0

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.SharedArrayBuffer-1.html b/variables/_divviup_dap._internal_.SharedArrayBuffer-1.html index 4cc0a3c43..317d144e4 100644 --- a/variables/_divviup_dap._internal_.SharedArrayBuffer-1.html +++ b/variables/_divviup_dap._internal_.SharedArrayBuffer-1.html @@ -1 +1 @@ -SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_dap._internal_.SubtleCrypto-1.html b/variables/_divviup_dap._internal_.SubtleCrypto-1.html index 63345db38..13cb1192e 100644 --- a/variables/_divviup_dap._internal_.SubtleCrypto-1.html +++ b/variables/_divviup_dap._internal_.SubtleCrypto-1.html @@ -1 +1 @@ -SubtleCrypto | Documentation

    Variable SubtleCrypto

    SubtleCrypto: {
        prototype: SubtleCrypto;
        new (): SubtleCrypto;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SubtleCrypto | Documentation

    Variable SubtleCrypto

    SubtleCrypto: {
        prototype: SubtleCrypto;
        new (): SubtleCrypto;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_prio3._internal_.Buffer-1.html b/variables/_divviup_prio3._internal_.Buffer-1.html index 25021cee1..fe6e76691 100644 --- a/variables/_divviup_prio3._internal_.Buffer-1.html +++ b/variables/_divviup_prio3._internal_.Buffer-1.html @@ -1 +1 @@ -Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_prio3._internal_.SharedArrayBuffer-1.html b/variables/_divviup_prio3._internal_.SharedArrayBuffer-1.html index 8d12127f0..5603b6a18 100644 --- a/variables/_divviup_prio3._internal_.SharedArrayBuffer-1.html +++ b/variables/_divviup_prio3._internal_.SharedArrayBuffer-1.html @@ -1 +1 @@ -SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_vdaf.VDAF_VERSION.html b/variables/_divviup_vdaf.VDAF_VERSION.html index 4667aa127..b09efdff4 100644 --- a/variables/_divviup_vdaf.VDAF_VERSION.html +++ b/variables/_divviup_vdaf.VDAF_VERSION.html @@ -1 +1 @@ -VDAF_VERSION | Documentation

    Variable VDAF_VERSIONConst

    VDAF_VERSION: "vdaf-07" = "vdaf-07"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +VDAF_VERSION | Documentation

    Variable VDAF_VERSIONConst

    VDAF_VERSION: "vdaf-07" = "vdaf-07"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_vdaf._internal_.Buffer-1.html b/variables/_divviup_vdaf._internal_.Buffer-1.html index 41f45b678..c053341fa 100644 --- a/variables/_divviup_vdaf._internal_.Buffer-1.html +++ b/variables/_divviup_vdaf._internal_.Buffer-1.html @@ -1 +1 @@ -Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Buffer | Documentation

    Variable Buffer

    Buffer: BufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_divviup_vdaf._internal_.SharedArrayBuffer-1.html b/variables/_divviup_vdaf._internal_.SharedArrayBuffer-1.html index e80d3cd5e..c6db43cda 100644 --- a/variables/_divviup_vdaf._internal_.SharedArrayBuffer-1.html +++ b/variables/_divviup_vdaf._internal_.SharedArrayBuffer-1.html @@ -1 +1 @@ -SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +SharedArrayBuffer | Documentation

    Variable SharedArrayBuffer

    SharedArrayBuffer: SharedArrayBufferConstructor

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file