diff --git a/assets/highlight.css b/assets/highlight.css index 7349ef7..2df6e52 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -11,6 +11,8 @@ --dark-hl-4: #9CDCFE; --light-hl-5: #0000FF; --dark-hl-5: #569CD6; + --light-hl-6: #008000; + --dark-hl-6: #6A9955; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -22,6 +24,7 @@ --hl-3: var(--light-hl-3); --hl-4: var(--light-hl-4); --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); --code-background: var(--light-code-background); } } @@ -32,6 +35,7 @@ --hl-3: var(--dark-hl-3); --hl-4: var(--dark-hl-4); --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); --code-background: var(--dark-code-background); } } @@ -42,6 +46,7 @@ --hl-3: var(--light-hl-3); --hl-4: var(--light-hl-4); --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); --code-background: var(--light-code-background); } @@ -52,6 +57,7 @@ --hl-3: var(--dark-hl-3); --hl-4: var(--dark-hl-4); --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); --code-background: var(--dark-code-background); } @@ -61,4 +67,5 @@ .hl-3 { color: var(--hl-3); } .hl-4 { color: var(--hl-4); } .hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } pre, code { background: var(--code-background); } diff --git a/assets/main.js b/assets/main.js index 4c8fa61..d0aa8d5 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Se=Object.create;var re=Object.defineProperty;var we=Object.getOwnPropertyDescriptor;var Te=Object.getOwnPropertyNames;var ke=Object.getPrototypeOf,Qe=Object.prototype.hasOwnProperty;var Pe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Ie=(t,e,r,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Te(e))!Qe.call(t,i)&&i!==r&&re(t,i,{get:()=>e[i],enumerable:!(n=we(e,i))||n.enumerable});return t};var Ce=(t,e,r)=>(r=t!=null?Se(ke(t)):{},Ie(e||!t||!t.__esModule?re(r,"default",{value:t,enumerable:!0}):r,t));var ae=Pe((se,oe)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var d=t.utils.clone(r)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(n.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(r+=n[u+1]*i[d+1],u+=2,d+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),y;m in s.node.edges?y=s.node.edges[m]:(y=new t.TokenSet,s.node.edges[m]=y),s.str.length==1&&(y.final=!0),i.push({node:y,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof se=="object"?oe.exports=r():e.lunr=r()}(this,function(){return t})})()});var ne=[];function G(t,e){ne.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){ne.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n,app:this}),n.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),r=e?.parentElement;for(;r&&!r.classList.contains(".tsd-navigation");)r instanceof HTMLDetailsElement&&(r.open=!0),r=r.parentElement;if(e){let n=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=n}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let r=e.parentElement;for(;r&&r.tagName!=="SECTION";)r=r.parentElement;if(r&&r.offsetParent==null){this.alwaysVisibleMember=r,r.classList.add("always-visible");let n=document.createElement("p");n.classList.add("warning"),n.textContent="This member is normally hidden due to your filter settings.",r.prepend(n)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let r;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(r),r=setTimeout(()=>{e.classList.remove("visible"),r=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let r;return()=>{clearTimeout(r),r=setTimeout(()=>t(),e)}};var ce=Ce(ae());function de(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("tsd-search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Oe(t,n,r,s)}function Oe(t,e,r,n){r.addEventListener("input",ie(()=>{Re(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Fe(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function _e(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=ce.Index.load(window.searchData.index))}function Re(t,e,r,n){if(_e(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=i?n.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${le(l.parent,i)}.${u}`);let d=document.createElement("li");d.classList.value=l.classes??"";let m=document.createElement("a");m.href=n.base+l.url,m.innerHTML=u,d.append(m),e.appendChild(d)}}function ue(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling??void 0;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Fe(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function le(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(K(t.substring(s))),i.join("")}var Me={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Me[e])}var P=class{constructor(e){this.el=e.el,this.app=e.app}};var M="mousedown",fe="mousemove",N="mouseup",J={x:0,y:0},he=!1,ee=!1,De=!1,D=!1,pe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(pe?"is-mobile":"not-mobile");pe&&"ontouchstart"in document.documentElement&&(De=!0,M="touchstart",fe="touchmove",N="touchend");document.addEventListener(M,t=>{ee=!0,D=!1;let e=M=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=M=="touchstart"?t.targetTouches[0]:t,r=J.x-(e.pageX||0),n=J.y-(e.pageY||0);D=Math.sqrt(r*r+n*n)>10}});document.addEventListener(N,()=>{ee=!1});document.addEventListener("click",t=>{he&&(t.preventDefault(),t.stopImmediatePropagation(),he=!1)});var X=class extends P{constructor(r){super(r);this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(M,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(r){if(this.active==r)return;this.active=r,document.documentElement.classList.toggle("has-"+this.className,r),this.el.classList.toggle("active",r);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(r){D||(this.setActive(!0),r.preventDefault())}onDocumentPointerDown(r){if(this.active){if(r.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(r){if(!D&&this.active&&r.target.closest(".col-sidebar")){let n=r.target.closest("a");if(n){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),n.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var me=document.head.appendChild(document.createElement("style"));me.dataset.for="filters";var Y=class extends P{constructor(r){super(r);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),me.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`}fromLocalStorage(){let r=Q.getItem(this.key);return r?r==="true":this.el.checked}setLocalStorage(r){Q.setItem(this.key,r.toString()),this.value=r,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let n=Array.from(r.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);r.style.display=n?"none":"block"})}};var Z=class extends P{constructor(r){super(r);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update()),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ve(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}de();G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var ge=document.getElementById("tsd-theme");ge&&ve(ge);var Ae=new U;Object.defineProperty(window,"app",{value:Ae});document.querySelectorAll("summary a").forEach(t=>{t.addEventListener("click",()=>{location.assign(t.href)})});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;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 Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(B,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){D||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!D&&this.active&&n.target.closest(".col-sidebar")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var Z=class extends C{constructor(n){super(n);this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let r=Q.getItem(this.key);this.el.open=r?r==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let i=this.summary.querySelector("a");i&&i.addEventListener("click",()=>{location.assign(i.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/navigation.js b/assets/navigation.js new file mode 100644 index 0000000..61c677c --- /dev/null +++ b/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6Wa227cNhCG32V7Gzex46SN74rYLlIkTuAs2ovAF7TE9QqWyIVEOV4XffdSZx5mKHF0uTs/v5+ixOPwx78bxZ/V5mLzUaY82bzaHJja65+FTOucV7/uVZH/MsQeM5FuLs5PP5y/fXP+apPkrKq0VlXpSVadaA4vBcs3/72aqHVZZjy9FhjZiFPolZLFVVnKEuWbCsvB4FzyJCs0GmZM0fga6rK67UI1tBXxDleZ2nMMPgap3D+qo8C+CluxymF7PPBbvps3moRUv29MNaEq6GWICD7PB54onjZ1xVxsSbzHdSmLAN8Ix7P/5CqAnqLx5L90b0SwfSie+ZnvMGYfIjAztJ59KJ75hR3vsTYdYkRqqJNagjX8cBeFdES3mQ7qauJdbqS4Kg7qGHjLjmSdx0dZHPKMiSVmpnada/h9wUqKo9pn4gF1GaIEcl3wMktCU6cjwWb3r2WKTpBDLL5+37InqS6Zwvq0GcdqdssTnj0FZwpHEl/P2+xhj315Qyye+j3w5N9nnrqN3zLxEAQMgiBlmxVBSB/HGNv6kGPlh1h827Qlw93PkcR7sPwnO2JD5BgkcMuSHTFsH4un3kuZc4btAaZoPDnR4yUrsXc4RQlkvTPBWmKIUahzOxZDcXIa+HZTvAOmQP9bVLs0uA/qo+FadZpm/XlT5zm7R/sXrMS4XDRjPVOZxL4iWxH/7PyZJSrH3vgUjSc/cPWZVeofzh9TtHN5IqwltHBu6nEkAdJWBms0hDHCvhZpyVMEMEWx8lnKhcoUVgMjHN/qmdD/VXqXhcGNOIFeyWtZFiz0GlwN2gqmLjCjQTqMmbMXrFX7UPwzF+yAILsIhYjvidqYP9Ys4or5Fb4pWemybX6GXXoJ9raEVJ/0up8X+ntHu5MnQml6OA2sKI0w4ZnDg7pARvKF7OIeXaiPwXiuFFh1uwjWjjr6FVvADTFCbQ7NFIVOskaYwG52M1t5E2pIVxPvopdUVfBI0xLE80ue6Eoi7DEYz63Yjl9mTwh4imLfQ8VEprIXHujvjmSOlN7MDyGYFmWrEt+Qj0FC69VFfxCObTtsBVY/tZe1fibs/RphlBDYtbUx4nhei0chf2LryylKIbdfV3B17Wqwp3/hpUQQfQhdQ4Nd9nX7dwuYyuqn2me5Xr2JzcWPcLqlXUftWDKSDJVNPXv3fm4ntKtF0ox/A8vaDNm090smUJdn6zzgnYEcigIv7PUUW9RuzgFUs1OxGG3cJv2+LP9l5+yMV2HQW5H3Jki5JdigU61xcA6wQzatdLWXdzoza9mXoDk7Z/+wWStawV/UiJNyrdPCJvQK0HzhM3vY0tSud1v4nEARmrdzJgm7taIV/IUPZWppbkD+X2mePUANGsfizYffTt+d0dPsnpGholthWWTPzRauMATTyb6dIaOb+Xllz2iQ0E28BLPn0SvoFkgm0TOydHS7mXSfZwvq6fZwHslzNWV0M2fR8cTKrNny+2sOd8X2NqaDzRh0IqKDPYmAfH/uWMh2pnoQ/qU72iLxvYQr6NCrSA5esgZ06FUkBzt1AeIbCYntH36B/EFG9LDPVxCHRkTiu1t4kN+JSHxvowsa9KoVfdhZkU6bMXiJ7e/wCJeKQJNGQmLbl4tAdiMhsaFFO+gwCYktBC+eQa8b61ic5OZcOABtWg2J7iyPQfq2OwQi8d3EOmjQiWh8O8EO4xsNie6lw0F+r6I52GlxmN9oSHQwzQt6GEqak5vuhV06FcnBT26CFoOM5uEnOWGTQUdysZOJoEEjIbGtpCKI1goi2VqJIexmJXZG4sNJRtDGSjYS3bzEG+zUy0geTsILNGg1NLqX+IINDtDJ6lIPOAEGG5lakhuUCAOtJiHJx02IgR6diMRXC+bULrES8+3e2Svm5qamf5LeBxYdo2P5kxHSC3wYUkUkyyHFLjNW38bRmGvUSYknY7qBVVknyj+yAmwGKX3b/kkzmEi88wHXbNCtOHtpXouc8+lUK848ZC1Sa5sE+ww6utPfLK9nm60VxXqYXcT7uttSvpO7rj09W5Yrgu9TuyamyvMJ3fyatpBjl+4k7v4Ru5jhA3Q4UNjPI/uEQRPA2OlUH9HEA8W9G5PT4DkQhmuT3ti59NokijTlAbh378EH9pIQBEr/A6BJFoAh+XAfZwmD6VrFi4MsodlhiCyaY4CrlV26dqSMCidhO3PB3ZhFRtSkCyXKnav23fBjM8BxJ3xXHsI0ijkUcvFx6jgj0lIGulDg+uMc1a+wRcYu3k7f2Yi1pYFPF75+CxORT8XlOZdwYVYrmukBz6qGO0AbWPT9w3cazSp1LFMXHHqgK1M+ztQtwCH3pnCuVQBoxbv/AaRbqNkIPQAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 048f1e4..70064f9 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"rows\":[{\"kind\":4,\"name\":\"error\",\"url\":\"modules/error.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"customError\",\"url\":\"functions/error.customError-1.html\",\"classes\":\"\",\"parent\":\"error\"},{\"kind\":64,\"name\":\"notImplemented\",\"url\":\"functions/error.notImplemented.html\",\"classes\":\"\",\"parent\":\"error\"},{\"kind\":256,\"name\":\"CustomError\",\"url\":\"interfaces/error.CustomError.html\",\"classes\":\"\",\"parent\":\"error\"},{\"kind\":1024,\"name\":\"msg\",\"url\":\"interfaces/error.CustomError.html#msg\",\"classes\":\"\",\"parent\":\"error.CustomError\"},{\"kind\":1024,\"name\":\"err\",\"url\":\"interfaces/error.CustomError.html#err\",\"classes\":\"\",\"parent\":\"error.CustomError\"},{\"kind\":4,\"name\":\"functional\",\"url\":\"modules/functional.html\",\"classes\":\"\"},{\"kind\":4,\"name\":\"numeric\",\"url\":\"modules/numeric.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"decimal\",\"url\":\"functions/numeric.decimal-2.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":64,\"name\":\"decimalFromNullable\",\"url\":\"functions/numeric.decimalFromNullable.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":64,\"name\":\"unsafeDecimal\",\"url\":\"functions/numeric.unsafeDecimal.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":64,\"name\":\"safeDiv\",\"url\":\"functions/numeric.safeDiv.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":64,\"name\":\"sumDecimals\",\"url\":\"functions/numeric.sumDecimals.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":128,\"name\":\"NumericError\",\"url\":\"classes/numeric.NumericError.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":2048,\"name\":\"throw\",\"url\":\"classes/numeric.NumericError.html#throw\",\"classes\":\"\",\"parent\":\"numeric.NumericError\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/numeric.NumericError.html#constructor\",\"classes\":\"\",\"parent\":\"numeric.NumericError\"},{\"kind\":32,\"name\":\"zero\",\"url\":\"variables/numeric.zero.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":32,\"name\":\"one\",\"url\":\"variables/numeric.one.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":32,\"name\":\"hundred\",\"url\":\"variables/numeric.hundred.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":32,\"name\":\"thousand\",\"url\":\"variables/numeric.thousand.html\",\"classes\":\"\",\"parent\":\"numeric\"},{\"kind\":4,\"name\":\"temporal\",\"url\":\"modules/temporal.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"getPivotDate\",\"url\":\"functions/temporal.getPivotDate.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":64,\"name\":\"getLastWeekday\",\"url\":\"functions/temporal.getLastWeekday.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":64,\"name\":\"getToday\",\"url\":\"functions/temporal.getToday.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":4194304,\"name\":\"SDate\",\"url\":\"types/temporal.SDate.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":4194304,\"name\":\"SDateTime\",\"url\":\"types/temporal.SDateTime.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":256,\"name\":\"SDateRange\",\"url\":\"interfaces/temporal.SDateRange.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":1024,\"name\":\"start\",\"url\":\"interfaces/temporal.SDateRange.html#start\",\"classes\":\"\",\"parent\":\"temporal.SDateRange\"},{\"kind\":1024,\"name\":\"until\",\"url\":\"interfaces/temporal.SDateRange.html#until\",\"classes\":\"\",\"parent\":\"temporal.SDateRange\"},{\"kind\":32,\"name\":\"isoFormatDateTime\",\"url\":\"variables/temporal.isoFormatDateTime.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":32,\"name\":\"isoFormatDate\",\"url\":\"variables/temporal.isoFormatDate.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":8,\"name\":\"PivotDate\",\"url\":\"enums/temporal.PivotDate.html\",\"classes\":\"\",\"parent\":\"temporal\"},{\"kind\":16,\"name\":\"LAST_YEAR_END\",\"url\":\"enums/temporal.PivotDate.html#LAST_YEAR_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_YEAR_START\",\"url\":\"enums/temporal.PivotDate.html#THIS_YEAR_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"LAST_MONTH_END\",\"url\":\"enums/temporal.PivotDate.html#LAST_MONTH_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_MONTH_START\",\"url\":\"enums/temporal.PivotDate.html#THIS_MONTH_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"LAST_WEEK_END\",\"url\":\"enums/temporal.PivotDate.html#LAST_WEEK_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_WEEK_START\",\"url\":\"enums/temporal.PivotDate.html#THIS_WEEK_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"YESTERDAY\",\"url\":\"enums/temporal.PivotDate.html#YESTERDAY\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"TODAY\",\"url\":\"enums/temporal.PivotDate.html#TODAY\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"TOMORROW\",\"url\":\"enums/temporal.PivotDate.html#TOMORROW\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_WEEK_END\",\"url\":\"enums/temporal.PivotDate.html#THIS_WEEK_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_WEEK_START\",\"url\":\"enums/temporal.PivotDate.html#NEXT_WEEK_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_WEEK_END\",\"url\":\"enums/temporal.PivotDate.html#NEXT_WEEK_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_MONTH_END\",\"url\":\"enums/temporal.PivotDate.html#THIS_MONTH_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_MONTH_START\",\"url\":\"enums/temporal.PivotDate.html#NEXT_MONTH_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_MONTH_END\",\"url\":\"enums/temporal.PivotDate.html#NEXT_MONTH_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"THIS_YEAR_END\",\"url\":\"enums/temporal.PivotDate.html#THIS_YEAR_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_YEAR_START\",\"url\":\"enums/temporal.PivotDate.html#NEXT_YEAR_START\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":16,\"name\":\"NEXT_YEAR_END\",\"url\":\"enums/temporal.PivotDate.html#NEXT_YEAR_END\",\"classes\":\"\",\"parent\":\"temporal.PivotDate\"},{\"kind\":4,\"name\":\"textual\",\"url\":\"modules/textual.html\",\"classes\":\"\"},{\"kind\":64,\"name\":\"sanitizeText\",\"url\":\"functions/textual.sanitizeText.html\",\"classes\":\"\",\"parent\":\"textual\"},{\"kind\":64,\"name\":\"nonEmptyText\",\"url\":\"functions/textual.nonEmptyText.html\",\"classes\":\"\",\"parent\":\"textual\"},{\"kind\":64,\"name\":\"sanitizedNonEmptyText\",\"url\":\"functions/textual.sanitizedNonEmptyText.html\",\"classes\":\"\",\"parent\":\"textual\"},{\"kind\":8388608,\"name\":\"customError\",\"url\":\"modules.html#customError-1\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"notImplemented\",\"url\":\"modules.html#notImplemented\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"CustomError\",\"url\":\"modules.html#CustomError\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"decimal\",\"url\":\"modules.html#decimal-1\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"decimalFromNullable\",\"url\":\"modules.html#decimalFromNullable\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"unsafeDecimal\",\"url\":\"modules.html#unsafeDecimal\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"safeDiv\",\"url\":\"modules.html#safeDiv\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"sumDecimals\",\"url\":\"modules.html#sumDecimals\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"NumericError\",\"url\":\"modules.html#NumericError\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"zero\",\"url\":\"modules.html#zero\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"one\",\"url\":\"modules.html#one\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"hundred\",\"url\":\"modules.html#hundred\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"thousand\",\"url\":\"modules.html#thousand\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"getPivotDate\",\"url\":\"modules.html#getPivotDate\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"getLastWeekday\",\"url\":\"modules.html#getLastWeekday\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"getToday\",\"url\":\"modules.html#getToday\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"SDate\",\"url\":\"modules.html#SDate\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"SDateTime\",\"url\":\"modules.html#SDateTime\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"SDateRange\",\"url\":\"modules.html#SDateRange\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"isoFormatDateTime\",\"url\":\"modules.html#isoFormatDateTime\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"isoFormatDate\",\"url\":\"modules.html#isoFormatDate\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"PivotDate\",\"url\":\"modules.html#PivotDate\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"sanitizeText\",\"url\":\"modules.html#sanitizeText\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"nonEmptyText\",\"url\":\"modules.html#nonEmptyText\",\"classes\":\"\"},{\"kind\":8388608,\"name\":\"sanitizedNonEmptyText\",\"url\":\"modules.html#sanitizedNonEmptyText\",\"classes\":\"\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,39.766]],[\"comment/0\",[]],[\"name/1\",[1,28.779]],[\"comment/1\",[]],[\"name/2\",[2,34.657]],[\"comment/2\",[]],[\"name/3\",[1,28.779]],[\"comment/3\",[]],[\"name/4\",[3,39.766]],[\"comment/4\",[]],[\"name/5\",[4,39.766]],[\"comment/5\",[]],[\"name/6\",[5,39.766]],[\"comment/6\",[]],[\"name/7\",[6,39.766]],[\"comment/7\",[]],[\"name/8\",[7,34.657]],[\"comment/8\",[]],[\"name/9\",[8,34.657]],[\"comment/9\",[]],[\"name/10\",[9,34.657]],[\"comment/10\",[]],[\"name/11\",[10,34.657]],[\"comment/11\",[]],[\"name/12\",[11,34.657]],[\"comment/12\",[]],[\"name/13\",[12,34.657]],[\"comment/13\",[]],[\"name/14\",[13,39.766]],[\"comment/14\",[]],[\"name/15\",[14,39.766]],[\"comment/15\",[]],[\"name/16\",[15,34.657]],[\"comment/16\",[]],[\"name/17\",[16,34.657]],[\"comment/17\",[]],[\"name/18\",[17,34.657]],[\"comment/18\",[]],[\"name/19\",[18,34.657]],[\"comment/19\",[]],[\"name/20\",[19,39.766]],[\"comment/20\",[]],[\"name/21\",[20,34.657]],[\"comment/21\",[]],[\"name/22\",[21,34.657]],[\"comment/22\",[]],[\"name/23\",[22,34.657]],[\"comment/23\",[]],[\"name/24\",[23,34.657]],[\"comment/24\",[]],[\"name/25\",[24,34.657]],[\"comment/25\",[]],[\"name/26\",[25,34.657]],[\"comment/26\",[]],[\"name/27\",[26,39.766]],[\"comment/27\",[]],[\"name/28\",[27,39.766]],[\"comment/28\",[]],[\"name/29\",[28,34.657]],[\"comment/29\",[]],[\"name/30\",[29,34.657]],[\"comment/30\",[]],[\"name/31\",[30,34.657]],[\"comment/31\",[]],[\"name/32\",[31,39.766]],[\"comment/32\",[]],[\"name/33\",[32,39.766]],[\"comment/33\",[]],[\"name/34\",[33,39.766]],[\"comment/34\",[]],[\"name/35\",[34,39.766]],[\"comment/35\",[]],[\"name/36\",[35,39.766]],[\"comment/36\",[]],[\"name/37\",[36,39.766]],[\"comment/37\",[]],[\"name/38\",[37,39.766]],[\"comment/38\",[]],[\"name/39\",[38,39.766]],[\"comment/39\",[]],[\"name/40\",[39,39.766]],[\"comment/40\",[]],[\"name/41\",[40,39.766]],[\"comment/41\",[]],[\"name/42\",[41,39.766]],[\"comment/42\",[]],[\"name/43\",[42,39.766]],[\"comment/43\",[]],[\"name/44\",[43,39.766]],[\"comment/44\",[]],[\"name/45\",[44,39.766]],[\"comment/45\",[]],[\"name/46\",[45,39.766]],[\"comment/46\",[]],[\"name/47\",[46,39.766]],[\"comment/47\",[]],[\"name/48\",[47,39.766]],[\"comment/48\",[]],[\"name/49\",[48,39.766]],[\"comment/49\",[]],[\"name/50\",[49,39.766]],[\"comment/50\",[]],[\"name/51\",[50,34.657]],[\"comment/51\",[]],[\"name/52\",[51,34.657]],[\"comment/52\",[]],[\"name/53\",[52,34.657]],[\"comment/53\",[]],[\"name/54\",[1,28.779]],[\"comment/54\",[]],[\"name/55\",[2,34.657]],[\"comment/55\",[]],[\"name/56\",[1,28.779]],[\"comment/56\",[]],[\"name/57\",[7,34.657]],[\"comment/57\",[]],[\"name/58\",[8,34.657]],[\"comment/58\",[]],[\"name/59\",[9,34.657]],[\"comment/59\",[]],[\"name/60\",[10,34.657]],[\"comment/60\",[]],[\"name/61\",[11,34.657]],[\"comment/61\",[]],[\"name/62\",[12,34.657]],[\"comment/62\",[]],[\"name/63\",[15,34.657]],[\"comment/63\",[]],[\"name/64\",[16,34.657]],[\"comment/64\",[]],[\"name/65\",[17,34.657]],[\"comment/65\",[]],[\"name/66\",[18,34.657]],[\"comment/66\",[]],[\"name/67\",[20,34.657]],[\"comment/67\",[]],[\"name/68\",[21,34.657]],[\"comment/68\",[]],[\"name/69\",[22,34.657]],[\"comment/69\",[]],[\"name/70\",[23,34.657]],[\"comment/70\",[]],[\"name/71\",[24,34.657]],[\"comment/71\",[]],[\"name/72\",[25,34.657]],[\"comment/72\",[]],[\"name/73\",[28,34.657]],[\"comment/73\",[]],[\"name/74\",[29,34.657]],[\"comment/74\",[]],[\"name/75\",[30,34.657]],[\"comment/75\",[]],[\"name/76\",[50,34.657]],[\"comment/76\",[]],[\"name/77\",[51,34.657]],[\"comment/77\",[]],[\"name/78\",[52,34.657]],[\"comment/78\",[]]],\"invertedIndex\":[[\"constructor\",{\"_index\":14,\"name\":{\"15\":{}},\"comment\":{}}],[\"customerror\",{\"_index\":1,\"name\":{\"1\":{},\"3\":{},\"54\":{},\"56\":{}},\"comment\":{}}],[\"decimal\",{\"_index\":7,\"name\":{\"8\":{},\"57\":{}},\"comment\":{}}],[\"decimalfromnullable\",{\"_index\":8,\"name\":{\"9\":{},\"58\":{}},\"comment\":{}}],[\"err\",{\"_index\":4,\"name\":{\"5\":{}},\"comment\":{}}],[\"error\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"functional\",{\"_index\":5,\"name\":{\"6\":{}},\"comment\":{}}],[\"getlastweekday\",{\"_index\":21,\"name\":{\"22\":{},\"68\":{}},\"comment\":{}}],[\"getpivotdate\",{\"_index\":20,\"name\":{\"21\":{},\"67\":{}},\"comment\":{}}],[\"gettoday\",{\"_index\":22,\"name\":{\"23\":{},\"69\":{}},\"comment\":{}}],[\"hundred\",{\"_index\":17,\"name\":{\"18\":{},\"65\":{}},\"comment\":{}}],[\"isoformatdate\",{\"_index\":29,\"name\":{\"30\":{},\"74\":{}},\"comment\":{}}],[\"isoformatdatetime\",{\"_index\":28,\"name\":{\"29\":{},\"73\":{}},\"comment\":{}}],[\"last_month_end\",{\"_index\":33,\"name\":{\"34\":{}},\"comment\":{}}],[\"last_week_end\",{\"_index\":35,\"name\":{\"36\":{}},\"comment\":{}}],[\"last_year_end\",{\"_index\":31,\"name\":{\"32\":{}},\"comment\":{}}],[\"msg\",{\"_index\":3,\"name\":{\"4\":{}},\"comment\":{}}],[\"next_month_end\",{\"_index\":45,\"name\":{\"46\":{}},\"comment\":{}}],[\"next_month_start\",{\"_index\":44,\"name\":{\"45\":{}},\"comment\":{}}],[\"next_week_end\",{\"_index\":42,\"name\":{\"43\":{}},\"comment\":{}}],[\"next_week_start\",{\"_index\":41,\"name\":{\"42\":{}},\"comment\":{}}],[\"next_year_end\",{\"_index\":48,\"name\":{\"49\":{}},\"comment\":{}}],[\"next_year_start\",{\"_index\":47,\"name\":{\"48\":{}},\"comment\":{}}],[\"nonemptytext\",{\"_index\":51,\"name\":{\"52\":{},\"77\":{}},\"comment\":{}}],[\"notimplemented\",{\"_index\":2,\"name\":{\"2\":{},\"55\":{}},\"comment\":{}}],[\"numeric\",{\"_index\":6,\"name\":{\"7\":{}},\"comment\":{}}],[\"numericerror\",{\"_index\":12,\"name\":{\"13\":{},\"62\":{}},\"comment\":{}}],[\"one\",{\"_index\":16,\"name\":{\"17\":{},\"64\":{}},\"comment\":{}}],[\"pivotdate\",{\"_index\":30,\"name\":{\"31\":{},\"75\":{}},\"comment\":{}}],[\"safediv\",{\"_index\":10,\"name\":{\"11\":{},\"60\":{}},\"comment\":{}}],[\"sanitizednonemptytext\",{\"_index\":52,\"name\":{\"53\":{},\"78\":{}},\"comment\":{}}],[\"sanitizetext\",{\"_index\":50,\"name\":{\"51\":{},\"76\":{}},\"comment\":{}}],[\"sdate\",{\"_index\":23,\"name\":{\"24\":{},\"70\":{}},\"comment\":{}}],[\"sdaterange\",{\"_index\":25,\"name\":{\"26\":{},\"72\":{}},\"comment\":{}}],[\"sdatetime\",{\"_index\":24,\"name\":{\"25\":{},\"71\":{}},\"comment\":{}}],[\"start\",{\"_index\":26,\"name\":{\"27\":{}},\"comment\":{}}],[\"sumdecimals\",{\"_index\":11,\"name\":{\"12\":{},\"61\":{}},\"comment\":{}}],[\"temporal\",{\"_index\":19,\"name\":{\"20\":{}},\"comment\":{}}],[\"textual\",{\"_index\":49,\"name\":{\"50\":{}},\"comment\":{}}],[\"this_month_end\",{\"_index\":43,\"name\":{\"44\":{}},\"comment\":{}}],[\"this_month_start\",{\"_index\":34,\"name\":{\"35\":{}},\"comment\":{}}],[\"this_week_end\",{\"_index\":40,\"name\":{\"41\":{}},\"comment\":{}}],[\"this_week_start\",{\"_index\":36,\"name\":{\"37\":{}},\"comment\":{}}],[\"this_year_end\",{\"_index\":46,\"name\":{\"47\":{}},\"comment\":{}}],[\"this_year_start\",{\"_index\":32,\"name\":{\"33\":{}},\"comment\":{}}],[\"thousand\",{\"_index\":18,\"name\":{\"19\":{},\"66\":{}},\"comment\":{}}],[\"throw\",{\"_index\":13,\"name\":{\"14\":{}},\"comment\":{}}],[\"today\",{\"_index\":38,\"name\":{\"39\":{}},\"comment\":{}}],[\"tomorrow\",{\"_index\":39,\"name\":{\"40\":{}},\"comment\":{}}],[\"unsafedecimal\",{\"_index\":9,\"name\":{\"10\":{},\"59\":{}},\"comment\":{}}],[\"until\",{\"_index\":27,\"name\":{\"28\":{}},\"comment\":{}}],[\"yesterday\",{\"_index\":37,\"name\":{\"38\":{}},\"comment\":{}}],[\"zero\",{\"_index\":15,\"name\":{\"16\":{},\"63\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62bb3OjOBKHvwt5681a/wDn3dSNt3bqdjN3ie/mplKplC8mE9cayAGenWwq3/0kDFY3dDsQ+1WK0P1rqR+pJQR+CYr8zzK4uHkJ/lhnq+BCT4JsmSbBRZAURV4Ek2BbbOxVmq+2m6T8uf7v+WOVbuyt+82yLBPrHgSvk1Yh9BL327LK0zkSethm99U6z1opYPOTIIQnwdOySLJq3yIyUpZXn9KnTZJay2TFBsNm46JJE+7D/Y3o2NpKFg/L+32SgNG4SGIqfc/S8tvwEGc76wNhoAsX0hqOCLmzHh/Sx2spLTe94eZvHRxzYCBs06RY3/eEmv8PHbmr5H6dgvb4gdQKNRY/ycNs2/YcivJLkaeX281m+d9N8nZEaH1E7G1WLh+Sj2/2E9kdEa9WWX8/EKmxOCbGNm0aWh6K463GxhIy3ge73N3FRaAR2seCRmODyan20apHW6iHhzlr7Q8GQ34gshHS13CbuqrY3ldjenmGvd7VCOXb8FdS5Pvg35fF2o19H97dHptcoJ5nyQFxe/cI7cdttirAgtTXbyyOiFE95ttymR0K0pqMjeKnVpWkT3lBVOj2xtDK+i2p/rH+nlcflxVV7PZy0O5ws/dN4+L9tiyrL0nyx2r5/EZEYHlkzEX+drTaZnQcOZ1Fwnj81yiT1fMThHL9rvSRIRbr9HAYZzA+FNhV1SpXy+ybjwO2HzhYbTY6GtrmlNWyqMZEOms9DscDblzobVatN6NCtx7vCQ1qxbrMf8mLdFn1iPqisRfrGY/ONxd5cNTREf2K2a8yiS1wIND7y4vwY/a3D9eLu6/zD1d388uPwyKddX3eYOo7QrZg8eun653a9eLD1WJgG/pex7Wi7tPvny8Xv45NBHQ6QSZ2cqNTgd1OkIsv8/nfx6YC+JwgE7Xa6EQgr+Na8XV+vZhfffzwdWB8aH9k/z8Pj9raHhvx989XV5+/DA66Nz8V6eFjretzXAsu5/9ZjB9rfa9TtWJ4Hro+J6s+I1GcrgLWPRpfAQm3k7VjJI4TrwYjV+auzwmyMHpl7nudqhUjUZx2h/LPf9nOzN+xSek6nrAtIwcGdjvBHuE9OSEdT9iWkVuWo3MCjxh+VFvyhKH+/9ADhnKZrav1X8nCupEP4Ds1aPbWA8CuXcyLh2yePlXPb0SDZkdEaxu9uhwWlrQfG1+LmVbTw291GlbN4R98pcMR66oyb3CQcM9mkDL1sgbJYoNBmt33A0ivfTUwuO+H3gNQyh3DQTHo836k3jUZpNs910eK/uYwLeL8Hushg0Ga5DE9Eu1YDFJFJ9JIrbkzSAWePCOR3Y1BGt0TZqTjbw7S6p0kIzFwd5AaedKLFDsWQ1Wp89yuLrYZqoxPbbua7d1Batd8t6/H9Ld/9trXam4P18OHrH3B9v4gRf5MEQlTZuP1B2gP1X1jcI4emeTGo1MOkcXAdZFY6TurIrIY1VZ6I0E2umsK49xOAhsm+RFcvATfk6K0mxD7f3muzmfW8mGdbFbuI5NddOuap24JD26be/9O3ItCZ7Ez+XkaTG6mEz09l0bf3k5uWo/6Rv2P2swusDdiImfnMoyQmUBm0l7JiTLnQhtkJpGZ4tQUMtP2SlFt08jM2CtNmRlkFtorQ5mFyCyyVyFlFiGz2F5FVE9jZGah3MSU2Qyn12V7RtmJDocaxJS0xCiES7kQpCWmIWocJDaBgQiXeEEiEZiJcLkXJBWBsQiXfmHI6JiMcATswxRlieEIB0GQeATmIxwHQRISGJF0IMSM6pHEjKQDIUlGsjNd6vlCMpKYkXQgJD21MCPpQEhFWmJG0oGQmrTEjKQDIUlGEjOSDoQk54/EjKQDISPSEjOSDoQkGUnMSDkQkpxHCjNSDoQiGSnMSDkQSlDtVJ2q5kAoSVpiRqqubOQ8UpiRciAUOY8UZqQcCEUWOIUZKQdCkYwUZqQcCEUyUpiRciBUTFpiRtqBUOQ80piRdiA0uThpzEg7EJpkpDEj7UBokpHuLD4OhKaXH8xI1wsQyUhjRtqB0CQjjRlpB0KTjDRmpB0ITTLSmJF2IDTJSGNGxoHQJCODGRkHwpCMDGZkHAhDMjKYkXEgDMnIYEbGgTAkI9PZIzgQhqx1BjMy9T6BrHUGMzIOhCHXI4MZmZjb8BiMyMy4DZTBhMIppxhiQKHgNioh5hNKbqsSYjyh4vYqIaYTanavEmI6oWH3KmFnExeye5UQ0wkjdl8RYjphzO4rQownnLH7ihDziabsviLCgCJ+txBhQhG/W4gwoojfLUSYUcTvFiLMKOJ3CxFmFPG7haiz147YlT3CjKKYXdkjzCiasSt7hBnFU7YmxJhRLNiaEGNGsWRrQrxjVD/A2Se3Kll92j3I3dzgTz9fgrvmEU/sHyNfArttvnh5ffWPdO6q1q/PVJvfEABf4OpsJ4Ha/bElp/5rCwUtuD9x9WKRF2u9xWHvhyJPs/3BqVeKvdKsUZKMUv25u/cEueBS0UvC1PtwvYWfxHtH4x1DxvFbUtnn8urP9ujLO0uQeyl3vYy4XlqZJ3f+sarPP4AIaLtsCEZc0q1IlXdbIYFAwz5SjMD++BIMIABdtNRnjP+6zB/qY6FeN2ZeRU2bVsRDVKr64AoogaEjm7FjqwSt5MjcpXlWPd4lGeqW3Xb7BulD7v/bLu0sLboCBuTVcPlEAs3HjEACDBDDDYxawo2uXg/A4FTc6Ky9n5Nlr/kKxFZc7PrHLcDHu3AZy5IfTMI1aK7mmgvce9nSYOZrburXAlS2NMClOVzeux8d5Etz+ar9qWxrMGg1N3m8dz86mISamzZZniXuuLCqjwvBMAOZN+FuxsRcCclyO+HAGz8w8cC8a5YQtiftb4K8d+i9ucnaePWXMBBZNBUs5EZQ/SIH+IK4Imp8uQSSBViBAqzaAsx13L1+W7nXb6AFwF80/iE3ffZHvyxL0B/T9CfmhmOr1hOBa6hpRLiFseyVclAGpG4SwnbIeRe7lxtAAoxI2YzIiCNakqsA6IJsuhBxRaE3nSTIouSGY7lNV/tXn4An3FE1EyHkIvsfcQABsBRKLuv7TzMANZB3w+W7elyXTP2F1XuAey9pCqRcsR12AtyKCWaC4eoPEujXQZA7w+bOSZBrAGiAPtgAeg1QYNgobtjU/uQaALz129796KAMKm4F86+MwYADi49od0x88uqfsQFvMG4EO266u04FYiquWtrnlbzohFOAsOYauftugnhAAc6i2WWGXKqaH3iAqgAWWcmtEc9JaUdmt7fAU3Geu+8UQGJBERRNEQzJcWGfFZ/WT8lmbde2i5vb19f/A9qfRJ1FPgAA"; \ No newline at end of file diff --git a/assets/style.css b/assets/style.css index 18b4f8f..108428c 100644 --- a/assets/style.css +++ b/assets/style.css @@ -32,7 +32,6 @@ --light-color-ts-accessor: var(--light-color-ts-property); --light-color-ts-get-signature: var(--light-color-ts-accessor); --light-color-ts-set-signature: var(--light-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --light-color-ts-type-alias: #d51270; /* reference not included as links will be colored with the kind that it points to */ @@ -72,7 +71,6 @@ --dark-color-ts-accessor: var(--dark-color-ts-property); --dark-color-ts-get-signature: var(--dark-color-ts-accessor); --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - /* object literal not included as it is not used and will be removed in 0.25 */ --dark-color-ts-type-alias: #ff6492; /* reference not included as links will be colored with the kind that it points to */ @@ -468,13 +466,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -485,6 +482,19 @@ blockquote { .tsd-typography ol { margin: 1em 0; } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); +} .tsd-breadcrumb { margin: 0; @@ -900,8 +910,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -909,12 +920,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -1070,7 +1084,9 @@ ul.tsd-type-parameter-list h5 { overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1122,7 +1138,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { diff --git a/classes/numeric.Decimal-1.html b/classes/numeric.Decimal-1.html index 82cfd58..877063a 100644 --- a/classes/numeric.Decimal-1.html +++ b/classes/numeric.Decimal-1.html @@ -1,40 +1,5 @@ -Decimal | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Class Decimal

-
-

Hierarchy

-
    -
  • Decimal
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
d +Decimal | @telostat/prelude - v0.5.0

Hierarchy

  • Decimal

Constructors

Properties

d e s Decimal? @@ -57,10 +22,7 @@

Properties

rounding toExpNeg toExpPos -
-
-

Methods

-
abs +

Methods

abs absoluteValue acos acosh @@ -204,2173 +166,4 @@

Methods

tan tanh trunc -
-
-

Constructors

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
-

Properties

-
- -
d: number[]
-
- -
e: number
-
- -
s: number
-
- -
Decimal?: typeof Decimal
-
- -
EUCLID: 9
-
- -
ROUND_CEIL: 2
-
- -
ROUND_DOWN: 1
-
- -
ROUND_FLOOR: 3
-
- -
ROUND_HALF_CEIL: 7
-
- -
ROUND_HALF_DOWN: 5
-
- -
ROUND_HALF_EVEN: 6
-
- -
ROUND_HALF_FLOOR: 8
-
- -
ROUND_HALF_UP: 4
-
- -
ROUND_UP: 0
-
- -
crypto: boolean
-
- -
default?: typeof Decimal
-
- -
maxE: number
-
- -
minE: number
-
- -
modulo: Modulo
-
- -
precision: number
-
- -
rounding: Rounding
-
- -
toExpNeg: number
-
- -
toExpPos: number
-
-

Methods

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns number

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns number

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns number

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns number

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional includeZeros: boolean
    -

    Returns number

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional includeZeros: boolean
    -

    Returns number

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional decimalPlaces: number
    -

    Returns Decimal

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      decimalPlaces: number
    • -
    • -
      rounding: Rounding
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional decimalPlaces: number
    -

    Returns Decimal

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      decimalPlaces: number
    • -
    • -
      rounding: Rounding
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional decimalPlaces: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      decimalPlaces: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional decimalPlaces: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      decimalPlaces: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional max_denominator: Value
    -

    Returns Decimal[]

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      Optional rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns number

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns string

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns Decimal

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns Decimal

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      significantDigits: number
    • -
    • -
      rounding: Rounding
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns Decimal

-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns typeof Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns typeof Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      object: any
    -

    Returns object is Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -

    Returns typeof Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Optional significantDigits: number
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns typeof Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns number

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns Decimal

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

  • Parameters

    Returns Decimal

Properties

d: number[]
e: number
s: number
Decimal?: typeof Decimal
EUCLID: 9
ROUND_CEIL: 2
ROUND_DOWN: 1
ROUND_FLOOR: 3
ROUND_HALF_CEIL: 7
ROUND_HALF_DOWN: 5
ROUND_HALF_EVEN: 6
ROUND_HALF_FLOOR: 8
ROUND_HALF_UP: 4
ROUND_UP: 0
crypto: boolean
default?: typeof Decimal
maxE: number
minE: number
modulo: Modulo
precision: number
rounding: Rounding
toExpNeg: number
toExpPos: number

Methods

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns number

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Returns number

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • Optional includeZeros: boolean

    Returns number

  • Returns Decimal

  • Parameters

    • Optional includeZeros: boolean

    Returns number

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • Optional significantDigits: number

    Returns string

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns string

  • Parameters

    • Optional decimalPlaces: number

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • Optional decimalPlaces: number

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • Optional decimalPlaces: number

    Returns string

  • Parameters

    Returns string

  • Parameters

    • Optional decimalPlaces: number

    Returns string

  • Parameters

    Returns string

  • Parameters

    • Optional max_denominator: Value

    Returns Decimal[]

  • Parameters

    • Optional significantDigits: number

    Returns string

  • Parameters

    • significantDigits: number
    • Optional rounding: Rounding

    Returns string

  • Parameters

    • Optional significantDigits: number

    Returns string

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns string

  • Returns string

  • Parameters

    Returns Decimal

  • Returns number

  • Parameters

    • Optional significantDigits: number

    Returns string

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns string

  • Parameters

    Returns Decimal

  • Parameters

    • Optional significantDigits: number

    Returns string

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns string

  • Parameters

    • Optional significantDigits: number

    Returns Decimal

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns Decimal

  • Parameters

    • Optional significantDigits: number

    Returns Decimal

  • Parameters

    • significantDigits: number
    • rounding: Rounding

    Returns Decimal

  • Returns string

  • Returns Decimal

  • Returns Decimal

  • Returns string

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns typeof Decimal

  • Parameters

    Returns typeof Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • object: any

    Returns object is Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Returns typeof Decimal

  • Parameters

    Returns Decimal

  • Parameters

    • Optional significantDigits: number

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns typeof Decimal

  • Parameters

    Returns number

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

  • Parameters

    Returns Decimal

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/numeric.NumericError.html b/classes/numeric.NumericError.html index d119d56..2bb219a 100644 --- a/classes/numeric.NumericError.html +++ b/classes/numeric.NumericError.html @@ -1,292 +1,14 @@ -NumericError | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Class NumericError

-
-

Errors this module can throw.

-
-
-
-

Hierarchy

-
    -
  • Error -
      -
    • NumericError
-
-
-
- -
-
-

Constructors

-
-
-

Properties

-
cause? +NumericError | @telostat/prelude - v0.5.0

Errors this module can throw.

+

Hierarchy

  • Error
    • NumericError
-
-

Constructors

-
- -
-
-

Properties

-
- -
cause?: unknown
-
- -
message: string
-
- -
name: string
-
- -
stack?: string
-
- -
prepareStackTrace?: ((err, stackTraces) => any)
-
-

Type declaration

-
-
- -
stackTraceLimit: number
-
-

Methods

-
- -
    - -
  • -

    Create .stack property on a target object

    -
    -
    -

    Parameters

    -
      -
    • -
      targetObject: object
    • -
    • -
      Optional constructorOpt: Function
    -

    Returns void

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      msg: string
    -

    Returns never

-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Constructors

Properties

cause?: unknown
message: string
name: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/functional.Order.html b/enums/functional.Order.html index d238da5..c610a62 100644 --- a/enums/functional.Order.html +++ b/enums/functional.Order.html @@ -1,219 +1,4 @@ -Order | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Enumeration OrderConst

-
-
-
- -
-
-

Enumeration Members

-
EQ -GT -LT -
-
-

Enumeration Members

-
- -
EQ: "EQ"
-
- -
GT: "GT"
-
- -
LT: "LT"
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +Order | @telostat/prelude - v0.5.0

Enumeration OrderConst

Enumeration Members

EQ +GT +LT +

Enumeration Members

EQ: "EQ"
GT: "GT"
LT: "LT"

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/temporal.PivotDate.html b/enums/temporal.PivotDate.html index 71f02e1..74dfd15 100644 --- a/enums/temporal.PivotDate.html +++ b/enums/temporal.PivotDate.html @@ -1,279 +1,24 @@ -PivotDate | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Enumeration PivotDate

-
-

Enum that encodes some known pivotal dates.

-
-
-
-
-
- -
-
-

Enumeration Members

-
- -
LAST_MONTH_END: "last month end"
-
- -
LAST_WEEK_END: "last week end"
-
- -
LAST_YEAR_END: "last year end"
-
- -
NEXT_MONTH_END: "next month end"
-
- -
NEXT_MONTH_START: "next month start"
-
- -
NEXT_WEEK_END: "next week end"
-
- -
NEXT_WEEK_START: "next week start"
-
- -
NEXT_YEAR_END: "next year end"
-
- -
NEXT_YEAR_START: "next year start"
-
- -
THIS_MONTH_END: "this month end"
-
- -
THIS_MONTH_START: "this month start"
-
- -
THIS_WEEK_END: "this week end"
-
- -
THIS_WEEK_START: "this week start"
-
- -
THIS_YEAR_END: "this year end"
-
- -
THIS_YEAR_START: "this year start"
-
- -
TODAY: "today"
-
- -
TOMORROW: "tomorrow"
-
- -
YESTERDAY: "yesterday"
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +PivotDate | @telostat/prelude - v0.5.0

Enum that encodes some known pivotal dates.

+

Enumeration Members

LAST_MONTH_END: "last month end"
LAST_QUARTER_END: "last quarter end"
LAST_QUARTER_START: "last quarter start"
LAST_WEEK_END: "last week end"
LAST_YEAR_END: "last year end"
NEXT_MONTH_END: "next month end"
NEXT_MONTH_START: "next month start"
NEXT_WEEK_END: "next week end"
NEXT_WEEK_START: "next week start"
NEXT_YEAR_END: "next year end"
NEXT_YEAR_START: "next year start"
THIS_MONTH_END: "this month end"
THIS_MONTH_START: "this month start"
THIS_QUARTER_END: "this quarter end"
THIS_QUARTER_START: "this quarter start"
THIS_WEEK_END: "this week end"
THIS_WEEK_START: "this week start"
THIS_YEAR_END: "this year end"
THIS_YEAR_START: "this year start"
TODAY: "today"
TOMORROW: "tomorrow"
YESTERDAY: "yesterday"

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/error.customError-1.html b/functions/error.customError-1.html index b1fd5f3..98fec7e 100644 --- a/functions/error.customError-1.html +++ b/functions/error.customError-1.html @@ -1,151 +1,5 @@ -customError | @telostat/prelude - v0.4.1
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file +customError | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/error.notImplemented.html b/functions/error.notImplemented.html index 31ee324..0159459 100644 --- a/functions/error.notImplemented.html +++ b/functions/error.notImplemented.html @@ -1,140 +1,5 @@ -notImplemented | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function notImplemented

-
-

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.EitherAsync-1.html b/functions/functional.EitherAsync-1.html index 591ffb0..052c79c 100644 --- a/functions/functional.EitherAsync-1.html +++ b/functions/functional.EitherAsync-1.html @@ -1,215 +1,2 @@ -EitherAsync | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function EitherAsync

-
-
    - -
  • -

    Constructs an EitherAsync object from a function that takes an object full of helpers that let you lift things into the EitherAsync context and returns a Promise

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
      -
    • -
      runPromise: ((helpers) => PromiseLike<R>)
      -
        -
      • -
          -
        • (helpers): PromiseLike<R>
        • -
        • -
          -

          Parameters

          -
            -
          • -
            helpers: EitherAsyncHelpers<L>
          -

          Returns PromiseLike<R>

    -

    Returns functional.EitherAsync<L, R>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +EitherAsync | @telostat/prelude - v0.5.0
  • Constructs an EitherAsync object from a function that takes an object full of helpers that let you lift things into the EitherAsync context and returns a Promise

    +

    Type Parameters

    • L

    • R

    Parameters

    • runPromise: ((helpers) => PromiseLike<R>)
        • (helpers): PromiseLike<R>
        • Parameters

          • helpers: EitherAsyncHelpers<L>

          Returns PromiseLike<R>

    Returns functional.EitherAsync<L, R>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.Just.html b/functions/functional.Just.html index 7eac90b..68874c3 100644 --- a/functions/functional.Just.html +++ b/functions/functional.Just.html @@ -1,202 +1,2 @@ -Just | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function Just

-
-
    - -
  • -

    Constructs a Just. Represents an optional value that exists

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      value: T
    -

    Returns functional.Maybe<T>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +Just | @telostat/prelude - v0.5.0
  • Constructs a Just. Represents an optional value that exists

    +

    Type Parameters

    • T

    Parameters

    • value: T

    Returns functional.Maybe<T>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.Left.html b/functions/functional.Left.html index 32bf9e9..e6a8382 100644 --- a/functions/functional.Left.html +++ b/functions/functional.Left.html @@ -1,201 +1 @@ -Left | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function Left

-
-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R = never

    -
    -

    Parameters

    -
      -
    • -
      value: L
    -

    Returns functional.Either<L, R>

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +Left | @telostat/prelude - v0.5.0
  • Type Parameters

    • L

    • R = never

    Parameters

    • value: L

    Returns functional.Either<L, R>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.MaybeAsync-1.html b/functions/functional.MaybeAsync-1.html index 9b004f9..527557b 100644 --- a/functions/functional.MaybeAsync-1.html +++ b/functions/functional.MaybeAsync-1.html @@ -1,213 +1,2 @@ -MaybeAsync | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function MaybeAsync

-
-
    - -
  • -

    Constructs a MaybeAsync object from a function that takes an object full of helpers that let you lift things into the MaybeAsync context and returns a Promise

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      runPromise: ((helpers) => PromiseLike<T>)
      -
        -
      • -
          -
        • (helpers): PromiseLike<T>
        • -
        • -
          -

          Parameters

          -
            -
          • -
            helpers: MaybeAsyncHelpers
          -

          Returns PromiseLike<T>

    -

    Returns functional.MaybeAsync<T>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +MaybeAsync | @telostat/prelude - v0.5.0
  • Constructs a MaybeAsync object from a function that takes an object full of helpers that let you lift things into the MaybeAsync context and returns a Promise

    +

    Type Parameters

    • T

    Parameters

    • runPromise: ((helpers) => PromiseLike<T>)
        • (helpers): PromiseLike<T>
        • Parameters

          • helpers: MaybeAsyncHelpers

          Returns PromiseLike<T>

    Returns functional.MaybeAsync<T>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.NonEmptyList-1.html b/functions/functional.NonEmptyList-1.html index b71aac7..ff7e9b3 100644 --- a/functions/functional.NonEmptyList-1.html +++ b/functions/functional.NonEmptyList-1.html @@ -1,202 +1,2 @@ -NonEmptyList | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function NonEmptyList

-
-
    - -
  • -

    Typecasts an array with at least one element into a NonEmptyList. Works only if the compiler can confirm that the array has one or more elements

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends T[number][] & {
          0: T[number];
      }

    -
    -

    Parameters

    -
      -
    • -
      list: T
    -

    Returns functional.NonEmptyList<T[number]>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +NonEmptyList | @telostat/prelude - v0.5.0
  • Typecasts an array with at least one element into a NonEmptyList. Works only if the compiler can confirm that the array has one or more elements

    +

    Type Parameters

    Parameters

    • list: T

    Returns functional.NonEmptyList<T[number]>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.Right.html b/functions/functional.Right.html index 80fdf67..7734172 100644 --- a/functions/functional.Right.html +++ b/functions/functional.Right.html @@ -1,201 +1 @@ -Right | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function Right

-
-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      R

    • -
    • -

      L = never

    -
    -

    Parameters

    -
      -
    • -
      value: R
    -

    Returns functional.Either<L, R>

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +Right | @telostat/prelude - v0.5.0
  • Type Parameters

    • R

    • L = never

    Parameters

    • value: R

    Returns functional.Either<L, R>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.Tuple-1.html b/functions/functional.Tuple-1.html index 36ab1e1..8d43250 100644 --- a/functions/functional.Tuple-1.html +++ b/functions/functional.Tuple-1.html @@ -1,203 +1 @@ -Tuple | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function Tuple

-
-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      F

    • -
    • -

      S

    -
    -

    Parameters

    -
      -
    • -
      fst: F
    • -
    • -
      snd: S
    -

    Returns functional.Tuple<F, S>

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +Tuple | @telostat/prelude - v0.5.0
  • Type Parameters

    • F

    • S

    Parameters

    • fst: F
    • snd: S

    Returns functional.Tuple<F, S>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.always.html b/functions/functional.always.html index dcc4664..c9f1cb1 100644 --- a/functions/functional.always.html +++ b/functions/functional.always.html @@ -1,218 +1,2 @@ -always | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function always

-
-
    - -
  • -

    Returns a function that always returns the same value. Also known as const in other languages

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      x: T
    -

    Returns (<U>(y) => T)

    -
      -
    • -
        -
      • <U>(y): T
      • -
      • -
        -

        Type Parameters

        -
          -
        • -

          U

        -
        -

        Parameters

        -
          -
        • -
          y: U
        -

        Returns T

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +always | @telostat/prelude - v0.5.0
  • Returns a function that always returns the same value. Also known as const in other languages

    +

    Type Parameters

    • T

    Parameters

    • x: T

    Returns (<U>(y) => T)

      • <U>(y): T
      • Type Parameters

        • U

        Parameters

        • y: U

        Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.array.html b/functions/functional.array.html index 13c0b1a..066cc8b 100644 --- a/functions/functional.array.html +++ b/functions/functional.array.html @@ -1,202 +1,2 @@ -array | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function array

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +array | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.compare.html b/functions/functional.compare.html index 7dd1dec..9c7d8ff 100644 --- a/functions/functional.compare.html +++ b/functions/functional.compare.html @@ -1,204 +1,2 @@ -compare | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function compare

-
-
    - -
  • -

    Compares two values using the default "<" and ">" operators

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      x: T
    • -
    • -
      y: T
    -

    Returns Order

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +compare | @telostat/prelude - v0.5.0
  • Compares two values using the default "<" and ">" operators

    +

    Type Parameters

    • T

    Parameters

    • x: T
    • y: T

    Returns Order

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.curry.html b/functions/functional.curry.html index e131932..8c81351 100644 --- a/functions/functional.curry.html +++ b/functions/functional.curry.html @@ -1,215 +1,2 @@ -curry | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function curry

-
-
    - -
  • -

    Takes a function that receives multiple arguments and returns a "curried" version of that function that can take any number of those arguments and if they are less than needed a new function that takes the rest of them will be returned

    -
    -
    -

    Type Parameters

    -
      -
    • -

      TArgs extends any[]

    • -
    • -

      TReturn

    -
    -

    Parameters

    -
      -
    • -
      fn: ((...args) => TReturn)
      -
        -
      • -
          -
        • (...args): TReturn
        • -
        • -
          -

          Parameters

          -
            -
          • -
            Rest ...args: TArgs
          -

          Returns TReturn

    -

    Returns CurriedFn<TArgs, TReturn>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +curry | @telostat/prelude - v0.5.0
  • Takes a function that receives multiple arguments and returns a "curried" version of that function that can take any number of those arguments and if they are less than needed a new function that takes the rest of them will be returned

    +

    Type Parameters

    • TArgs extends any[]

    • TReturn

    Parameters

    • fn: ((...args) => TReturn)
        • (...args): TReturn
        • Parameters

          • Rest ...args: TArgs

          Returns TReturn

    Returns CurriedFn<TArgs, TReturn>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.enumeration.html b/functions/functional.enumeration.html index 339d9c9..ce2f1eb 100644 --- a/functions/functional.enumeration.html +++ b/functions/functional.enumeration.html @@ -1,202 +1,2 @@ -enumeration | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function enumeration

-
-
    - -
  • -

    A codec for a TypeScript enum

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends Record<string, string | number>

    -
    -

    Parameters

    -
      -
    • -
      e: T
    -

    Returns functional.Codec<T[keyof T]>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +enumeration | @telostat/prelude - v0.5.0
  • A codec for a TypeScript enum

    +

    Type Parameters

    • T extends Record<string, string | number>

    Parameters

    • e: T

    Returns functional.Codec<T[keyof T]>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.exactly.html b/functions/functional.exactly.html index 6fdce0c..09e018e 100644 --- a/functions/functional.exactly.html +++ b/functions/functional.exactly.html @@ -1,202 +1,2 @@ -exactly | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function exactly

-
-
    - -
  • -

    A codec that only succeeds decoding when the value is exactly what you've constructed the codec with

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T extends (string | number | boolean)[]

    -
    -

    Parameters

    -
      -
    • -
      Rest ...expectedValues: T
    -

    Returns functional.Codec<T[number]>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +exactly | @telostat/prelude - v0.5.0
  • A codec that only succeeds decoding when the value is exactly what you've constructed the codec with

    +

    Type Parameters

    • T extends (string | number | boolean)[]

    Parameters

    • Rest ...expectedValues: T

    Returns functional.Codec<T[number]>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.identity.html b/functions/functional.identity.html index c53c453..95e07bf 100644 --- a/functions/functional.identity.html +++ b/functions/functional.identity.html @@ -1,202 +1,2 @@ -identity | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function identity

-
-
    - -
  • -

    The identity function, returns the value it was given

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      x: T
    -

    Returns T

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +identity | @telostat/prelude - v0.5.0
  • The identity function, returns the value it was given

    +

    Type Parameters

    • T

    Parameters

    • x: T

    Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.intersect.html b/functions/functional.intersect.html index bb3b52e..b48ef11 100644 --- a/functions/functional.intersect.html +++ b/functions/functional.intersect.html @@ -1,206 +1,2 @@ -intersect | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function intersect

-
-
    - -
  • -

    Creates an intersection between two codecs. If the provided codecs are not for an object, the second decode result will be returned

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<T & U>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +intersect | @telostat/prelude - v0.5.0
  • Creates an intersection between two codecs. If the provided codecs are not for an object, the second decode result will be returned

    +

    Type Parameters

    • T

    • U

    Parameters

    Returns functional.Codec<T & U>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.lazy.html b/functions/functional.lazy.html index 10fff55..abb4886 100644 --- a/functions/functional.lazy.html +++ b/functions/functional.lazy.html @@ -1,208 +1,2 @@ -lazy | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function lazy

-
-
    - -
  • -

    A special codec used when dealing with recursive data structures, it allows a codec to be recursively defined by itself

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<T>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +lazy | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.map.html b/functions/functional.map.html index 401dd17..15b9c6f 100644 --- a/functions/functional.map.html +++ b/functions/functional.map.html @@ -1,206 +1,2 @@ -map | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function map

-
-
    - -
  • -

    A codec for the built-in Map type

    -
    -
    -

    Type Parameters

    -
      -
    • -

      K

    • -
    • -

      V

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<Map<K, V>>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +map | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.maybe-2.html b/functions/functional.maybe-2.html index f204a6f..6c98c66 100644 --- a/functions/functional.maybe-2.html +++ b/functions/functional.maybe-2.html @@ -1,202 +1,2 @@ -maybe | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function maybe

-
-
    - -
  • -

    A codec for purify's Maybe type. Encode runs Maybe#toJSON, which effectively returns the value inside if it's a Just or undefined if it's Nothing

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<functional.Maybe<T>>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +maybe | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.nonEmptyList-2.html b/functions/functional.nonEmptyList-2.html index b82378f..89f42c6 100644 --- a/functions/functional.nonEmptyList-2.html +++ b/functions/functional.nonEmptyList-2.html @@ -1,202 +1,2 @@ -nonEmptyList | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function nonEmptyList

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +nonEmptyList | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.nullable.html b/functions/functional.nullable.html index dd84724..9a20cdc 100644 --- a/functions/functional.nullable.html +++ b/functions/functional.nullable.html @@ -1,202 +1,2 @@ -nullable | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function nullable

-
-
    - -
  • -

    A codec for a value T or null. Keep in mind if you use nullable inside Codec.interface the property will still be required

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<null | T>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +nullable | @telostat/prelude - v0.5.0
  • A codec for a value T or null. Keep in mind if you use nullable inside Codec.interface the property will still be required

    +

    Type Parameters

    • T

    Parameters

    Returns functional.Codec<null | T>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.oneOf.html b/functions/functional.oneOf.html index 4f1636f..89b854a 100644 --- a/functions/functional.oneOf.html +++ b/functions/functional.oneOf.html @@ -1,202 +1,2 @@ -oneOf | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function oneOf

-
-
    - -
  • -

    A codec combinator that receives a list of codecs and runs them one after another during decode and resolves to whichever returns Right or to Left if all fail

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      codecs: T
    -

    Returns functional.Codec<GetType<T extends U[]
        ? U
        : never>>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +oneOf | @telostat/prelude - v0.5.0
  • A codec combinator that receives a list of codecs and runs them one after another during decode and resolves to whichever returns Right or to Left if all fail

    +

    Type Parameters

    Parameters

    • codecs: T

    Returns functional.Codec<GetType<T extends U[]
        ? U
        : never>>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.optional.html b/functions/functional.optional.html index 8ee7818..8b959cb 100644 --- a/functions/functional.optional.html +++ b/functions/functional.optional.html @@ -1,199 +1 @@ -optional | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function optional

-
-
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +optional | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.orderToNumber.html b/functions/functional.orderToNumber.html index feeb0c1..fc3dd4e 100644 --- a/functions/functional.orderToNumber.html +++ b/functions/functional.orderToNumber.html @@ -1,197 +1,2 @@ -orderToNumber | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function orderToNumber

-
-
    - -
  • -

    Maps the Order enum to the values expected by the standard ECMAScript library when doing comparison (Array.prototype.sort, for example)

    -
    -
    -

    Parameters

    -
    -

    Returns number

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +orderToNumber | @telostat/prelude - v0.5.0
  • Maps the Order enum to the values expected by the standard ECMAScript library when doing comparison (Array.prototype.sort, for example)

    +

    Parameters

    Returns number

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.parseError.html b/functions/functional.parseError.html index 01072a5..ba402b6 100644 --- a/functions/functional.parseError.html +++ b/functions/functional.parseError.html @@ -1,197 +1,2 @@ -parseError | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function parseError

-
-
    - -
  • -

    Turns a string error message produced by a built-in purify codec into a meta object

    -
    -
    -

    Parameters

    -
      -
    • -
      error: string
    -

    Returns DecodeError

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +parseError | @telostat/prelude - v0.5.0
  • Turns a string error message produced by a built-in purify codec into a meta object

    +

    Parameters

    • error: string

    Returns DecodeError

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.record.html b/functions/functional.record.html index 94d2ebf..8feb086 100644 --- a/functions/functional.record.html +++ b/functions/functional.record.html @@ -1,206 +1,2 @@ -record | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function record

-
-
    - -
  • -

    A codec for an object without specific properties, its restrictions are equivalent to the Record<K, V> type so you can only check for number and string keys

    -
    -
    -

    Type Parameters

    -
      -
    • -

      K extends string | number | symbol

    • -
    • -

      V

    -
    -

    Parameters

    -
    -

    Returns functional.Codec<Record<K, V>>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +record | @telostat/prelude - v0.5.0
  • A codec for an object without specific properties, its restrictions are equivalent to the Record<K, V> type so you can only check for number and string keys

    +

    Type Parameters

    • K extends string | number | symbol

    • V

    Parameters

    Returns functional.Codec<Record<K, V>>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/functional.tuple-2.html b/functions/functional.tuple-2.html index d77f7a0..116d3d6 100644 --- a/functions/functional.tuple-2.html +++ b/functions/functional.tuple-2.html @@ -1,202 +1,2 @@ -tuple | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function tuple

-
-
    - -
  • -

    The same as the array decoder, but accepts a fixed amount of array elements and you can specify each element type, much like the tuple type

    -
    -
    -

    Type Parameters

    -
    -
    -

    Parameters

    -
      -
    • -
      codecs: TS
    -

    Returns functional.Codec<{
        [i in string | number | symbol]: TS[i] extends functional.Codec<U>
            ? U
            : never
    }>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +tuple | @telostat/prelude - v0.5.0
  • The same as the array decoder, but accepts a fixed amount of array elements and you can specify each element type, much like the tuple type

    +

    Type Parameters

    Parameters

    • codecs: TS

    Returns functional.Codec<{
        [i in string | number | symbol]: TS[i] extends functional.Codec<U>
            ? U
            : never
    }>

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/numeric.decimal-2.html b/functions/numeric.decimal-2.html index e09e60d..f3ef819 100644 --- a/functions/numeric.decimal-2.html +++ b/functions/numeric.decimal-2.html @@ -1,26 +1,4 @@ -decimal | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function decimal

-
-
    - -
  • -

    Smart constructor for valid arbitrary precision numeric values.

    +decimal | @telostat/prelude - v0.5.0
    • Smart constructor for valid arbitrary precision numeric values.

      In our context, a valid arbitrary precision number is a finite numeric value represented as a :class value.

      In general, the given value will be converted into a :class value if:

      @@ -29,137 +7,8 @@

      Function decimal

    • the value is a string value and its sanitized representation can be parsed into a valid number excluding NaN, Infinity and -Infinity.
    • -
    -
    -

    Parameters

    -
      -
    • -
      x: string | number
      -

      The value to convert to :class.

      -
      -
    -

    Returns functional.Maybe<Decimal>

    Just finite :class value if -argument is a valid, finite numeric value, Nothing +

    Parameters

    • x: string | number

      The value to convert to :class.

      +

    Returns functional.Maybe<Decimal>

    functional!Just finite :class value if +argument is a valid, finite numeric value, functional!Nothing otherwise.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/numeric.decimalFromNullable.html b/functions/numeric.decimalFromNullable.html index b6a0b1f..e49f0d6 100644 --- a/functions/numeric.decimalFromNullable.html +++ b/functions/numeric.decimalFromNullable.html @@ -1,157 +1,6 @@ -decimalFromNullable | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function decimalFromNullable

-
-

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/numeric.safeDiv.html b/functions/numeric.safeDiv.html index c557f05..1196327 100644 --- a/functions/numeric.safeDiv.html +++ b/functions/numeric.safeDiv.html @@ -1,184 +1,11 @@ -safeDiv | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function safeDiv

-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +safeDiv | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/numeric.sumDecimals.html b/functions/numeric.sumDecimals.html index 3c36000..59b445c 100644 --- a/functions/numeric.sumDecimals.html +++ b/functions/numeric.sumDecimals.html @@ -1,155 +1,4 @@ -sumDecimals | @telostat/prelude - v0.4.1
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file +sumDecimals | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/numeric.unsafeDecimal.html b/functions/numeric.unsafeDecimal.html index f762739..0da96bc 100644 --- a/functions/numeric.unsafeDecimal.html +++ b/functions/numeric.unsafeDecimal.html @@ -1,163 +1,11 @@ -unsafeDecimal | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function unsafeDecimal

-
-

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/temporal.getLastWeekday.html b/functions/temporal.getLastWeekday.html index 792575f..8791081 100644 --- a/functions/temporal.getLastWeekday.html +++ b/functions/temporal.getLastWeekday.html @@ -1,169 +1,7 @@ -getLastWeekday | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function getLastWeekday

-
-
    - -
  • -

    Returns the last weekday as of the given date.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: Dayjs
      -

      Date as of we need the last weekday.

      -
      -
    -

    Returns Dayjs

    Last weekday.

    - -
  • - -
  • -

    Returns the last weekday as of the given date.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional x: string
      -

      Date as of we need the last weekday.

      -
      -
    -

    Returns SDate

    Last weekday.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +getLastWeekday | @telostat/prelude - v0.5.0
  • Returns the last weekday as of the given date.

    +

    Parameters

    • x: Dayjs

      Date as of we need the last weekday.

      +

    Returns Dayjs

    Last weekday.

    +
  • Returns the last weekday as of the given date.

    +

    Parameters

    • Optional x: string

      Date as of we need the last weekday.

      +

    Returns SDate

    Last weekday.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/temporal.getPivotDate.html b/functions/temporal.getPivotDate.html index f43930c..ce76d53 100644 --- a/functions/temporal.getPivotDate.html +++ b/functions/temporal.getPivotDate.html @@ -1,179 +1,9 @@ -getPivotDate | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function getPivotDate

-
-
    - -
  • -

    Returns the date as per given pivotal reference and as of given date.

    -
    -
    -

    Parameters

    -
      -
    • -
      p: PivotDate
      -

      Pivotal reference.

      -
      -
    • -
    • -
      x: Dayjs
      -

      Date as of.

      -
      -
    -

    Returns Dayjs

    A new date.

    - -
  • - -
  • -

    Returns the date as per given pivotal reference and as of given date.

    -
    -
    -

    Parameters

    -
      -
    • -
      p: PivotDate
      -

      Pivotal reference.

      -
      -
    • -
    • -
      Optional x: string
      -

      Date as of.

      -
      -
    -

    Returns SDate

    A new date.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +getPivotDate | @telostat/prelude - v0.5.0
  • Returns the date as per given pivotal reference and as of given date.

    +

    Parameters

    • p: PivotDate

      Pivotal reference.

      +
    • x: Dayjs

      Date as of.

      +

    Returns Dayjs

    A new date.

    +
  • Returns the date as per given pivotal reference and as of given date.

    +

    Parameters

    • p: PivotDate

      Pivotal reference.

      +
    • Optional x: string

      Date as of.

      +

    Returns SDate

    A new date.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/temporal.getToday.html b/functions/temporal.getToday.html index e13b966..767e902 100644 --- a/functions/temporal.getToday.html +++ b/functions/temporal.getToday.html @@ -1,143 +1,2 @@ -getToday | @telostat/prelude - v0.4.1
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file +getToday | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/textual.nonEmptyText.html b/functions/textual.nonEmptyText.html index 56f1ece..af62d94 100644 --- a/functions/textual.nonEmptyText.html +++ b/functions/textual.nonEmptyText.html @@ -1,147 +1,5 @@ -nonEmptyText | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function nonEmptyText

-
-
    - -
  • -

    Returns a non-empty text value for the given nullable textual argument.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: undefined | null | string
      -

      A nullable text value.

      -
      -
    -

    Returns functional.Maybe<string>

    Just text value if the argument is non-null and -non-empty, Nothing otherwise.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +nonEmptyText | @telostat/prelude - v0.5.0

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/textual.sanitizeText.html b/functions/textual.sanitizeText.html index c4d9a09..68d9975 100644 --- a/functions/textual.sanitizeText.html +++ b/functions/textual.sanitizeText.html @@ -1,146 +1,4 @@ -sanitizeText | @telostat/prelude - v0.4.1
-
- -
- -
-

Generated using TypeDoc

-
\ No newline at end of file +sanitizeText | @telostat/prelude - v0.5.0
  • Sanitizes given text value.

    +

    Parameters

    • x: string

      Text value to sanitize.

      +

    Returns string

    Sanitized text value.

    +

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/textual.sanitizedNonEmptyText.html b/functions/textual.sanitizedNonEmptyText.html index 03e8198..ed920b7 100644 --- a/functions/textual.sanitizedNonEmptyText.html +++ b/functions/textual.sanitizedNonEmptyText.html @@ -1,149 +1,7 @@ -sanitizedNonEmptyText | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Function sanitizedNonEmptyText

-
-
    - -
  • -

    Returns a non-empty, sanitized text value for the given nullable textual +sanitizedNonEmptyText | @telostat/prelude - v0.5.0

    Function sanitizedNonEmptyText

    • Returns a non-empty, sanitized text value for the given nullable textual argument.

      -
      -
      -

      Parameters

      -
        -
      • -
        x: undefined | null | string
        -

        A nullable text value.

        -
        -
      -

      Returns functional.Maybe<string>

      Just sanitized text value if the argument is -non-null and non-empty after sanitization, Nothing +

    Parameters

    • x: undefined | null | string

      A nullable text value.

      +

    Returns functional.Maybe<string>

    functional!Just sanitized text value if the argument is +non-null and non-empty after sanitization, functional!Nothing otherwise.

    - -
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 41c1950..5a9f1f6 100644 --- a/index.html +++ b/index.html @@ -1,18 +1,4 @@ -@telostat/prelude - v0.4.1
-
- -
-
-
-
-

@telostat/prelude - v0.4.1

-

Experimental Prelude Module for TypeScript

NPM +@telostat/prelude - v0.5.0

@telostat/prelude - v0.5.0

Experimental Prelude Module for TypeScript

NPM npm GitHub

Installation

npm install dayjs @telostat/prelude
@@ -43,118 +29,4 @@ 

@telostat/prelude - v0.4.1

-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/error.CustomError.html b/interfaces/error.CustomError.html index d63ea4b..ce28107 100644 --- a/interfaces/error.CustomError.html +++ b/interfaces/error.CustomError.html @@ -1,167 +1,6 @@ -CustomError | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface CustomError

-
-

Type definition for custom, non-throwable errors.

-

This is a useful type for the Left of an -Either value.

-
-
-
-

Hierarchy

-
    -
  • CustomError
-
-
-
- -
-
-

Properties

-
err +CustomError | @telostat/prelude - v0.5.0

Type definition for custom, non-throwable errors.

+

This is a useful type for the functional!Left of an +functional!Either value.

+

Hierarchy

  • CustomError

Properties

-
-

Properties

-
- -
err: functional.Maybe<Error>
-
- -
msg: string
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Properties

err: functional.Maybe<Error>
msg: string

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.Codec.html b/interfaces/functional.Codec.html index 2d4370c..857f108 100644 --- a/interfaces/functional.Codec.html +++ b/interfaces/functional.Codec.html @@ -1,297 +1,8 @@ -Codec | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface Codec<T>

-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • Codec
-
-
-
- -
-
-

Properties

-
decode +Codec | @telostat/prelude - v0.5.0

Type Parameters

  • T

Hierarchy

  • Codec
-
-

Properties

-
- -
decode: ((input) => functional.Either<string, T>)
-
-

Type declaration

-
    -
  • -
      -
    • (input): functional.Either<string, T>
    • -
    • -

      Takes a JSON value and runs the decode function the codec was constructed with. All of purify's built-in codecs return a descriptive error message in case the decode fails

      -
      -
      -

      Parameters

      -
        -
      • -
        input: unknown
      -

      Returns functional.Either<string, T>

      -
-
- -
encode: (<U>(input) => U)
-
-

Type declaration

-
    -
  • -
      -
    • <U>(input): U
    • -
    • -

      Takes a runtime value and turns it into a JSON value using the encode function the codec was constructed with. Most of purify's built-in codecs have no custom encode method and they just return the same value, but you could add custom serialization logic for your custom codecs.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U = unknown

      -
      -

      Parameters

      -
        -
      • -
        input: T
      -

      Returns U

      -
-
- -
schema: (() => JSONSchema6)
-
-

Type declaration

-
    -
  • -
      -
    • (): JSONSchema6
    • -
    • -

      Returns JSONSchema6

-
- -
unsafeDecode: ((input) => T)
-
-

Type declaration

-
    -
  • -
      -
    • (input): T
    • -
    • -

      The same as the decode method, but throws an exception on failure. Please only use as an escape hatch

      -
      -
      -

      Parameters

      -
        -
      • -
        input: unknown
      -

      Returns T

      -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Properties

decode: ((input) => functional.Either<string, T>)

Type declaration

    • (input): functional.Either<string, T>
    • Takes a JSON value and runs the decode function the codec was constructed with. All of purify's built-in codecs return a descriptive error message in case the decode fails

      +

      Parameters

      • input: unknown

      Returns functional.Either<string, T>

encode: (<U>(input) => U)

Type declaration

    • <U>(input): U
    • Takes a runtime value and turns it into a JSON value using the encode function the codec was constructed with. Most of purify's built-in codecs have no custom encode method and they just return the same value, but you could add custom serialization logic for your custom codecs.

      +

      Type Parameters

      • U = unknown

      Parameters

      • input: T

      Returns U

schema: (() => JSONSchema6)

Type declaration

    • (): JSONSchema6
    • Returns JSONSchema6

unsafeDecode: ((input) => T)

Type declaration

    • (input): T
    • The same as the decode method, but throws an exception on failure. Please only use as an escape hatch

      +

      Parameters

      • input: unknown

      Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.Either.html b/interfaces/functional.Either.html index 35c0b77..26174a4 100644 --- a/interfaces/functional.Either.html +++ b/interfaces/functional.Either.html @@ -1,43 +1,4 @@ -Either | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface Either<L, R>

-
-

Type Parameters

-
    -
  • -

    L

  • -
  • -

    R

-
-

Hierarchy

-
    -
  • Either
-
-
-
- -
-
-

Methods

-
alt +Either | @telostat/prelude - v0.5.0

Interface Either<L, R>

Type Parameters

  • L

  • R

Hierarchy

  • Either

Methods

alt altLazy ap bimap @@ -74,1021 +35,31 @@

Methods

toMaybe toString unsafeCoerce -
-
-

Methods

-
- -
    - -
  • -

    Returns the first Right between this and another Either or the Left in the argument if both this and the argument are Left

    -
    -
    -

    Parameters

    -
    -

    Returns functional.Either<L, R>

    -
-
- -
-
- -
    - -
  • -

    Applies a Right function over a Right value. Returns Left if either this or the function are Left

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.Either<L | L2, R2>

    -
-
- -
    - -
  • -

    Given two functions, maps the value inside this using the first if this is Left or using the second one if this is Right. +

Methods

  • Returns the first Right between this and another Either or the Left in the argument if both this and the argument are Left

    +

    Parameters

    Returns functional.Either<L, R>

  • Applies a Right function over a Right value. Returns Left if either this or the function are Left

    +

    Type Parameters

    • L2

    • R2

    Parameters

    Returns functional.Either<L | L2, R2>

  • Given two functions, maps the value inside this using the first if this is Left or using the second one if this is Right. If both functions return the same type consider using Either#either instead

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => L2)
      -
        -
      • -
          -
        • (value): L2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns L2

    • -
    • -
      g: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.Either<L2, R2>

    -
-
- -
    - -
  • -

    Structural pattern matching for Either in the form of a function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns T

    -
-
- -
    - -
  • -

    Transforms this with a function that returns an Either. Useful for chaining many computations that may fail

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.Either<L | L2, R2>

    -
-
- -
    - -
  • -

    The same as Either#chain but executes the transformation function only if the value is Left. Useful for recovering from errors

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.Either<L2, R | R2>

    -
-
- -
    - -
  • -

    Compares this to another Either, returns false if the constructors or the values inside are different, e.g. Right(5).equals(Left(5)) is false

    -
    -
    -

    Parameters

    -
    -

    Returns boolean

    -
-
- -
    - -
  • -

    Returns this if it's a Left, otherwise it returns the result of applying the function argument to this and wrapping it in a Right

    -
    -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
        -
      • -
    -

    Returns functional.Either<L, R2>

    -
-
- -
    - -
  • -

    Extracts the value out of this

    -
    -

    Returns L | R

    -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => L2)
      -
        -
      • -
          -
        • (value): L2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns L2

    • -
    • -
      g: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.Either<L2, R2>

-
- -
-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
        -
      • -
    -

    Returns functional.Either<L, R2>

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.Either<L, R2>

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      reducer: ((accumulator, value) => T)
      -
        -
      • -
          -
        • (accumulator, value): T
        • -
        • -
          -

          Parameters

          -
            -
          • -
            accumulator: T
          • -
          • -
            value: R
          -

          Returns T

    • -
    • -
      initialValue: T
    -

    Returns T

-
- -
    - -
  • -

    Runs an effect if this is Left, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns any

    -

    Returns functional.Either<L, R>

    -
-
- -
    - -
  • -

    Runs an effect if this is Right, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns any

    -

    Returns functional.Either<L, R>

    -
-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns true if this is Left, otherwise it returns false

    -
    -

    Returns this is functional.Either<L, never>

    -
-
- -
    - -
  • -

    Returns true if this is Right, otherwise it returns false

    -
    -

    Returns this is functional.Either<never, R>

    -
-
- -
    - -
  • -

    Flattens nested Eithers. e.join() is equivalent to e.chain(x => x)

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.Either<L | L2, R2>

    -
-
- -
    - -
  • -

    Returns the value inside this if it's Left or a default value if this is Right

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: L
    -

    Returns L

    -
-
- -
    - -
  • -

    Lazy version of leftOrDefault. Takes a function that returns the default value, that function will be called only if this is Right

    -
    -
    -

    Parameters

    -
      -
    • -
      getDefaultValue: (() => L)
      -
        -
      • -
          -
        • (): L
        • -
        • -

          Returns L

    -

    Returns L

    -
-
- -
    - -
  • -

    Constructs a Just with the value of this if it's Left or a Nothing if this is Right

    -
    -

    Returns functional.Maybe<L>

    -
-
- -
    - -
  • -

    Maps the Right value of this, acts like an identity if this is Left

    -
    -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.Either<L, R2>

    -
-
- -
    - -
  • -

    Maps the Left value of this, acts like an identity if this is Right

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => L2)
      -
        -
      • -
          -
        • (value): L2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns L2

    -

    Returns functional.Either<L2, R>

    -
-
- -
    - -
  • -

    Returns the value inside this if it's Right or a default value if this is Left

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: R
    -

    Returns R

    -
-
- -
    - -
  • -

    Lazy version of orDefault. Takes a function that returns the default value, that function will be called only if this is Left

    -
    -
    -

    Parameters

    -
      -
    • -
      getDefaultValue: (() => R)
      -
        -
      • -
          -
        • (): R
        • -
        • -

          Returns R

    -

    Returns R

    -
-
- -
    - -
  • -

    Takes a reducer and an initial value and returns the initial value if this is Left or the result of applying the function to the initial value and the value inside this

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      reducer: ((accumulator, value) => T)
      -
        -
      • -
          -
        • (accumulator, value): T
        • -
        • -
          -

          Parameters

          -
            -
          • -
            accumulator: T
          • -
          • -
            value: R
          -

          Returns T

    • -
    • -
      initialValue: T
    -

    Returns T

    -
-
- -
    - -
  • -

    Returns Right if this is Left and vice versa

    -
    -

    Returns functional.Either<R, L>

    -
-
- -
    - -
  • -

    Returns L | R

-
- -
    - -
  • -

    Constructs a Just with the value of this if it's Right or a Nothing if this is Left

    -
    -

    Returns functional.Maybe<R>

    -
-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns the value inside this if it's a Right or either throws the value or a generic exception depending on whether the value is an Error

    -
    -

    Returns R

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Type Parameters

  • L2

  • R2

Parameters

  • f: ((value) => L2)
      • (value): L2
      • Parameters

        • value: L

        Returns L2

  • g: ((value) => R2)
      • (value): R2
      • Parameters

        • value: R

        Returns R2

Returns functional.Either<L2, R2>

  • Structural pattern matching for Either in the form of a function

    +

    Type Parameters

    • T

    Parameters

    Returns T

  • The same as Either#chain but executes the transformation function only if the value is Left. Useful for recovering from errors

    +

    Type Parameters

    • L2

    • R2

    Parameters

    Returns functional.Either<L2, R | R2>

  • Compares this to another Either, returns false if the constructors or the values inside are different, e.g. Right(5).equals(Left(5)) is false

    +

    Parameters

    Returns boolean

  • Returns this if it's a Left, otherwise it returns the result of applying the function argument to this and wrapping it in a Right

    +

    Type Parameters

    • R2

    Parameters

    Returns functional.Either<L, R2>

  • Extracts the value out of this

    +

    Returns L | R

  • Type Parameters

    • L2

    • R2

    Parameters

    • f: ((value) => L2)
        • (value): L2
        • Parameters

          • value: L

          Returns L2

    • g: ((value) => R2)
        • (value): R2
        • Parameters

          • value: R

          Returns R2

    Returns functional.Either<L2, R2>

  • Parameters

    Returns boolean

  • Type Parameters

    • R2

    Parameters

    • f: ((value) => R2)
        • (value): R2
        • Parameters

          • value: R

          Returns R2

    Returns functional.Either<L, R2>

  • Type Parameters

    • T

    Parameters

    • reducer: ((accumulator, value) => T)
        • (accumulator, value): T
        • Parameters

          • accumulator: T
          • value: R

          Returns T

    • initialValue: T

    Returns T

  • Runs an effect if this is Left, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: L

          Returns any

    Returns functional.Either<L, R>

  • Runs an effect if this is Right, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: R

          Returns any

    Returns functional.Either<L, R>

  • Returns string

  • Returns true if this is Left, otherwise it returns false

    +

    Returns this is functional.Either<L, never>

  • Returns true if this is Right, otherwise it returns false

    +

    Returns this is functional.Either<never, R>

  • Returns the value inside this if it's Left or a default value if this is Right

    +

    Parameters

    • defaultValue: L

    Returns L

  • Lazy version of leftOrDefault. Takes a function that returns the default value, that function will be called only if this is Right

    +

    Parameters

    • getDefaultValue: (() => L)
        • (): L
        • Returns L

    Returns L

  • Constructs a Just with the value of this if it's Left or a Nothing if this is Right

    +

    Returns functional.Maybe<L>

  • Maps the Right value of this, acts like an identity if this is Left

    +

    Type Parameters

    • R2

    Parameters

    • f: ((value) => R2)
        • (value): R2
        • Parameters

          • value: R

          Returns R2

    Returns functional.Either<L, R2>

  • Maps the Left value of this, acts like an identity if this is Right

    +

    Type Parameters

    • L2

    Parameters

    • f: ((value) => L2)
        • (value): L2
        • Parameters

          • value: L

          Returns L2

    Returns functional.Either<L2, R>

  • Returns the value inside this if it's Right or a default value if this is Left

    +

    Parameters

    • defaultValue: R

    Returns R

  • Lazy version of orDefault. Takes a function that returns the default value, that function will be called only if this is Left

    +

    Parameters

    • getDefaultValue: (() => R)
        • (): R
        • Returns R

    Returns R

  • Takes a reducer and an initial value and returns the initial value if this is Left or the result of applying the function to the initial value and the value inside this

    +

    Type Parameters

    • T

    Parameters

    • reducer: ((accumulator, value) => T)
        • (accumulator, value): T
        • Parameters

          • accumulator: T
          • value: R

          Returns T

    • initialValue: T

    Returns T

  • Returns L | R

  • Constructs a Just with the value of this if it's Right or a Nothing if this is Left

    +

    Returns functional.Maybe<R>

  • Returns string

  • Returns the value inside this if it's a Right or either throws the value or a generic exception depending on whether the value is an Error

    +

    Returns R

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.EitherAsync.html b/interfaces/functional.EitherAsync.html index f2ce080..1f22d9b 100644 --- a/interfaces/functional.EitherAsync.html +++ b/interfaces/functional.EitherAsync.html @@ -1,49 +1,5 @@ -EitherAsync | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface EitherAsync<L, R>

-
-

Type Parameters

-
    -
  • -

    L

  • -
  • -

    R

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
alt +EitherAsync | @telostat/prelude - v0.5.0

Interface EitherAsync<L, R>

Type Parameters

  • L

  • R

Hierarchy

Properties

Methods

alt ap bimap caseOf @@ -64,489 +20,22 @@

Methods

swap toMaybeAsync void -
-
-

Properties

-
- -
then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => PromiseLike<TResult1 | TResult2>)
-
-

Type declaration

-
    -
  • -
      -
    • <TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
    • -
    • -

      WARNING: This is implemented only for Promise compatibility. Please use chain instead.

      -
      -
      -

      Type Parameters

      -
      -
      -

      Parameters

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

      Returns PromiseLike<TResult1 | TResult2>

      -
-
-

Methods

-
- -
    - -
  • -

    Returns the first Right between the future value of this and another EitherAsync or the Left in the argument if both this and the argument resolve to Left

    -
    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L, R>

    -
-
- -
    - -
  • -

    Applies a Right function wrapped in EitherAsync over a future Right value. Returns Left if either the this resolves to a Left or the function is Left

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L | L2, Awaited<R2>>

    -
-
- -
    - -
  • -

    Given two functions, maps the value that the Promise inside this resolves to using the first if it is Left or using the second one if it is Right

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => L2)
      -
        -
      • -
          -
        • (value): L2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns L2

    • -
    • -
      g: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.EitherAsync<Awaited<L2>, Awaited<R2>>

    -
-
- -
    - -
  • -

    Structural pattern matching for EitherAsync in the form of a function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns Promise<T>

    -
-
- -
    - -
  • -

    Transforms this with a function that returns a EitherAsync. Behaviour is the same as the regular Either#chain

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L | L2, R2>

    -
-
- -
    - -
  • -

    The same as EitherAsync#chain but executes the transformation function only if the value is Left. Useful for recovering from errors

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    • -
    • -

      R2

    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L2, R | R2>

    -
-
- -
    - -
  • -

    Returns this if it resolves to a Left, otherwise it returns the result of applying the function argument to this and wrapping it in a Right

    -
    -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
    -

    Returns functional.EitherAsync<L, Awaited<R2>>

    -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      effect: (() => any)
      -
        -
      • -
          -
        • (): any
        • -
        • -

          Returns any

    -

    Returns functional.EitherAsync<L, R>

-
- -
    - -
  • -

    Runs an effect if this is Left, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns any

    -

    Returns functional.EitherAsync<L, R>

    -
-
- -
    - -
  • -

    Runs an effect if this is Right, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns any

    -

    Returns functional.EitherAsync<L, R>

    -
-
- -
-
- -
    - -
  • -

    Returns a Promise that resolves to the value inside this if it's Left or a default value if this is Right

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: L
    -

    Returns Promise<L>

    -
-
- -
    - -
  • -

    Transforms the Right value of this with a given function. If the EitherAsync that is being mapped resolves to a Left then the mapping function won't be called and run will resolve the whole thing to that Left, just like the regular Either#map

    -
    -
    -

    Type Parameters

    -
      -
    • -

      R2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => R2)
      -
        -
      • -
          -
        • (value): R2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: R
          -

          Returns R2

    -

    Returns functional.EitherAsync<L, Awaited<R2>>

    -
-
- -
    - -
  • -

    Maps the Left value of this, acts like an identity if this is Right

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L2

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => L2)
      -
        -
      • -
          -
        • (value): L2
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: L
          -

          Returns L2

    -

    Returns functional.EitherAsync<Awaited<L2>, R>

    -
-
- -
    - -
  • -

    Returns a Promise that resolves to the value inside this if it's Right or a default value if this is Left

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: R
    -

    Returns Promise<R>

    -
-
- -
    - -
  • -

    It's important to remember how run will behave because in an +

Properties

then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => PromiseLike<TResult1 | TResult2>)

Type declaration

    • <TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
    • WARNING: This is implemented only for Promise compatibility. Please use chain instead.

      +

      Type Parameters

      Parameters

      • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
      • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      Returns PromiseLike<TResult1 | TResult2>

Methods

  • Returns the first Right between the future value of this and another EitherAsync or the Left in the argument if both this and the argument resolve to Left

    +

    Parameters

    Returns functional.EitherAsync<L, R>

  • Applies a Right function wrapped in EitherAsync over a future Right value. Returns Left if either the this resolves to a Left or the function is Left

    +

    Type Parameters

    • L2

    • R2

    Parameters

    Returns functional.EitherAsync<L | L2, Awaited<R2>>

  • Given two functions, maps the value that the Promise inside this resolves to using the first if it is Left or using the second one if it is Right

    +

    Type Parameters

    • L2

    • R2

    Parameters

    • f: ((value) => L2)
        • (value): L2
        • Parameters

          • value: L

          Returns L2

    • g: ((value) => R2)
        • (value): R2
        • Parameters

          • value: R

          Returns R2

    Returns functional.EitherAsync<Awaited<L2>, Awaited<R2>>

  • Structural pattern matching for EitherAsync in the form of a function

    +

    Type Parameters

    • T

    Parameters

    Returns Promise<T>

  • Transforms this with a function that returns a EitherAsync. Behaviour is the same as the regular Either#chain

    +

    Type Parameters

    • L2

    • R2

    Parameters

    Returns functional.EitherAsync<L | L2, R2>

  • The same as EitherAsync#chain but executes the transformation function only if the value is Left. Useful for recovering from errors

    +

    Type Parameters

    • L2

    • R2

    Parameters

    Returns functional.EitherAsync<L2, R | R2>

  • Returns this if it resolves to a Left, otherwise it returns the result of applying the function argument to this and wrapping it in a Right

    +

    Type Parameters

    • R2

    Parameters

    Returns functional.EitherAsync<L, Awaited<R2>>

  • Runs an effect if this is Left, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: L

          Returns any

    Returns functional.EitherAsync<L, R>

  • Runs an effect if this is Right, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: R

          Returns any

    Returns functional.EitherAsync<L, R>

  • Returns a Promise that resolves to the value inside this if it's Left or a default value if this is Right

    +

    Parameters

    • defaultValue: L

    Returns Promise<L>

  • Transforms the Right value of this with a given function. If the EitherAsync that is being mapped resolves to a Left then the mapping function won't be called and run will resolve the whole thing to that Left, just like the regular Either#map

    +

    Type Parameters

    • R2

    Parameters

    • f: ((value) => R2)
        • (value): R2
        • Parameters

          • value: R

          Returns R2

    Returns functional.EitherAsync<L, Awaited<R2>>

  • Maps the Left value of this, acts like an identity if this is Right

    +

    Type Parameters

    • L2

    Parameters

    • f: ((value) => L2)
        • (value): L2
        • Parameters

          • value: L

          Returns L2

    Returns functional.EitherAsync<Awaited<L2>, R>

  • Returns a Promise that resolves to the value inside this if it's Right or a default value if this is Left

    +

    Parameters

    • defaultValue: R

    Returns Promise<R>

  • It's important to remember how run will behave because in an async context there are other ways for a function to fail other than to return a Nothing, for example: If any of the computations inside EitherAsync resolved to a Left, @@ -557,231 +46,7 @@

    -
-
- -
-
- -
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Returns Promise<functional.Either<L, R>>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.EitherAsyncTypeRef.html b/interfaces/functional.EitherAsyncTypeRef.html index 7cfcfaf..778e7f4 100644 --- a/interfaces/functional.EitherAsyncTypeRef.html +++ b/interfaces/functional.EitherAsyncTypeRef.html @@ -1,389 +1,14 @@ -EitherAsyncTypeRef | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface EitherAsyncTypeRef

-
-

Hierarchy

-
    -
  • EitherAsyncTypeRef
-
-
    - -
  • -

    Constructs an EitherAsync object from a function that takes an object full of helpers that let you lift things into the EitherAsync context and returns a Promise

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
      -
    • -
      runPromise: ((helpers) => PromiseLike<R>)
      -
        -
      • -
          -
        • (helpers): PromiseLike<R>
        • -
        • -
          -

          Parameters

          -
            -
          • -
            helpers: EitherAsyncHelpers<L>
          -

          Returns PromiseLike<R>

    -

    Returns functional.EitherAsync<L, R>

    -
-
-
-
- -
-
-

Methods

-
all +EitherAsyncTypeRef | @telostat/prelude - v0.5.0

Hierarchy

  • EitherAsyncTypeRef
  • Constructs an EitherAsync object from a function that takes an object full of helpers that let you lift things into the EitherAsync context and returns a Promise

    +

    Type Parameters

    • L

    • R

    Parameters

    • runPromise: ((helpers) => PromiseLike<R>)
        • (helpers): PromiseLike<R>
        • Parameters

          • helpers: EitherAsyncHelpers<L>

          Returns PromiseLike<R>

    Returns functional.EitherAsync<L, R>

-
-

Methods

-
- -
    - -
  • -

    The same as EitherAsync.sequence, but it will run all async operations at the same time rather than sequentially

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L, R[]>

    -
-
- -
-
- -
    - -
  • -

    Takes a list of EitherAsyncs and returns a Promise that will resolve with all Left values. Internally it uses Promise.all to wait for all results

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
    -

    Returns Promise<L[]>

    -
-
- -
-
- -
    - -
  • -

    Takes a list of EitherAsyncs and returns a Promise that will resolve with all Right values. Internally it uses Promise.all to wait for all results

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
    -

    Returns Promise<R[]>

    -
-
- -
    - -
  • -

    Turns a list of EitherAsyncs into an EitherAsync of list. The returned Promise will be rejected as soon as a single EitherAsync resolves to a Left, it will not wait for all Promises to resolve and since EitherAsync is lazy, unlike Promise, the remaining async operations will not be executed at all

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    -
    -

    Parameters

    -
    -

    Returns functional.EitherAsync<L, R[]>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

  • The same as EitherAsync.sequence, but it will run all async operations at the same time rather than sequentially

    +

    Type Parameters

    • L

    • R

    Parameters

    Returns functional.EitherAsync<L, R[]>

  • Takes a list of EitherAsyncs and returns a Promise that will resolve with all Left values. Internally it uses Promise.all to wait for all results

    +

    Type Parameters

    • L

    • R

    Parameters

    Returns Promise<L[]>

  • Takes a list of EitherAsyncs and returns a Promise that will resolve with all Right values. Internally it uses Promise.all to wait for all results

    +

    Type Parameters

    • L

    • R

    Parameters

    Returns Promise<R[]>

  • Turns a list of EitherAsyncs into an EitherAsync of list. The returned Promise will be rejected as soon as a single EitherAsync resolves to a Left, it will not wait for all Promises to resolve and since EitherAsync is lazy, unlike Promise, the remaining async operations will not be executed at all

    +

    Type Parameters

    • L

    • R

    Parameters

    Returns functional.EitherAsync<L, R[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.Maybe.html b/interfaces/functional.Maybe.html index e987fc3..ac25fcc 100644 --- a/interfaces/functional.Maybe.html +++ b/interfaces/functional.Maybe.html @@ -1,41 +1,4 @@ -Maybe | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface Maybe<T>

-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
    -
  • Maybe
-
-
-
- -
-
-

Methods

-
alt +Maybe | @telostat/prelude - v0.5.0

Type Parameters

  • T

Hierarchy

  • Maybe

Methods

alt altLazy ap caseOf @@ -70,992 +33,29 @@

Methods

toList toString unsafeCoerce -
-
-

Methods

-
- -
    - -
  • -

    Returns the first Just between this and another Maybe or Nothing if both this and the argument are Nothing

    -
    -
    -

    Parameters

    -
    -

    Returns functional.Maybe<T>

    -
-
- -
-
- -
    - -
  • -

    Maps this with a Maybe function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns functional.Maybe<U>

    -
-
- -
    - -
  • -

    Structural pattern matching for Maybe in the form of a function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns U

    -
-
- -
    - -
  • -

    Transforms this with a function that returns a Maybe. Useful for chaining many computations that may result in a missing value

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns functional.Maybe<U>

    -
-
- -
    - -
  • -

    Transforms this with a function that returns a nullable value. Equivalent to m.chain(x => Maybe.fromNullable(f(x)))

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => undefined | null | void | U)
      -
        -
      • -
          -
        • (value): undefined | null | void | U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns undefined | null | void | U

    -

    Returns functional.Maybe<U>

    -
-
- -
    - -
  • -

    Compares the values inside this and the argument, returns true if both are Nothing or if the values are equal

    -
    -
    -

    Parameters

    -
    -

    Returns boolean

    -
-
- -
    - -
  • -

    Returns this if it's Nothing, otherwise it returns the result of applying the function argument to this and wrapping it in a Just

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
    -

    Returns functional.Maybe<U>

    -
-
- -
    - -
  • -

    Returns the value inside this or undefined if this is Nothing. Use extractNullable if you need a null returned instead

    -
    -

    Returns ExtractMaybe<T, undefined>

    -
-
- -
    - -
  • -

    Returns the value inside this or null if this is Nothing. Use extract if you need an undefined returned instead

    -
    -

    Returns ExtractMaybe<T, null>

    -
-
- -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Parameters

    -
    -

    Returns boolean

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
    -

    Returns functional.Maybe<U>

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => boolean)
      -
        -
      • -
          -
        • (value): boolean
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns boolean

    -

    Returns functional.Maybe<U>

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => boolean)
      -
        -
      • -
          -
        • (value): boolean
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns boolean

    -

    Returns functional.Maybe<T>

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
          -
        • (value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns U

    -

    Returns functional.Maybe<U>

-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      reducer: ((accumulator, value) => U)
      -
        -
      • -
          -
        • (accumulator, value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            accumulator: U
          • -
          • -
            value: T
          -

          Returns U

    • -
    • -
      initialValue: U
    -

    Returns U

-
- -
    - -
  • -

    Takes a predicate function and returns this if the predicate returns true or Nothing if it returns false

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => value is U)
      -
        -
      • -
          -
        • (value): value is U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns value is U

    -

    Returns functional.Maybe<U>

    -
  • - -
  • -

    Takes a predicate function and returns this if the predicate returns true or Nothing if it returns false

    -
    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => boolean)
      -
        -
      • -
          -
        • (value): boolean
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns boolean

    -

    Returns functional.Maybe<T>

    -
-
- -
    - -
  • -

    Runs an effect if this is Just, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns any

    -

    Returns functional.Maybe<T>

    -
-
- -
    - -
  • -

    Runs an effect if this is Nothing, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: (() => any)
      -
        -
      • -
          -
        • (): any
        • -
        • -

          Returns any

    -

    Returns functional.Maybe<T>

    -
-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns true if this is Just, otherwise it returns false

    -
    -

    Returns this is AlwaysJust

    -
-
- -
    - -
  • -

    Returns true if this is Nothing, otherwise it returns false

    -
    -

    Returns this is Nothing

    -
-
- -
-
- -
    - -
  • -

    Transforms the value inside this with a given function. Returns Nothing if this is Nothing

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
          -
        • (value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns U

    -

    Returns functional.Maybe<U>

    -
-
- -
    - -
  • -

    Maps over this and returns the resulting value or returns the default value if this is Nothing

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
          -
        • (value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns U

    • -
    • -
      defaultValue: U
    -

    Returns U

    -
-
- -
    - -
  • -

    Returns the default value if this is Nothing, otherwise it return the value inside this

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: T
    -

    Returns T

    -
-
- -
    - -
  • -

    Lazy version of orDefault. Takes a function that returns the default value, that function will be called only if this is Nothing

    -
    -
    -

    Parameters

    -
      -
    • -
      getDefaultValue: (() => T)
      -
        -
      • -
          -
        • (): T
        • -
        • -

          Returns T

    -

    Returns T

    -
-
- -
    - -
  • -

    Takes a reducer and an initial value and returns the initial value if this is Nothing or the result of applying the function to the initial value and the value inside this

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      reducer: ((accumulator, value) => U)
      -
        -
      • -
          -
        • (accumulator, value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            accumulator: U
          • -
          • -
            value: T
          -

          Returns U

    • -
    • -
      initialValue: U
    -

    Returns U

    -
-
- -
    - -
  • -

    Constructs a Right from a Just or a Left with a provided left value if this is Nothing

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    -
    -

    Parameters

    -
      -
    • -
      left: L
    -

    Returns functional.Either<L, T>

    -
-
- -
    - -
  • -

    Returns T

-
- -
    - -
  • -

    Returns empty list if the Maybe is Nothing or a list where the only element is the value of Just

    -
    -

    Returns T[]

    -
-
- -
    - -
  • -

    Returns string

-
- -
    - -
  • -

    Returns the value inside this or throws an error if this is Nothing

    -
    -

    Returns T

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

  • Returns the first Just between this and another Maybe or Nothing if both this and the argument are Nothing

    +

    Parameters

    Returns functional.Maybe<T>

  • Structural pattern matching for Maybe in the form of a function

    +

    Type Parameters

    • U

    Parameters

    Returns U

  • Transforms this with a function that returns a nullable value. Equivalent to m.chain(x => Maybe.fromNullable(f(x)))

    +

    Type Parameters

    • U

    Parameters

    • f: ((value) => undefined | null | void | U)
        • (value): undefined | null | void | U
        • Parameters

          • value: T

          Returns undefined | null | void | U

    Returns functional.Maybe<U>

  • Compares the values inside this and the argument, returns true if both are Nothing or if the values are equal

    +

    Parameters

    Returns boolean

  • Returns this if it's Nothing, otherwise it returns the result of applying the function argument to this and wrapping it in a Just

    +

    Type Parameters

    • U

    Parameters

    Returns functional.Maybe<U>

  • Returns the value inside this or undefined if this is Nothing. Use extractNullable if you need a null returned instead

    +

    Returns ExtractMaybe<T, undefined>

  • Returns the value inside this or null if this is Nothing. Use extract if you need an undefined returned instead

    +

    Returns ExtractMaybe<T, null>

  • Parameters

    Returns boolean

  • Type Parameters

    • U

    Parameters

    • pred: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns functional.Maybe<U>

  • Parameters

    • pred: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns functional.Maybe<T>

  • Type Parameters

    • U

    Parameters

    • f: ((value) => U)
        • (value): U
        • Parameters

          • value: T

          Returns U

    Returns functional.Maybe<U>

  • Type Parameters

    • U

    Parameters

    • reducer: ((accumulator, value) => U)
        • (accumulator, value): U
        • Parameters

          • accumulator: U
          • value: T

          Returns U

    • initialValue: U

    Returns U

  • Takes a predicate function and returns this if the predicate returns true or Nothing if it returns false

    +

    Type Parameters

    • U

    Parameters

    • pred: ((value) => value is U)
        • (value): value is U
        • Parameters

          • value: T

          Returns value is U

    Returns functional.Maybe<U>

  • Takes a predicate function and returns this if the predicate returns true or Nothing if it returns false

    +

    Parameters

    • pred: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns functional.Maybe<T>

  • Runs an effect if this is Just, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: T

          Returns any

    Returns functional.Maybe<T>

  • Runs an effect if this is Nothing, returns this to make chaining other methods possible

    +

    Parameters

    • effect: (() => any)
        • (): any
        • Returns any

    Returns functional.Maybe<T>

  • Returns string

  • Returns true if this is Just, otherwise it returns false

    +

    Returns this is AlwaysJust

  • Returns true if this is Nothing, otherwise it returns false

    +

    Returns this is Nothing

  • Transforms the value inside this with a given function. Returns Nothing if this is Nothing

    +

    Type Parameters

    • U

    Parameters

    • f: ((value) => U)
        • (value): U
        • Parameters

          • value: T

          Returns U

    Returns functional.Maybe<U>

  • Maps over this and returns the resulting value or returns the default value if this is Nothing

    +

    Type Parameters

    • U

    Parameters

    • f: ((value) => U)
        • (value): U
        • Parameters

          • value: T

          Returns U

    • defaultValue: U

    Returns U

  • Returns the default value if this is Nothing, otherwise it return the value inside this

    +

    Parameters

    • defaultValue: T

    Returns T

  • Lazy version of orDefault. Takes a function that returns the default value, that function will be called only if this is Nothing

    +

    Parameters

    • getDefaultValue: (() => T)
        • (): T
        • Returns T

    Returns T

  • Takes a reducer and an initial value and returns the initial value if this is Nothing or the result of applying the function to the initial value and the value inside this

    +

    Type Parameters

    • U

    Parameters

    • reducer: ((accumulator, value) => U)
        • (accumulator, value): U
        • Parameters

          • accumulator: U
          • value: T

          Returns U

    • initialValue: U

    Returns U

  • Constructs a Right from a Just or a Left with a provided left value if this is Nothing

    +

    Type Parameters

    • L

    Parameters

    • left: L

    Returns functional.Either<L, T>

  • Returns T

  • Returns empty list if the Maybe is Nothing or a list where the only element is the value of Just

    +

    Returns T[]

  • Returns string

  • Returns the value inside this or throws an error if this is Nothing

    +

    Returns T

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.MaybeAsync.html b/interfaces/functional.MaybeAsync.html index 2889694..4171304 100644 --- a/interfaces/functional.MaybeAsync.html +++ b/interfaces/functional.MaybeAsync.html @@ -1,47 +1,5 @@ -MaybeAsync | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface MaybeAsync<T>

-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
-
-

Methods

-
alt +MaybeAsync | @telostat/prelude - v0.5.0

Type Parameters

  • T

Hierarchy

Properties

Methods

alt ap caseOf chain @@ -59,455 +17,20 @@

Methods

run toEitherAsync void -
-
-

Properties

-
- -
then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => PromiseLike<TResult1 | TResult2>)
-
-

Type declaration

-
    -
  • -
      -
    • <TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
    • -
    • -

      WARNING: This is implemented only for Promise compatibility. Please use chain instead.

      -
      -
      -

      Type Parameters

      -
      -
      -

      Parameters

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

      Returns PromiseLike<TResult1 | TResult2>

      -
-
-

Methods

-
- -
    - -
  • -

    Returns the first Just between the future value of this and another future Maybe or future Nothing if both this and the argument are Nothing

    -
    -
    -

    Parameters

    -
    -

    Returns functional.MaybeAsync<T>

    -
-
- -
    - -
  • -

    Maps the future value of this with another future Maybe function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns functional.MaybeAsync<Awaited<U>>

    -
-
- -
    - -
  • -

    Structural pattern matching for MaybeAsync in the form of a function

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns Promise<U>

    -
-
- -
    - -
  • -

    Transforms this with a function that returns a MaybeAsync. Behaviour is the same as the regular Maybe#chain

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
    -

    Returns functional.MaybeAsync<U>

    -
-
- -
    - -
  • -

    Returns this if it resolves to Nothing, otherwise it returns the result of applying the function argument to the value of this and wrapping it in a Just

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
    -

    Returns functional.MaybeAsync<Awaited<U>>

    -
-
- -
-
- -
-
- -
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => value is U)
      -
        -
      • -
          -
        • (value): value is U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns value is U

    -

    Returns functional.MaybeAsync<U>

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => boolean)
      -
        -
      • -
          -
        • (value): boolean
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns boolean

    -

    Returns functional.MaybeAsync<T>

-
- -
    - -
  • -

    Takes a predicate function and returns this if the predicate, applied to the resolved value, is true or Nothing if it's false

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => value is U)
      -
        -
      • -
          -
        • (value): value is U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns value is U

    -

    Returns functional.MaybeAsync<U>

    -
  • - -
  • -

    Takes a predicate function and returns this if the predicate, applied to the resolved value, is true or Nothing if it's false

    -
    -
    -

    Parameters

    -
      -
    • -
      pred: ((value) => boolean)
      -
        -
      • -
          -
        • (value): boolean
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns boolean

    -

    Returns functional.MaybeAsync<T>

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      effect: (() => any)
      -
        -
      • -
          -
        • (): any
        • -
        • -

          Returns any

    -

    Returns functional.MaybeAsync<T>

-
- -
    - -
  • -

    Runs an effect if this is Just, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: ((value) => any)
      -
        -
      • -
          -
        • (value): any
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns any

    -

    Returns functional.MaybeAsync<T>

    -
-
- -
    - -
  • -

    Runs an effect if this is Nothing, returns this to make chaining other methods possible

    -
    -
    -

    Parameters

    -
      -
    • -
      effect: (() => any)
      -
        -
      • -
          -
        • (): any
        • -
        • -

          Returns any

    -

    Returns functional.MaybeAsync<T>

    -
-
- -
-
- -
    - -
  • -

    Transforms the value inside this with a given function. If the MaybeAsync that is being mapped resolves to Nothing then the mapping function won't be called and run will resolve the whole thing to Nothing, just like the regular Maybe#map

    -
    -
    -

    Type Parameters

    -
      -
    • -

      U

    -
    -

    Parameters

    -
      -
    • -
      f: ((value) => U)
      -
        -
      • -
          -
        • (value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns U

    -

    Returns functional.MaybeAsync<Awaited<U>>

    -
-
- -
    - -
  • -

    Returns the default value if this is Nothing, otherwise it returns a Promise that will resolve to the value inside this

    -
    -
    -

    Parameters

    -
      -
    • -
      defaultValue: T
    -

    Returns Promise<T>

    -
-
- -
    - -
  • -

    It's important to remember how run will behave because in an +

Properties

then: (<TResult1, TResult2>(onfulfilled?, onrejected?) => PromiseLike<TResult1 | TResult2>)

Type declaration

    • <TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
    • WARNING: This is implemented only for Promise compatibility. Please use chain instead.

      +

      Type Parameters

      Parameters

      • Optional onfulfilled: null | ((value) => TResult1 | PromiseLike<TResult1>)
      • Optional onrejected: null | ((reason) => TResult2 | PromiseLike<TResult2>)

      Returns PromiseLike<TResult1 | TResult2>

Methods

  • Returns the first Just between the future value of this and another future Maybe or future Nothing if both this and the argument are Nothing

    +

    Parameters

    Returns functional.MaybeAsync<T>

  • Maps the future value of this with another future Maybe function

    +

    Type Parameters

    • U

    Parameters

    Returns functional.MaybeAsync<Awaited<U>>

  • Structural pattern matching for MaybeAsync in the form of a function

    +

    Type Parameters

    • U

    Parameters

    Returns Promise<U>

  • Returns this if it resolves to Nothing, otherwise it returns the result of applying the function argument to the value of this and wrapping it in a Just

    +

    Type Parameters

    • U

    Parameters

    Returns functional.MaybeAsync<Awaited<U>>

  • Type Parameters

    • U

    Parameters

    • pred: ((value) => value is U)
        • (value): value is U
        • Parameters

          • value: T

          Returns value is U

    Returns functional.MaybeAsync<U>

  • Parameters

    • pred: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns functional.MaybeAsync<T>

  • Takes a predicate function and returns this if the predicate, applied to the resolved value, is true or Nothing if it's false

    +

    Type Parameters

    • U

    Parameters

    • pred: ((value) => value is U)
        • (value): value is U
        • Parameters

          • value: T

          Returns value is U

    Returns functional.MaybeAsync<U>

  • Takes a predicate function and returns this if the predicate, applied to the resolved value, is true or Nothing if it's false

    +

    Parameters

    • pred: ((value) => boolean)
        • (value): boolean
        • Parameters

          • value: T

          Returns boolean

    Returns functional.MaybeAsync<T>

  • Runs an effect if this is Just, returns this to make chaining other methods possible

    +

    Parameters

    • effect: ((value) => any)
        • (value): any
        • Parameters

          • value: T

          Returns any

    Returns functional.MaybeAsync<T>

  • Runs an effect if this is Nothing, returns this to make chaining other methods possible

    +

    Parameters

    • effect: (() => any)
        • (): any
        • Returns any

    Returns functional.MaybeAsync<T>

  • Transforms the value inside this with a given function. If the MaybeAsync that is being mapped resolves to Nothing then the mapping function won't be called and run will resolve the whole thing to Nothing, just like the regular Maybe#map

    +

    Type Parameters

    • U

    Parameters

    • f: ((value) => U)
        • (value): U
        • Parameters

          • value: T

          Returns U

    Returns functional.MaybeAsync<Awaited<U>>

  • Returns the default value if this is Nothing, otherwise it returns a Promise that will resolve to the value inside this

    +

    Parameters

    • defaultValue: T

    Returns Promise<T>

  • It's important to remember how run will behave because in an async context there are other ways for a function to fail other than to return a Nothing, for example: If any of the computations inside MaybeAsync resolved to Nothing, @@ -518,227 +41,6 @@

    -
-
- -
    - -
  • -

    Converts this to a EitherAsync with a default error value

    -
    -
    -

    Type Parameters

    -
      -
    • -

      L

    -
    -

    Parameters

    -
      -
    • -
      error: L
    -

    Returns functional.EitherAsync<L, T>

    -
-
- -
    - -
  • -

    Useful if you are not interested in the result of an operation

    -
    -

    Returns functional.MaybeAsync<void>

    -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Returns Promise<functional.Maybe<T>>

  • Converts this to a EitherAsync with a default error value

    +

    Type Parameters

    • L

    Parameters

    • error: L

    Returns functional.EitherAsync<L, T>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.MaybeAsyncTypeRef.html b/interfaces/functional.MaybeAsyncTypeRef.html index 3fd6241..b441a9a 100644 --- a/interfaces/functional.MaybeAsyncTypeRef.html +++ b/interfaces/functional.MaybeAsyncTypeRef.html @@ -1,306 +1,8 @@ -MaybeAsyncTypeRef | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface MaybeAsyncTypeRef

-
-

Hierarchy

-
    -
  • MaybeAsyncTypeRef
-
-
    - -
  • -

    Constructs a MaybeAsync object from a function that takes an object full of helpers that let you lift things into the MaybeAsync context and returns a Promise

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
      -
    • -
      runPromise: ((helpers) => PromiseLike<T>)
      -
        -
      • -
          -
        • (helpers): PromiseLike<T>
        • -
        • -
          -

          Parameters

          -
            -
          • -
            helpers: MaybeAsyncHelpers
          -

          Returns PromiseLike<T>

    -

    Returns functional.MaybeAsync<T>

    -
-
-
-
- -
-
-

Methods

-
catMaybes +MaybeAsyncTypeRef | @telostat/prelude - v0.5.0

Hierarchy

  • MaybeAsyncTypeRef
  • Constructs a MaybeAsync object from a function that takes an object full of helpers that let you lift things into the MaybeAsync context and returns a Promise

    +

    Type Parameters

    • T

    Parameters

    • runPromise: ((helpers) => PromiseLike<T>)
        • (helpers): PromiseLike<T>
        • Parameters

          • helpers: MaybeAsyncHelpers

          Returns PromiseLike<T>

    Returns functional.MaybeAsync<T>

-
-

Methods

-
- -
    - -
  • -

    Takes a list of MaybeAsyncs and returns a Promise that will resolve with all Just values. Internally it uses Promise.all to wait for all results

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Parameters

    -
    -

    Returns Promise<T[]>

    -
-
- -
-
- -
-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Methods

  • Takes a list of MaybeAsyncs and returns a Promise that will resolve with all Just values. Internally it uses Promise.all to wait for all results

    +

    Type Parameters

    • T

    Parameters

    Returns Promise<T[]>

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/functional.NonEmptyList.html b/interfaces/functional.NonEmptyList.html index 3c51f99..dac535b 100644 --- a/interfaces/functional.NonEmptyList.html +++ b/interfaces/functional.NonEmptyList.html @@ -1,49 +1,7 @@ -NonEmptyList | @telostat/prelude - v0.4.1
-
- -
-
-
-
- -

Interface NonEmptyList<T>

-
-

Type Parameters

-
    -
  • -

    T

-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
0 +NonEmptyList | @telostat/prelude - v0.5.0

Type Parameters

  • T

Hierarchy

-
-

Properties

-
- -
0: T
-
- -
[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    findLast?: any;
    findLastIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toString?: any;
    unshift?: any;
    values?: any;
}
-

Is an object whose properties have the value 'true' +with +

Properties

0: T
[unscopables]: {
    [unscopables]?: boolean;
    length?: boolean;
    [iterator]?: any;
    at?: any;
    concat?: any;
    copyWithin?: any;
    entries?: any;
    every?: any;
    fill?: any;
    filter?: any;
    find?: any;
    findIndex?: any;
    findLast?: any;
    findLastIndex?: any;
    flat?: any;
    flatMap?: any;
    forEach?: any;
    includes?: any;
    indexOf?: any;
    join?: any;
    keys?: any;
    lastIndexOf?: any;
    map?: any;
    pop?: any;
    push?: any;
    reduce?: any;
    reduceRight?: any;
    reverse?: any;
    shift?: any;
    slice?: any;
    some?: any;
    sort?: any;
    splice?: any;
    toLocaleString?: any;
    toReversed?: any;
    toSorted?: any;
    toSpliced?: any;
    toString?: any;
    unshift?: any;
    values?: any;
    with?: any;
}

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

-
-
-

Type declaration

-
    -
  • -
    Optional Readonly [unscopables]?: boolean
    -

    Is an object whose properties have the value 'true' +

    Type declaration

    • Optional Readonly [unscopables]?: boolean

      Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

      -
      -
    • -
    • -
      Optional length?: boolean
      -

      Gets or sets the length of the array. This is a number one higher than the highest index in the array.

      -
      -
    -
-
- -
length: number
-

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

-
-
-
-

Methods

-
- -
    - -
  • -

    Iterator

    -
    -

    Returns IterableIterator<T>

    -
-
- -
    - -
  • -

    Returns the item located at the specified index.

    -
    -
    -

    Parameters

    -
      -
    • -
      index: number
      -

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

      -
      -
    -

    Returns undefined | T

    -
-
- -
    - -
  • -
    -

    Parameters

    -
      -
    • -
      Rest ...items: ConcatArray<T>[]
    -

    Returns functional.NonEmptyList<T>

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      Rest ...items: (T | ConcatArray<T>)[]
    -

    Returns functional.NonEmptyList<T>

-
- -
    - -
  • -

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

  • Optional length?: boolean

    Gets or sets the length of the array. This is a number one higher than the highest index in the array.

    +
length: number

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

+

Methods

  • Iterator

    +

    Returns IterableIterator<T>

  • Returns the item located at the specified index.

    +

    Parameters

    • index: number

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

      +

    Returns undefined | T

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

      Parameters

      • target: number

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

        -
        -
      • -
      • -
        Optional start: number
        -

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

        -
        -
      • -
      • -
        Optional end: number
        -

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

        -
        -
      -

      Returns functional.NonEmptyList<T>

      -
-
- -
    - -
  • -

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

    -
    -

    Returns IterableIterator<[number, T]>

    -
-
- -
    - -
  • -

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

    -
    -
    -

    Type Parameters

    -
      -
    • -

      S

    -
    -

    Parameters

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

      A function that accepts up to three arguments. The every method calls +

    • 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 functional.NonEmptyList<T>

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

    +

    Returns IterableIterator<[number, T]>

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

    +

    Type Parameters

    • S

    Parameters

    • predicate: ((value, index, array) => value is S)

      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): value is S
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns value is S

    • -
    • -
      Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. +

        • (value, index, array): value is S
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns value is S

    • 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 this is S[]

    -
  • - -
  • -

    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 +

    Returns this is S[]

  • 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: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns unknown

    • -
    • -
      Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. +

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

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

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

      -
      -
    -

    Returns boolean

    -
-
- -
    - -
  • -

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

    -
    -
    -

    Parameters

    -
      -
    • -
      value: T
      -

      value to fill array section with

      -
      -
    • -
    • -
      Optional start: number
      -

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

    Returns boolean

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

    +

    Parameters

    • value: T

      value to fill array section with

      +
    • Optional start: number

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

      -
      -
    • -
    • -
      Optional end: number
      -

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

    • Optional end: number

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

      -
      -
    -

    Returns functional.NonEmptyList<T>

    -
-
- -
    - -
  • -

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

    -
    -
    -

    Type Parameters

    -
      -
    • -

      S

    -
    -

    Parameters

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

      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): value is S
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          Returns value is S

    • -
    • -
      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 S[]

    -
  • - -
  • -

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

    -
    -
    -

    Parameters

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

      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): unknown
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          • -
          • -
            index: number
          • -
          • -
            array: T[]
          -

          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 T[]

    -
-
- -
    - -
  • -

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

Returns functional.NonEmptyList<T>

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

    +

    Type Parameters

    • S

    Parameters

    • predicate: ((value, index, array) => value is S)

      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): value is S
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns value is S

    • 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 S[]

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

    +

    Parameters

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

      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): unknown
        • Parameters

          • value: T
          • index: number
          • array: T[]

          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 T[]

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

    -
    -
    -

    Type Parameters

    -
      -
    • -

      S

    -
    -

    Parameters

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

      find calls predicate once for each element of the array, in ascending +

      Type Parameters

      • S

      Parameters

      • predicate: ((value, index, obj) => value is S)

        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): value is S
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            • -
            • -
              index: number
            • -
            • -
              obj: T[]
            -

            Returns value is S

      • -
      • -
        Optional thisArg: any
        -

        If provided, it will be used as the this value for each invocation of +

          • (value, index, obj): value is S
          • Parameters

            • value: T
            • index: number
            • obj: T[]

            Returns value is S

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

      -
    • - -
    • -
      -

      Parameters

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

            Parameters

            -
              -
            • -
              value: T
            • -
            • -
              index: number
            • -
            • -
              obj: T[]
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
      -

      Returns undefined | T

-
- -
    - -
  • -

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

Returns undefined | S

  • Parameters

    • predicate: ((value, index, obj) => unknown)
        • (value, index, obj): unknown
        • Parameters

          • value: T
          • index: number
          • obj: T[]

          Returns unknown

    • Optional thisArg: any

    Returns undefined | T

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

      -
      -
      -

      Parameters

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

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value, index, obj) => unknown)

          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): unknown
            • -
            • -
              -

              Parameters

              -
                -
              • -
                value: T
              • -
              • -
                index: number
              • -
              • -
                obj: T[]
              -

              Returns unknown

        • -
        • -
          Optional thisArg: any
          -

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): unknown
            • Parameters

              • value: T
              • index: number
              • obj: T[]

              Returns unknown

        • 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

        -
    -
    - -
      - -
    • -

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

    Returns number

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

      -
      -
      -

      Type Parameters

      -
        -
      • -

        S

      -
      -

      Parameters

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

        findLast calls predicate once for each element of the array, in descending +

        Type Parameters

        • S

        Parameters

        • predicate: ((value, index, array) => value is S)

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

          -
          -
          -
            -
          • -
              -
            • (value, index, array): value is S
            • -
            • -
              -

              Parameters

              -
                -
              • -
                value: T
              • -
              • -
                index: number
              • -
              • -
                array: T[]
              -

              Returns value is S

        • -
        • -
          Optional thisArg: any
          -

          If provided, it will be used as the this value for each invocation of +

            • (value, index, array): value is S
            • Parameters

              • value: T
              • index: number
              • array: T[]

              Returns value is S

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

        -
      • - -
      • -
        -

        Parameters

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

              Parameters

              -
                -
              • -
                value: T
              • -
              • -
                index: number
              • -
              • -
                array: T[]
              -

              Returns unknown

        • -
        • -
          Optional thisArg: any
        -

        Returns undefined | T

    -
    - -
      - -
    • -

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

    Returns undefined | S

  • Parameters

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

          • value: T
          • index: number
          • array: T[]

          Returns unknown

    • Optional thisArg: any

    Returns undefined | T

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

      -
      -
      -

      Parameters

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

        findLastIndex calls predicate once for each element of the array, in descending +

        Parameters

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

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

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

              Parameters

              -
                -
              • -
                value: T
              • -
              • -
                index: number
              • -
              • -
                array: T[]
              -

              Returns unknown

        • -
        • -
          Optional thisArg: any
          -

          If provided, it will be used as the this value for each invocation of +

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

              • value: T
              • index: number
              • array: T[]

              Returns unknown

        • 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

        -
    -
    - -
      - -
    • -

      Returns a new array with all sub-array elements concatenated into it recursively up to the +

    Returns number

    • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        A

      • -
      • -

        D extends number = 1

      -
      -

      Parameters

      -
        -
      • -
        this: A
      • -
      • -
        Optional depth: D
        -

        The maximum recursion depth

        -
        -
      -

      Returns FlatArray<A, D>[]

      -
    -
    - -
      - -
    • -

      Calls a defined callback function on each element of an array. Then, flattens the result into +

      Type Parameters

      • A

      • D extends number = 1

      Parameters

      • this: A
      • Optional depth: D

        The maximum recursion depth

        +

      Returns FlatArray<A, D>[]

    • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      • -
      • -

        This = undefined

      -
      -

      Parameters

      -
        -
      • -
        callback: ((this, value, index, array) => U | readonly U[])
        -

        A function that accepts up to three arguments. The flatMap method calls the +

        Type Parameters

        • U

        • This = undefined

        Parameters

        • callback: ((this, value, index, array) => U | readonly U[])

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

          -
          -
          -
            -
          • -
              -
            • (this, value, index, array): U | readonly U[]
            • -
            • -
              -

              Parameters

              -
                -
              • -
                this: This
              • -
              • -
                value: T
              • -
              • -
                index: number
              • -
              • -
                array: T[]
              -

              Returns U | readonly U[]

        • -
        • -
          Optional thisArg: This
          -

          An object to which the this keyword can refer in the callback function. If +

            • (this, value, index, array): U | readonly U[]
            • Parameters

              • this: This
              • value: T
              • index: number
              • array: T[]

              Returns U | readonly U[]

        • Optional thisArg: This

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

          -
          -
        -

        Returns U[]

        -
    -
    - -
      - -
    • -

      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: T
            • -
            • -
              index: number
            • -
            • -
              array: T[]
            -

            Returns void

      • -
      • -
        Optional thisArg: any
        -

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

        -
        -
      -

      Returns void

      -
    -
    - -
      - -
    • -

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

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: T
        -

        The element to search for.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

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

        -
        -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: T
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

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

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

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

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional separator: string
        -

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

        -
        -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns an iterable of keys in the array

      -
      -

      Returns IterableIterator<number>

      -
    -
    - -
      - -
    • -

      Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      -
      -
      -

      Parameters

      -
        -
      • -
        searchElement: T
        -

        The value to locate in the array.

        -
        -
      • -
      • -
        Optional fromIndex: number
        -

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

      -
        -
      • -
        this: functional.NonEmptyList<T>
      • -
      • -
        callbackfn: ((value, index, array) => U)
        -
          -
        • -
            -
          • (value, index, array): U
          • -
          • -
            -

            Parameters

            -
            -

            Returns U

      • -
      • -
        Optional thisArg: any
      -

      Returns functional.NonEmptyList<U>

    -
    - -
      - -
    • -

      Removes the last element from an array and returns it. +

    Returns U[]

    • 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: T
            • index: number
            • array: T[]

            Returns void

      • Optional thisArg: any

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

        +

      Returns void

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

      +

      Parameters

      • searchElement: T

        The element to search for.

        +
      • Optional fromIndex: number

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

        +

      Returns boolean

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      +

      Parameters

      • searchElement: T

        The value to locate in the array.

        +
      • Optional fromIndex: number

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

        +

      Returns number

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

      +

      Parameters

      • Optional separator: string

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

        +

      Returns string

    • Returns an iterable of keys in the array

      +

      Returns IterableIterator<number>

    • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

      +

      Parameters

      • searchElement: T

        The value to locate in the array.

        +
      • Optional fromIndex: number

        The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

        +

      Returns number

    • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

      -
      -

      Returns undefined | T

      -
    -
    - -
      - -
    • -

      Appends new elements to the end of an array, and returns the new length of the array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...items: T[]
        -

        New elements to add to the array.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

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

      -
      -
      -

      Parameters

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

        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): T
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: T
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            Returns T

      -

      Returns T

      -
    • - -
    • -
      -

      Parameters

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

            Parameters

            -
              -
            • -
              previousValue: T
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            Returns T

      • -
      • -
        initialValue: T
      -

      Returns T

    • - -
    • -

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

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

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

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

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

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            Returns U

      • -
      • -
        initialValue: U
        -

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

        -
        -
      -

      Returns U

      -
    -
    - -
      - -
    • -

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

      -
      -
      -

      Parameters

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

        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): T
          • -
          • -
            -

            Parameters

            -
              -
            • -
              previousValue: T
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            Returns T

      -

      Returns T

      -
    • - -
    • -
      -

      Parameters

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

            Parameters

            -
              -
            • -
              previousValue: T
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            Returns T

      • -
      • -
        initialValue: T
      -

      Returns T

    • - -
    • -

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

      -
      -
      -

      Type Parameters

      -
        -
      • -

        U

      -
      -

      Parameters

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

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

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

            Parameters

            -
              -
            • -
              previousValue: U
            • -
            • -
              currentValue: T
            • -
            • -
              currentIndex: number
            • -
            • -
              array: T[]
            -

            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

      -
    -
    - -
    -
    - -
      - -
    • -

      Removes the first element from an array and returns it. +

      Returns undefined | T

    • Appends new elements to the end of an array, and returns the new length of the array.

      +

      Parameters

      • Rest ...items: T[]

        New elements to add to the array.

        +

      Returns number

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

      +

      Parameters

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

        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): T
          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      Returns T

    • Parameters

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

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      • initialValue: T

      Returns T

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

      +

      Type Parameters

      • U

      Parameters

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

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

        +
          • (previousValue, currentValue, currentIndex, array): U
          • Parameters

            • previousValue: U
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns U

      • initialValue: U

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

        +

      Returns U

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

      +

      Parameters

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

        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): T
          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      Returns T

    • Parameters

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

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      • initialValue: T

      Returns T

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

      +

      Type Parameters

      • U

      Parameters

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

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

        +
          • (previousValue, currentValue, currentIndex, array): U
          • Parameters

            • previousValue: U
            • currentValue: T
            • currentIndex: number
            • array: T[]

            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

    • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

      -
      -

      Returns undefined | T

      -
    -
    - -
      - -
    • -

      Returns a copy of a section of an array. +

      Returns undefined | T

    • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Optional start: number
        -

        The beginning index of the specified portion of the array. +

        Parameters

        • Optional start: number

          The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

          -
          -
        • -
        • -
          Optional end: number
          -

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

        • Optional end: number

          The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

          -
          -
        -

        Returns T[]

        -
    -
    - -
      - -
    • -

      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 +

      Returns T[]

    • 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: T
            • -
            • -
              index: number
            • -
            • -
              array: T[]
            -

            Returns unknown

      • -
      • -
        Optional thisArg: any
        -

        An object to which the this keyword can refer in the predicate function. +

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

            • value: T
            • index: number
            • array: T[]

            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

      -
    -
    - -

    Returns boolean

    • Sorts an array in place. This method mutates the array and returns a reference to the same array.

      -
      -
      -

      Parameters

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

        Function used to determine the order of the elements. It is expected to return +

        Parameters

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

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

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

              Parameters

              -
                -
              • -
                a: T
              • -
              • -
                b: T
              -

              Returns number

        -

        Returns functional.NonEmptyList<T>

        -
    -
    - -
      - -
    • -

      Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      -
      -
      -

      Parameters

      -
        -
      • -
        start: number
        -

        The zero-based location in the array from which to start removing elements.

        -
        -
      • -
      • -
        Optional deleteCount: number
        -

        The number of elements to remove.

        -
        -
      -

      Returns T[]

      An array containing the elements that were deleted.

      - -
    • - -
    • -

      Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      -
      -
      -

      Parameters

      -
        -
      • -
        start: number
        -

        The zero-based location in the array from which to start removing elements.

        -
        -
      • -
      • -
        deleteCount: number
        -

        The number of elements to remove.

        -
        -
      • -
      • -
        Rest ...items: T[]
        -

        Elements to insert into the array in place of the deleted elements.

        -
        -
      -

      Returns T[]

      An array containing the elements that were deleted.

      - -
    -
    - -
      - -
    • -

      Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Returns a string representation of an array.

      -
      -

      Returns string

      -
    -
    - -
      - -
    • -

      Inserts new elements at the start of an array, and returns the new length of the array.

      -
      -
      -

      Parameters

      -
        -
      • -
        Rest ...items: T[]
        -

        Elements to insert at the start of the array.

        -
        -
      -

      Returns number

      -
    -
    - -
      - -
    • -

      Returns an iterable of values in the array

      -
      -

      Returns IterableIterator<T>

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +
      • (a, b): number
      • Parameters

        • a: T
        • b: T

        Returns number

    Returns functional.NonEmptyList<T>

    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      +

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

        +
      • Optional deleteCount: number

        The number of elements to remove.

        +

      Returns T[]

      An array containing the elements that were deleted.

      +
    • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

      +

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

        +
      • deleteCount: number

        The number of elements to remove.

        +
      • Rest ...items: T[]

        Elements to insert into the array in place of the deleted elements.

        +

      Returns T[]

      An array containing the elements that were deleted.

      +
    • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

      +

      Returns string

    • Returns a copy of an array with its elements reversed.

      +

      Returns T[]

    • Returns a copy of an array with its elements sorted.

      +

      Parameters

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

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

        +
        [11, 2, 22, 1].toSorted((a, b) => a - b) // [1, 2, 11, 22]
        +
        +
          • (a, b): number
          • Parameters

            • a: T
            • b: T

            Returns number

      Returns T[]

    • Copies an array and removes elements and, if necessary, inserts new elements in their place. Returns the copied array.

      +

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

        +
      • deleteCount: number

        The number of elements to remove.

        +
      • Rest ...items: T[]

        Elements to insert into the copied array in place of the deleted elements.

        +

      Returns T[]

      The copied array.

      +
    • Copies an array and removes elements while returning the remaining elements.

      +

      Parameters

      • start: number

        The zero-based location in the array from which to start removing elements.

        +
      • Optional deleteCount: number

        The number of elements to remove.

        +

      Returns T[]

      A copy of the original array with the remaining elements.

      +
    • Returns a string representation of an array.

      +

      Returns string

    • Inserts new elements at the start of an array, and returns the new length of the array.

      +

      Parameters

      • Rest ...items: T[]

        Elements to insert at the start of the array.

        +

      Returns number

    • Returns an iterable of values in the array

      +

      Returns IterableIterator<T>

    • Copies an array, then overwrites the value at the provided index with the +given value. If the index is negative, then it replaces from the end +of the array.

      +

      Parameters

      • index: number

        The index of the value to overwrite. If the index is +negative, then it replaces from the end of the array.

        +
      • value: T

        The value to write into the copied array.

        +

      Returns T[]

      The copied array with the updated value.

      +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/functional.NonEmptyListTypeRef.html b/interfaces/functional.NonEmptyListTypeRef.html index c2799b4..10d9713 100644 --- a/interfaces/functional.NonEmptyListTypeRef.html +++ b/interfaces/functional.NonEmptyListTypeRef.html @@ -1,383 +1,16 @@ -NonEmptyListTypeRef | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Interface NonEmptyListTypeRef

    -
    -

    Hierarchy

    -
      -
    • NonEmptyListTypeRef
    -
    -
      - -
    • -

      Typecasts an array with at least one element into a NonEmptyList. Works only if the compiler can confirm that the array has one or more elements

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T extends T[number][] & {
            0: T[number];
        }

      -
      -

      Parameters

      -
        -
      • -
        list: T
      -

      Returns functional.NonEmptyList<T[number]>

      -
    -
    -
    -
    - -
    -
    -

    Methods

    -
    fromArray +NonEmptyListTypeRef | @telostat/prelude - v0.5.0

    Hierarchy

    • NonEmptyListTypeRef
    • Typecasts an array with at least one element into a NonEmptyList. Works only if the compiler can confirm that the array has one or more elements

      +

      Type Parameters

      Parameters

      • list: T

      Returns functional.NonEmptyList<T[number]>

    -
    -

    Methods

    -
    - -
    -
    - -
    -
    - -
      - -
    • -

      The same function as List#head, but it doesn't return a Maybe as a NonEmptyList will always have a head

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
      -

      Returns T

      -
    -
    - -
      - -
    • -

      Returns true and narrows the type if the passed array has one or more elements

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        list: readonly T[]
      -

      Returns list is functional.NonEmptyList<T>

      -
    -
    - -
      - -
    • -

      The same function as List#last, but it doesn't return a Maybe as a NonEmptyList will always have a last element

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
      -

      Returns T

      -
    -
    - -
      - -
    • -

      The same function as List#tail, but it doesn't return a Maybe as a NonEmptyList will always have a tail (although it may be of length 0)

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
      -

      Returns T[]

      -
    -
    - -
      - -
    • -

      Typecasts any array into a NonEmptyList, but throws an exception if the array is empty. Use fromArray as a safe alternative

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        source: readonly T[]
      -

      Returns functional.NonEmptyList<T>

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    • The same function as List#head, but it doesn't return a Maybe as a NonEmptyList will always have a head

      +

      Type Parameters

      • T

      Parameters

      Returns T

    • Returns true and narrows the type if the passed array has one or more elements

      +

      Type Parameters

      • T

      Parameters

      • list: readonly T[]

      Returns list is functional.NonEmptyList<T>

    • The same function as List#last, but it doesn't return a Maybe as a NonEmptyList will always have a last element

      +

      Type Parameters

      • T

      Parameters

      Returns T

    • The same function as List#tail, but it doesn't return a Maybe as a NonEmptyList will always have a tail (although it may be of length 0)

      +

      Type Parameters

      • T

      Parameters

      Returns T[]

    • Typecasts any array into a NonEmptyList, but throws an exception if the array is empty. Use fromArray as a safe alternative

      +

      Type Parameters

      • T

      Parameters

      • source: readonly T[]

      Returns functional.NonEmptyList<T>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/functional.Tuple.html b/interfaces/functional.Tuple.html index bba1468..f782997 100644 --- a/interfaces/functional.Tuple.html +++ b/interfaces/functional.Tuple.html @@ -1,55 +1,7 @@ -Tuple | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Interface Tuple<F, S>

    -
    -

    Type Parameters

    -
      -
    • -

      F

    • -
    • -

      S

    -
    -

    Hierarchy

    -
      -
    • Iterable<F | S>
    • -
    • ArrayLike<F | S> -
        -
      • Tuple
    -
    -

    Indexable

    -
    [index: number]: F | S
    -
    -
    -
    - -
    -
    -

    Properties

    -
    0 +Tuple | @telostat/prelude - v0.5.0

    Type Parameters

    • F

    • S

    Hierarchy

    • Iterable<F | S>
    • ArrayLike<F | S>
      • Tuple

    Indexable

    [index: number]: F | S

    Properties

    -
    -

    Methods

    -

    Methods

    [iterator] ap bimap equals @@ -70,672 +22,16 @@

    Methods

    toArray toJSON toString -
    -
    -

    Properties

    -
    - -
    0: F
    -
    - -
    1: S
    -
    - -
    length: 2
    -
    -

    Methods

    -
    - -
      - -
    • -

      Returns Iterator<F | S, any, undefined>

    -
    - -
      - -
    • -

      Applies the second value of a tuple to the second value of this

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      • -
      • -

        S2

      -
      -

      Parameters

      -
      -

      Returns functional.Tuple<F, S2>

      -
    -
    - -
      - -
    • -

      Transforms the two values inside this with two mapper functions

      -
      -
      -

      Type Parameters

      -
        -
      • -

        F2

      • -
      • -

        S2

      -
      -

      Parameters

      -
        -
      • -
        f: ((fst) => F2)
        -
          -
        • -
            -
          • (fst): F2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              fst: F
            -

            Returns F2

      • -
      • -
        g: ((snd) => S2)
        -
          -
        • -
            -
          • (snd): S2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              snd: S
            -

            Returns S2

      -

      Returns functional.Tuple<F2, S2>

      -
    -
    - -
      - -
    • -

      Compares the values inside this and another tuple

      -
      -
      -

      Parameters

      -
      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Tests whether both elements in the tuple pass the test implemented by the provided function

      -
      -
      -

      Parameters

      -
        -
      • -
        pred: ((value) => boolean)
        -
          -
        • -
            -
          • (value): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: F | S
            -

            Returns boolean

      -

      Returns boolean

      -
    -
    - -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        T

      • -
      • -

        S2

      -
      -

      Parameters

      -
      -

      Returns functional.Tuple<F, S2>

    -
    - -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        F2

      • -
      • -

        S2

      -
      -

      Parameters

      -
        -
      • -
        f: ((fst) => F2)
        -
          -
        • -
            -
          • (fst): F2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              fst: F
            -

            Returns F2

      • -
      • -
        g: ((snd) => S2)
        -
          -
        • -
            -
          • (snd): S2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              snd: S
            -

            Returns S2

      -

      Returns functional.Tuple<F2, S2>

    -
    - -
      - -
    • -
      -

      Parameters

      -
      -

      Returns boolean

    -
    - -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        S2

      -
      -

      Parameters

      -
        -
      • -
        f: ((snd) => S2)
        -
          -
        • -
            -
          • (snd): S2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              snd: S
            -

            Returns S2

      -

      Returns functional.Tuple<F, S2>

    -
    - -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        reducer: ((accumulator, value) => T)
        -
          -
        • -
            -
          • (accumulator, value): T
          • -
          • -
            -

            Parameters

            -
              -
            • -
              accumulator: T
            • -
            • -
              value: S
            -

            Returns T

      • -
      • -
        initialValue: T
      -

      Returns T

    -
    - -
      - -
    • -

      Returns the first value of this

      -
      -

      Returns F

      -
    -
    - -
      - -
    • -

      Returns string

    -
    - -
      - -
    • -

      Applies a function to the second value of this

      -
      -
      -

      Type Parameters

      -
        -
      • -

        S2

      -
      -

      Parameters

      -
        -
      • -
        f: ((snd) => S2)
        -
          -
        • -
            -
          • (snd): S2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              snd: S
            -

            Returns S2

      -

      Returns functional.Tuple<F, S2>

      -
    -
    - -
      - -
    • -

      Applies a function to the first value of this

      -
      -
      -

      Type Parameters

      -
        -
      • -

        F2

      -
      -

      Parameters

      -
        -
      • -
        f: ((fst) => F2)
        -
          -
        • -
            -
          • (fst): F2
          • -
          • -
            -

            Parameters

            -
              -
            • -
              fst: F
            -

            Returns F2

      -

      Returns functional.Tuple<F2, S>

      -
    -
    - -
      - -
    • -

      A somewhat arbitrary implementation of Foldable for Tuple, the reducer will be passed the initial value and the second value inside this as arguments

      -
      -
      -

      Type Parameters

      -
        -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        reducer: ((accumulator, value) => T)
        -
          -
        • -
            -
          • (accumulator, value): T
          • -
          • -
            -

            Parameters

            -
              -
            • -
              accumulator: T
            • -
            • -
              value: S
            -

            Returns T

      • -
      • -
        initialValue: T
      -

      Returns T

      -
    -
    - -
      - -
    • -

      Returns the second value of this

      -
      -

      Returns S

      -
    -
    - -
      - -
    • -

      Tests whether at least one element in the tuple passes the test implemented by the provided function

      -
      -
      -

      Parameters

      -
        -
      • -
        pred: ((value) => boolean)
        -
          -
        • -
            -
          • (value): boolean
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: F | S
            -

            Returns boolean

      -

      Returns boolean

      -
    -
    - -
      - -
    • -

      Swaps the values inside this

      -
      -

      Returns functional.Tuple<S, F>

      -
    -
    - -
      - -
    • -

      Returns an array with 2 elements - the values inside this

      -
      -

      Returns [F, S]

      -
    -
    - -
      - -
    • -

      Returns [F, S]

    -
    - -
      - -
    • -

      Returns string

    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    0: F
    1: S
    length: 2

    Methods

    • Returns Iterator<F | S, any, undefined>

    • Applies the second value of a tuple to the second value of this

      +

      Type Parameters

      • T

      • S2

      Parameters

      Returns functional.Tuple<F, S2>

    • Transforms the two values inside this with two mapper functions

      +

      Type Parameters

      • F2

      • S2

      Parameters

      • f: ((fst) => F2)
          • (fst): F2
          • Parameters

            • fst: F

            Returns F2

      • g: ((snd) => S2)
          • (snd): S2
          • Parameters

            • snd: S

            Returns S2

      Returns functional.Tuple<F2, S2>

    • Compares the values inside this and another tuple

      +

      Parameters

      Returns boolean

    • Tests whether both elements in the tuple pass the test implemented by the provided function

      +

      Parameters

      • pred: ((value) => boolean)
          • (value): boolean
          • Parameters

            • value: F | S

            Returns boolean

      Returns boolean

    • Type Parameters

      • F2

      • S2

      Parameters

      • f: ((fst) => F2)
          • (fst): F2
          • Parameters

            • fst: F

            Returns F2

      • g: ((snd) => S2)
          • (snd): S2
          • Parameters

            • snd: S

            Returns S2

      Returns functional.Tuple<F2, S2>

    • Parameters

      Returns boolean

    • Type Parameters

      • S2

      Parameters

      • f: ((snd) => S2)
          • (snd): S2
          • Parameters

            • snd: S

            Returns S2

      Returns functional.Tuple<F, S2>

    • Type Parameters

      • T

      Parameters

      • reducer: ((accumulator, value) => T)
          • (accumulator, value): T
          • Parameters

            • accumulator: T
            • value: S

            Returns T

      • initialValue: T

      Returns T

    • Returns the first value of this

      +

      Returns F

    • Returns string

    • Applies a function to the second value of this

      +

      Type Parameters

      • S2

      Parameters

      • f: ((snd) => S2)
          • (snd): S2
          • Parameters

            • snd: S

            Returns S2

      Returns functional.Tuple<F, S2>

    • Applies a function to the first value of this

      +

      Type Parameters

      • F2

      Parameters

      • f: ((fst) => F2)
          • (fst): F2
          • Parameters

            • fst: F

            Returns F2

      Returns functional.Tuple<F2, S>

    • A somewhat arbitrary implementation of Foldable for Tuple, the reducer will be passed the initial value and the second value inside this as arguments

      +

      Type Parameters

      • T

      Parameters

      • reducer: ((accumulator, value) => T)
          • (accumulator, value): T
          • Parameters

            • accumulator: T
            • value: S

            Returns T

      • initialValue: T

      Returns T

    • Returns the second value of this

      +

      Returns S

    • Tests whether at least one element in the tuple passes the test implemented by the provided function

      +

      Parameters

      • pred: ((value) => boolean)
          • (value): boolean
          • Parameters

            • value: F | S

            Returns boolean

      Returns boolean

    • Returns an array with 2 elements - the values inside this

      +

      Returns [F, S]

    • Returns [F, S]

    • Returns string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/functional.TupleTypeRef.html b/interfaces/functional.TupleTypeRef.html index 4636f18..221c0d0 100644 --- a/interfaces/functional.TupleTypeRef.html +++ b/interfaces/functional.TupleTypeRef.html @@ -1,419 +1,5 @@ -TupleTypeRef | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Interface TupleTypeRef

    -
    -

    Hierarchy

    -
      -
    • TupleTypeRef
    -
    -
      - -
    • -
      -

      Type Parameters

      -
        -
      • -

        F

      • -
      • -

        S

      -
      -

      Parameters

      -
        -
      • -
        fst: F
      • -
      • -
        snd: S
      -

      Returns functional.Tuple<F, S>

    -
    -
    -
    - -
    -
    -

    Methods

    -
    fanout +TupleTypeRef | @telostat/prelude - v0.5.0

    Hierarchy

    • TupleTypeRef
    • Type Parameters

      • F

      • S

      Parameters

      • fst: F
      • snd: S

      Returns functional.Tuple<F, S>

    Methods

    -
    -

    Methods

    -
    - -
      - -
    • -

      Applies two functions over a single value and constructs a tuple from the results

      -
      -
      -

      Type Parameters

      -
        -
      • -

        F

      • -
      • -

        S

      • -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        f: ((value) => F)
        -
          -
        • -
            -
          • (value): F
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            -

            Returns F

      • -
      • -
        g: ((value) => S)
        -
          -
        • -
            -
          • (value): S
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            -

            Returns S

      • -
      • -
        value: T
      -

      Returns functional.Tuple<F, S>

      -
    • - -
    • -
      -

      Type Parameters

      -
        -
      • -

        F

      • -
      • -

        S

      • -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        f: ((value) => F)
        -
          -
        • -
            -
          • (value): F
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            -

            Returns F

      • -
      • -
        g: ((value) => S)
        -
          -
        • -
            -
          • (value): S
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            -

            Returns S

      -

      Returns ((value) => functional.Tuple<F, S>)

      -
    • - -
    • -
      -

      Type Parameters

      -
        -
      • -

        F

      • -
      • -

        T

      -
      -

      Parameters

      -
        -
      • -
        f: ((value) => F)
        -
          -
        • -
            -
          • (value): F
          • -
          • -
            -

            Parameters

            -
              -
            • -
              value: T
            -

            Returns F

      -

      Returns (<S>(g) => ((value) => functional.Tuple<F, S>))

      -
        -
      • -
          -
        • <S>(g): ((value) => functional.Tuple<F, S>)
        • -
        • -
          -

          Type Parameters

          -
            -
          • -

            S

          -
          -

          Parameters

          -
            -
          • -
            g: ((value) => S)
            -
              -
            • -
                -
              • (value): S
              • -
              • -
                -

                Parameters

                -
                  -
                • -
                  value: T
                -

                Returns S

          -

          Returns ((value) => functional.Tuple<F, S>)

          -
    -
    - -
      - -
    • -

      Constructs a tuple from an array with two elements

      -
      -
      -

      Type Parameters

      -
        -
      • -

        F

      • -
      • -

        S

      -
      -

      Parameters

      -
        -
      • -
        __namedParameters: [F, S]
      -

      Returns functional.Tuple<F, S>

      -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Methods

    • Applies two functions over a single value and constructs a tuple from the results

      +

      Type Parameters

      • F

      • S

      • T

      Parameters

      • f: ((value) => F)
          • (value): F
          • Parameters

            • value: T

            Returns F

      • g: ((value) => S)
          • (value): S
          • Parameters

            • value: T

            Returns S

      • value: T

      Returns functional.Tuple<F, S>

    • Type Parameters

      • F

      • S

      • T

      Parameters

      • f: ((value) => F)
          • (value): F
          • Parameters

            • value: T

            Returns F

      • g: ((value) => S)
          • (value): S
          • Parameters

            • value: T

            Returns S

      Returns ((value) => functional.Tuple<F, S>)

    • Type Parameters

      • F

      • T

      Parameters

      • f: ((value) => F)
          • (value): F
          • Parameters

            • value: T

            Returns F

      Returns (<S>(g) => ((value) => functional.Tuple<F, S>))

    • Constructs a tuple from an array with two elements

      +

      Type Parameters

      • F

      • S

      Parameters

      • __namedParameters: [F, S]

      Returns functional.Tuple<F, S>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/numeric.Decimal.Config.html b/interfaces/numeric.Decimal.Config.html index ff60a0b..6939825 100644 --- a/interfaces/numeric.Decimal.Config.html +++ b/interfaces/numeric.Decimal.Config.html @@ -1,36 +1,4 @@ -Config | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Interface Config

    -
    -

    Hierarchy

    -
      -
    • Config
    -
    -
    -
    - -
    -
    -

    Properties

    -
    crypto? +Config | @telostat/prelude - v0.5.0

    Hierarchy

    • Config

    Properties

    crypto? defaults? maxE? minE? @@ -39,191 +7,4 @@

    Properties

    rounding? toExpNeg? toExpPos? -
    -
    -

    Properties

    -
    - -
    crypto?: boolean
    -
    - -
    defaults?: boolean
    -
    - -
    maxE?: number
    -
    - -
    minE?: number
    -
    - -
    modulo?: Modulo
    -
    - -
    precision?: number
    -
    - -
    rounding?: Rounding
    -
    - -
    toExpNeg?: number
    -
    - -
    toExpPos?: number
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    crypto?: boolean
    defaults?: boolean
    maxE?: number
    minE?: number
    modulo?: Modulo
    precision?: number
    rounding?: Rounding
    toExpNeg?: number
    toExpPos?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/temporal.SDateRange.html b/interfaces/temporal.SDateRange.html index abeeab5..54786b3 100644 --- a/interfaces/temporal.SDateRange.html +++ b/interfaces/temporal.SDateRange.html @@ -1,171 +1,4 @@ -SDateRange | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Interface SDateRange

    -
    -

    Type definition for date range.

    -
    -
    -
    -

    Hierarchy

    -
      -
    • SDateRange
    -
    -
    -
    - -
    -
    -

    Properties

    -
    start +SDateRange | @telostat/prelude - v0.5.0
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Properties

    start: string
    until: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules.html b/modules.html index 2649b98..e999c08 100644 --- a/modules.html +++ b/modules.html @@ -1,447 +1,83 @@ -@telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    -

    @telostat/prelude - v0.4.1

    -
    -
    -
    - -
    -
    -

    References

    -
    -
    -

    Namespaces

    -
    error +@telostat/prelude - v0.5.0

    @telostat/prelude - v0.5.0

    -
    -

    References

    -
    -Re-exports Codec
    -
    -Re-exports CurriedFn
    -
    -Re-exports CustomError
    -
    -Re-exports Decimal
    -
    -Re-exports DecodeError
    -
    -Re-exports Either
    -
    -Re-exports EitherAsync
    -
    -Re-exports EitherAsyncTypeRef
    -
    -Re-exports EitherPatterns
    -
    -Re-exports ExpectedType
    -
    -Re-exports FromType
    -
    -Re-exports GetType
    -
    -Re-exports Just
    -
    -Re-exports Left
    -
    -Re-exports List
    -
    -Re-exports Maybe
    -
    -Re-exports MaybeAsync
    -
    -Re-exports MaybeAsyncTypeRef
    -
    -Re-exports MaybePatterns
    -
    -Re-exports NonEmptyList
    -
    -Re-exports NonEmptyListCompliant
    -
    -Re-exports NonEmptyListTypeRef
    -
    -Re-exports Nothing
    -
    -Re-exports NumericError
    -
    -Re-exports Order
    -
    -Re-exports PivotDate
    -
    -Re-exports ReceivedType
    -
    -Re-exports Right
    -
    -Re-exports SDate
    -
    -Re-exports SDateRange
    -
    -Re-exports SDateTime
    -
    -Re-exports Tuple
    -
    -Re-exports TupleTypeRef
    -
    -Re-exports always
    -
    -Re-exports array
    -
    -Re-exports boolean
    -
    -Re-exports compare
    -
    -Re-exports curry
    -
    -Re-exports customError
    -
    -Re-exports date
    -
    -Re-exports decimal
    -
    -Re-exports decimalFromNullable
    -
    -Re-exports enumeration
    -
    -Re-exports exactly
    -
    -Re-exports getLastWeekday
    -
    -Re-exports getPivotDate
    -
    -Re-exports getToday
    -
    -Re-exports hundred
    -
    -Re-exports identity
    -
    -Re-exports intersect
    -
    -Re-exports isoFormatDate
    -
    -Re-exports isoFormatDateTime
    -
    -Re-exports lazy
    -
    -Re-exports map
    -
    -Re-exports maybe
    -
    -Re-exports nonEmptyList
    -
    -Re-exports nonEmptyText
    -
    -Re-exports notImplemented
    -
    -Re-exports nullType
    -
    -Re-exports nullable
    -
    -Re-exports number
    -
    -Re-exports one
    -
    -Re-exports oneOf
    -
    -Re-exports optional
    -
    -Re-exports orderToNumber
    -
    -Re-exports parseError
    -
    -Re-exports record
    -
    -Re-exports safeDiv
    -
    -Re-exports sanitizeText
    -
    -Re-exports sanitizedNonEmptyText
    -
    -Re-exports string
    -
    -Re-exports sumDecimals
    -
    -Re-exports thousand
    -
    -Re-exports tuple
    -
    -Re-exports unknown
    -
    -Re-exports unsafeDecimal
    -
    -Re-exports zero
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    References

    Re-exports Codec
    Re-exports CurriedFn
    Re-exports CustomError
    Re-exports Decimal
    Re-exports DecodeError
    Re-exports Either
    Re-exports EitherAsync
    Re-exports EitherAsyncTypeRef
    Re-exports EitherPatterns
    Re-exports ExpectedType
    Re-exports FromType
    Re-exports GetType
    Re-exports Just
    Re-exports Left
    Re-exports List
    Re-exports Maybe
    Re-exports MaybeAsync
    Re-exports MaybeAsyncTypeRef
    Re-exports MaybePatterns
    Re-exports NonEmptyList
    Re-exports NonEmptyListCompliant
    Re-exports NonEmptyListTypeRef
    Re-exports Nothing
    Re-exports NumericError
    Re-exports Order
    Re-exports PivotDate
    Re-exports ReceivedType
    Re-exports Right
    Re-exports SDate
    Re-exports SDateRange
    Re-exports SDateTime
    Re-exports Tuple
    Re-exports TupleTypeRef
    Re-exports always
    Re-exports array
    Re-exports boolean
    Re-exports compare
    Re-exports curry
    Re-exports customError
    Re-exports date
    Re-exports decimal
    Re-exports decimalFromNullable
    Re-exports enumeration
    Re-exports exactly
    Re-exports getLastWeekday
    Re-exports getPivotDate
    Re-exports getToday
    Re-exports hundred
    Re-exports identity
    Re-exports intersect
    Re-exports isoFormatDate
    Re-exports isoFormatDateTime
    Re-exports lazy
    Re-exports map
    Re-exports maybe
    Re-exports nonEmptyList
    Re-exports nonEmptyText
    Re-exports notImplemented
    Re-exports nullType
    Re-exports nullable
    Re-exports number
    Re-exports one
    Re-exports oneOf
    Re-exports optional
    Re-exports orderToNumber
    Re-exports parseError
    Re-exports record
    Re-exports safeDiv
    Re-exports sanitizeText
    Re-exports sanitizedNonEmptyText
    Re-exports string
    Re-exports sumDecimals
    Re-exports thousand
    Re-exports tuple
    Re-exports unknown
    Re-exports unsafeDecimal
    Re-exports zero

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/error.html b/modules/error.html index 4ea87f1..dd757a4 100644 --- a/modules/error.html +++ b/modules/error.html @@ -1,145 +1,6 @@ -error | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace error

    -
    -

    This module provides definitions for custom errors and some convenience +error | @telostat/prelude - v0.5.0

    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/functional.html b/modules/functional.html index 1a5324b..4462885 100644 --- a/modules/functional.html +++ b/modules/functional.html @@ -1,37 +1,7 @@ -functional | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace functional

    -
    -

    This module re-exports purify.ts definitions and provides further functional +functional | @telostat/prelude - v0.5.0

    Namespace functional

    This module re-exports purify.ts definitions and provides further functional definitions.

    -
    -
    -
    -
    -

    Index

    -
    -

    Enumerations

    -
    -
    -

    Interfaces

    -

    Index

    Enumerations

    Interfaces

    -
    -

    Type Aliases

    -
    -
    -

    Variables

    -

    Type Aliases

    Variables

    Codec Either List Maybe @@ -68,10 +32,7 @@

    Variables

    number string unknown -
    -
    -

    Functions

    -

    Functions

    EitherAsync Just Left MaybeAsync @@ -97,168 +58,4 @@

    Functions

    parseError record tuple -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/numeric.Decimal.html b/modules/numeric.Decimal.html index eb43685..7e001c9 100644 --- a/modules/numeric.Decimal.html +++ b/modules/numeric.Decimal.html @@ -1,163 +1,7 @@ -Decimal | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace Decimal

    -
    -
    -

    Index

    -
    -

    Interfaces

    -
    -
    -

    Type Aliases

    -
    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Decimal | @telostat/prelude - v0.5.0

    Index

    Interfaces

    Type Aliases

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/numeric.html b/modules/numeric.html index 6c45472..4c79373 100644 --- a/modules/numeric.html +++ b/modules/numeric.html @@ -1,169 +1,15 @@ -numeric | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace numeric

    -
    -

    This module provides definitions for working with fixed and arbitrary +numeric | @telostat/prelude - v0.5.0

    Namespace numeric

    This module provides definitions for working with fixed and arbitrary precision numbers.

    -
    -
    -
    -
    -

    Index

    -
    -

    Namespaces

    -
    -
    -

    Classes

    -

    Index

    Namespaces

    Classes

    -
    -

    Variables

    -

    Variables

    -
    -

    Functions

    -

    Functions

    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/temporal.html b/modules/temporal.html index 19935ef..e81dc82 100644 --- a/modules/temporal.html +++ b/modules/temporal.html @@ -1,166 +1,12 @@ -temporal | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace temporal

    -
    -

    This module re-exports dayjs definition and provides definitions for +temporal | @telostat/prelude - v0.5.0

    Namespace temporal

    This module re-exports dayjs definition and provides definitions for working with temporal values.

    -
    -
    -
    -
    -

    Index

    -
    -

    Enumerations

    -
    -
    -

    Interfaces

    -
    -
    -

    Type Aliases

    -
    -
    -

    Variables

    -

    Index

    Enumerations

    Interfaces

    Type Aliases

    Variables

    -
    -

    Functions

    -

    Functions

    -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/textual.html b/modules/textual.html index c16e853..2004d0e 100644 --- a/modules/textual.html +++ b/modules/textual.html @@ -1,141 +1,5 @@ -textual | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Namespace textual

    -
    -

    This module provides definitions for working with textual values.

    -
    -
    -
    -
    -

    Index

    -
    -

    Functions

    -
    nonEmptyText +textual | @telostat/prelude - v0.5.0
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.CurriedFn.html b/types/functional.CurriedFn.html index 9c9e69a..4fb936f 100644 --- a/types/functional.CurriedFn.html +++ b/types/functional.CurriedFn.html @@ -1,210 +1 @@ -CurriedFn | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias CurriedFn<TAllArgs, TReturn>

    -
    CurriedFn<TAllArgs, TReturn>: (<TProvidedArgs>(...args) => TProvidedArgs extends TAllArgs
        ? TReturn
        : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
            ? CurriedFn<TRestOfArgs, TReturn>
            : never)
    -
    -

    Type Parameters

    -
      -
    • -

      TAllArgs extends any[]

    • -
    • -

      TReturn

    -
    -

    Type declaration

    -
      -
    • -
        -
      • <TProvidedArgs>(...args): TProvidedArgs extends TAllArgs
            ? TReturn
            : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
                ? CurriedFn<TRestOfArgs, TReturn>
                : never
      • -
      • -
        -

        Type Parameters

        -
          -
        • -

          TProvidedArgs extends TAllArgs extends [infer TFirstArg, ...(infer TRestOfArgs)]
              ? [TFirstArg, ...Partial<TRestOfArgs>]
              : never

        -
        -

        Parameters

        -
          -
        • -
          Rest ...args: TProvidedArgs
        -

        Returns TProvidedArgs extends TAllArgs
            ? TReturn
            : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
                ? CurriedFn<TRestOfArgs, TReturn>
                : never

    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +CurriedFn | @telostat/prelude - v0.5.0

    Type alias CurriedFn<TAllArgs, TReturn>

    CurriedFn<TAllArgs, TReturn>: (<TProvidedArgs>(...args) => TProvidedArgs extends TAllArgs
        ? TReturn
        : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
            ? CurriedFn<TRestOfArgs, TReturn>
            : never)

    Type Parameters

    • TAllArgs extends any[]

    • TReturn

    Type declaration

      • <TProvidedArgs>(...args): TProvidedArgs extends TAllArgs
            ? TReturn
            : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
                ? CurriedFn<TRestOfArgs, TReturn>
                : never
      • Type Parameters

        • TProvidedArgs extends TAllArgs extends [infer TFirstArg, ...(infer TRestOfArgs)]
              ? [TFirstArg, ...Partial<TRestOfArgs>]
              : never

        Parameters

        • Rest ...args: TProvidedArgs

        Returns TProvidedArgs extends TAllArgs
            ? TReturn
            : TAllArgs extends [...TupleOfLength<TProvidedArgs>, ...(infer TRestOfArgs)]
                ? CurriedFn<TRestOfArgs, TReturn>
                : never

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.DecodeError.html b/types/functional.DecodeError.html index 431def5..446aadb 100644 --- a/types/functional.DecodeError.html +++ b/types/functional.DecodeError.html @@ -1,228 +1 @@ -DecodeError | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias DecodeError

    -
    DecodeError: {
        error: DecodeError;
        property: string;
        type: "property";
    } | {
        error: DecodeError;
        index: number;
        type: "index";
    } | {
        errors: DecodeError[];
        type: "oneOf";
    } | {
        expectedType?: ExpectedType;
        receivedType: ReceivedType;
        receivedValue?: unknown;
        type: "failure";
    } | {
        message: string;
        type: "custom";
    }
    -
    -

    Type declaration

    -
      -
    • -
      error: DecodeError
    • -
    • -
      property: string
    • -
    • -
      type: "property"
    -
    -

    Type declaration

    -
      -
    • -
      error: DecodeError
    • -
    • -
      index: number
    • -
    • -
      type: "index"
    -
    -

    Type declaration

    -
    -
    -

    Type declaration

    -
      -
    • -
      Optional expectedType?: ExpectedType
    • -
    • -
      receivedType: ReceivedType
    • -
    • -
      Optional receivedValue?: unknown
    • -
    • -
      type: "failure"
    -
    -

    Type declaration

    -
      -
    • -
      message: string
    • -
    • -
      type: "custom"
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +DecodeError | @telostat/prelude - v0.5.0
    DecodeError: {
        error: DecodeError;
        property: string;
        type: "property";
    } | {
        error: DecodeError;
        index: number;
        type: "index";
    } | {
        errors: DecodeError[];
        type: "oneOf";
    } | {
        expectedType?: ExpectedType;
        receivedType: ReceivedType;
        receivedValue?: unknown;
        type: "failure";
    } | {
        message: string;
        type: "custom";
    }

    Type declaration

    Type declaration

    Type declaration

    Type declaration

    Type declaration

    • message: string
    • type: "custom"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.EitherPatterns.html b/types/functional.EitherPatterns.html index 2112133..1bec352 100644 --- a/types/functional.EitherPatterns.html +++ b/types/functional.EitherPatterns.html @@ -1,234 +1 @@ -EitherPatterns | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias EitherPatterns<L, R, T>

    -
    EitherPatterns<L, R, T>: {
        Left: ((l) => T);
        Right: ((r) => T);
    } | {
        _: (() => T);
    }
    -
    -

    Type Parameters

    -
      -
    • -

      L

    • -
    • -

      R

    • -
    • -

      T

    -
    -

    Type declaration

    -
      -
    • -
      Left: ((l) => T)
      -
        -
      • -
          -
        • (l): T
        • -
        • -
          -

          Parameters

          -
            -
          • -
            l: L
          -

          Returns T

    • -
    • -
      Right: ((r) => T)
      -
        -
      • -
          -
        • (r): T
        • -
        • -
          -

          Parameters

          -
            -
          • -
            r: R
          -

          Returns T

    -
    -

    Type declaration

    -
      -
    • -
      _: (() => T)
      -
        -
      • -
          -
        • (): T
        • -
        • -

          Returns T

    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +EitherPatterns | @telostat/prelude - v0.5.0

    Type alias EitherPatterns<L, R, T>

    EitherPatterns<L, R, T>: {
        Left: ((l) => T);
        Right: ((r) => T);
    } | {
        _: (() => T);
    }

    Type Parameters

    • L

    • R

    • T

    Type declaration

    • Left: ((l) => T)
        • (l): T
        • Parameters

          • l: L

          Returns T

    • Right: ((r) => T)
        • (r): T
        • Parameters

          • r: R

          Returns T

    Type declaration

    • _: (() => T)
        • (): T
        • Returns T

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.ExpectedType.html b/types/functional.ExpectedType.html index 16053e4..044cfda 100644 --- a/types/functional.ExpectedType.html +++ b/types/functional.ExpectedType.html @@ -1,185 +1 @@ -ExpectedType | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias ExpectedType

    -
    ExpectedType: "string" | "number" | "boolean" | "object" | "array" | "null" | "undefined" | "enum"
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +ExpectedType | @telostat/prelude - v0.5.0
    ExpectedType: "string" | "number" | "boolean" | "object" | "array" | "null" | "undefined" | "enum"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.FromType.html b/types/functional.FromType.html index b7f8d04..1256cbd 100644 --- a/types/functional.FromType.html +++ b/types/functional.FromType.html @@ -1,193 +1,2 @@ -FromType | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias FromType<T>

    -
    FromType<T>: {
        [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>>
            ? T[P]
            : T[P] | undefined
    }
    -

    Special type used when you want to do the opposite of GetType - define a Codec for an existing type. The problem is that due to technical limitations optional properties are hard to generate in TypeScript so Codec generates properties of type "T | undefined" instead, which is not compatible

    -
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +FromType | @telostat/prelude - v0.5.0
    FromType<T>: {
        [P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>>
            ? T[P]
            : T[P] | undefined
    }

    Special type used when you want to do the opposite of GetType - define a Codec for an existing type. The problem is that due to technical limitations optional properties are hard to generate in TypeScript so Codec generates properties of type "T | undefined" instead, which is not compatible

    +

    Type Parameters

    • T

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.GetType.html b/types/functional.GetType.html index 810f0ef..8d5538c 100644 --- a/types/functional.GetType.html +++ b/types/functional.GetType.html @@ -1,193 +1,2 @@ -GetType | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias GetType<T>

    -
    GetType<T>: T extends functional.Codec<infer U>
        ? U
        : never
    -

    You can use this to get a free type from any codec

    -
    -
    -

    Type Parameters

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +GetType | @telostat/prelude - v0.5.0
    GetType<T>: T extends functional.Codec<infer U>
        ? U
        : never

    You can use this to get a free type from any codec

    +

    Type Parameters

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.MaybePatterns.html b/types/functional.MaybePatterns.html index be5ded1..c1ef03a 100644 --- a/types/functional.MaybePatterns.html +++ b/types/functional.MaybePatterns.html @@ -1,227 +1 @@ -MaybePatterns | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias MaybePatterns<T, U>

    -
    MaybePatterns<T, U>: {
        Just: ((value) => U);
        Nothing: (() => U);
    } | {
        _: (() => U);
    }
    -
    -

    Type Parameters

    -
      -
    • -

      T

    • -
    • -

      U

    -
    -

    Type declaration

    -
      -
    • -
      Just: ((value) => U)
      -
        -
      • -
          -
        • (value): U
        • -
        • -
          -

          Parameters

          -
            -
          • -
            value: T
          -

          Returns U

    • -
    • -
      Nothing: (() => U)
      -
        -
      • -
          -
        • (): U
        • -
        • -

          Returns U

    -
    -

    Type declaration

    -
      -
    • -
      _: (() => U)
      -
        -
      • -
          -
        • (): U
        • -
        • -

          Returns U

    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +MaybePatterns | @telostat/prelude - v0.5.0

    Type alias MaybePatterns<T, U>

    MaybePatterns<T, U>: {
        Just: ((value) => U);
        Nothing: (() => U);
    } | {
        _: (() => U);
    }

    Type Parameters

    • T

    • U

    Type declaration

    • Just: ((value) => U)
        • (value): U
        • Parameters

          • value: T

          Returns U

    • Nothing: (() => U)
        • (): U
        • Returns U

    Type declaration

    • _: (() => U)
        • (): U
        • Returns U

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.NonEmptyListCompliant.html b/types/functional.NonEmptyListCompliant.html index fb46171..7d6ca92 100644 --- a/types/functional.NonEmptyListCompliant.html +++ b/types/functional.NonEmptyListCompliant.html @@ -1,195 +1 @@ -NonEmptyListCompliant | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias NonEmptyListCompliant<T>

    -
    NonEmptyListCompliant<T>: T[] & {
        0: T;
    }
    -
    -

    Type Parameters

    -
      -
    • -

      T

    -
    -

    Type declaration

    -
      -
    • -
      0: T
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +NonEmptyListCompliant | @telostat/prelude - v0.5.0

    Type alias NonEmptyListCompliant<T>

    NonEmptyListCompliant<T>: T[] & {
        0: T;
    }

    Type Parameters

    • T

    Type declaration

    • 0: T

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/functional.ReceivedType.html b/types/functional.ReceivedType.html index 7210470..972a037 100644 --- a/types/functional.ReceivedType.html +++ b/types/functional.ReceivedType.html @@ -1,185 +1 @@ -ReceivedType | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Type alias ReceivedType

    -
    ReceivedType: "string" | "number" | "boolean" | "object" | "array" | "null" | "undefined" | "bigint" | "symbol" | "function"
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +ReceivedType | @telostat/prelude - v0.5.0
    ReceivedType: "string" | "number" | "boolean" | "object" | "array" | "null" | "undefined" | "bigint" | "symbol" | "function"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/numeric.Decimal.Constructor.html b/types/numeric.Decimal.Constructor.html index 30376e3..adab042 100644 --- a/types/numeric.Decimal.Constructor.html +++ b/types/numeric.Decimal.Constructor.html @@ -1,149 +1 @@ -Constructor | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Constructor | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/numeric.Decimal.Instance.html b/types/numeric.Decimal.Instance.html index b34b83b..67c741b 100644 --- a/types/numeric.Decimal.Instance.html +++ b/types/numeric.Decimal.Instance.html @@ -1,149 +1 @@ -Instance | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Instance | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/numeric.Decimal.Modulo.html b/types/numeric.Decimal.Modulo.html index 09c4295..8ccb45a 100644 --- a/types/numeric.Decimal.Modulo.html +++ b/types/numeric.Decimal.Modulo.html @@ -1,149 +1 @@ -Modulo | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Modulo | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/numeric.Decimal.Rounding.html b/types/numeric.Decimal.Rounding.html index 701521e..ef2ee0c 100644 --- a/types/numeric.Decimal.Rounding.html +++ b/types/numeric.Decimal.Rounding.html @@ -1,149 +1 @@ -Rounding | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Rounding | @telostat/prelude - v0.5.0
    Rounding: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/numeric.Decimal.Value.html b/types/numeric.Decimal.Value.html index 54c0ab1..e36871f 100644 --- a/types/numeric.Decimal.Value.html +++ b/types/numeric.Decimal.Value.html @@ -1,149 +1 @@ -Value | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Value | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/temporal.SDate.html b/types/temporal.SDate.html index e213369..55de269 100644 --- a/types/temporal.SDate.html +++ b/types/temporal.SDate.html @@ -1,139 +1,2 @@ -SDate | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +SDate | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/temporal.SDateTime.html b/types/temporal.SDateTime.html index f4bf8d4..4c84614 100644 --- a/types/temporal.SDateTime.html +++ b/types/temporal.SDateTime.html @@ -1,139 +1,2 @@ -SDateTime | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +SDateTime | @telostat/prelude - v0.5.0

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.Codec-1.html b/variables/functional.Codec-1.html index 268b4c1..053feda 100644 --- a/variables/functional.Codec-1.html +++ b/variables/functional.Codec-1.html @@ -1,266 +1,3 @@ -Codec | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable Codec

    -
    Codec: {
        custom<T_1>(__namedParameters) => functional.Codec<T_1>;
        interface<T>(properties) => functional.Codec<{
            [k in string | number | symbol]: GetType<T[k]>
        }>;
    }
    -
    -

    Type declaration

    -
      -
    • -
      custom:function
      -
        - -
      • -

        Creates a codec for any type, you can add your own deserialization/validation logic in the decode argument

        -
        -
        -

        Type Parameters

        -
          -
        • -

          T_1

        -
        -

        Parameters

        -
          -
        • -
          __namedParameters: {
              decode: ((value) => functional.Either<string, T_1>);
              encode: ((value) => any);
              schema?: (() => object);
          }
          -
            -
          • -
            decode: ((value) => functional.Either<string, T_1>)
            -
          • -
          • -
            encode: ((value) => any)
            -
              -
            • -
                -
              • (value): any
              • -
              • -
                -

                Parameters

                -
                  -
                • -
                  value: T_1
                -

                Returns any

          • -
          • -
            Optional schema?: (() => object)
            -
              -
            • -
                -
              • (): object
              • -
              • -

                Returns object

        -

        Returns functional.Codec<T_1>

        -
    • -
    • -
      interface:function
      -
        - -
      • -

        Creates a codec for any JSON object

        -
        -
        -

        Type Parameters

        -
        -
        -

        Parameters

        -
          -
        • -
          properties: T
        -

        Returns functional.Codec<{
            [k in string | number | symbol]: GetType<T[k]>
        }>

        -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Codec | @telostat/prelude - v0.5.0
    Codec: {
        custom<T_1>(__namedParameters) => functional.Codec<T_1>;
        interface<T>(properties) => functional.Codec<{
            [k in string | number | symbol]: GetType<T[k]>
        }>;
    }

    Type declaration

    • custom:function
      • Creates a codec for any type, you can add your own deserialization/validation logic in the decode argument

        +

        Type Parameters

        • T_1

        Parameters

        • __namedParameters: {
              decode: ((value) => functional.Either<string, T_1>);
              encode: ((value) => any);
              schema?: (() => object);
          }
          • decode: ((value) => functional.Either<string, T_1>)
          • encode: ((value) => any)
              • (value): any
              • Parameters

                • value: T_1

                Returns any

          • Optional schema?: (() => object)
              • (): object
              • Returns object

        Returns functional.Codec<T_1>

    • interface:function
      • Creates a codec for any JSON object

        +

        Type Parameters

        Parameters

        • properties: T

        Returns functional.Codec<{
            [k in string | number | symbol]: GetType<T[k]>
        }>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.Either-1.html b/variables/functional.Either-1.html index e8a29db..b931aa6 100644 --- a/variables/functional.Either-1.html +++ b/variables/functional.Either-1.html @@ -1,186 +1 @@ -Either | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable Either

    -
    Either: EitherTypeRef
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Either | @telostat/prelude - v0.5.0
    Either: EitherTypeRef

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.List.html b/variables/functional.List.html index e1c9cdd..ae6d980 100644 --- a/variables/functional.List.html +++ b/variables/functional.List.html @@ -1,299 +1 @@ -List | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable ListConst

    -
    List: {
        at: typeof at;
        find: typeof find;
        findIndex: typeof findIndex;
        head: (<T_2>(list) => functional.Maybe<T_2>);
        init: (<T>(list) => functional.Maybe<T[]>);
        last: (<T_3>(list) => functional.Maybe<T_3>);
        sort: typeof sort;
        sum: ((list) => number);
        tail: (<T_4>(list) => functional.Maybe<T_4[]>);
        uncons: (<T_1>(list) => functional.Maybe<functional.Tuple<T_1, T_1[]>>);
    }
    -
    -

    Type declaration

    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +List | @telostat/prelude - v0.5.0
    List: {
        at: typeof at;
        find: typeof find;
        findIndex: typeof findIndex;
        head: (<T_2>(list) => functional.Maybe<T_2>);
        init: (<T>(list) => functional.Maybe<T[]>);
        last: (<T_3>(list) => functional.Maybe<T_3>);
        sort: typeof sort;
        sum: ((list) => number);
        tail: (<T_4>(list) => functional.Maybe<T_4[]>);
        uncons: (<T_1>(list) => functional.Maybe<functional.Tuple<T_1, T_1[]>>);
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.Maybe-1.html b/variables/functional.Maybe-1.html index a72a765..fb18d63 100644 --- a/variables/functional.Maybe-1.html +++ b/variables/functional.Maybe-1.html @@ -1,186 +1 @@ -Maybe | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable Maybe

    -
    Maybe: MaybeTypeRef
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Maybe | @telostat/prelude - v0.5.0
    Maybe: MaybeTypeRef

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.Nothing.html b/variables/functional.Nothing.html index 550fff9..41ec1f7 100644 --- a/variables/functional.Nothing.html +++ b/variables/functional.Nothing.html @@ -1,188 +1,2 @@ -Nothing | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable NothingConst

    -
    Nothing: Nothing
    -

    Represents a missing value, you can think of it as a smart 'null'

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +Nothing | @telostat/prelude - v0.5.0
    Nothing: Nothing

    Represents a missing value, you can think of it as a smart 'null'

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.boolean.html b/variables/functional.boolean.html index 9750fc7..d7975ef 100644 --- a/variables/functional.boolean.html +++ b/variables/functional.boolean.html @@ -1,188 +1,2 @@ -boolean | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable booleanConst

    -
    boolean: functional.Codec<boolean>
    -

    A codec for a boolean value

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +boolean | @telostat/prelude - v0.5.0
    boolean: functional.Codec<boolean>

    A codec for a boolean value

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.date.html b/variables/functional.date.html index a785c26..c69d9db 100644 --- a/variables/functional.date.html +++ b/variables/functional.date.html @@ -1,188 +1,2 @@ -date | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable dateConst

    -
    date: functional.Codec<Date>
    -

    A codec for a parsable date string, on successful decoding it resolves to a Date object. The validity of the date string during decoding is decided by the browser implementation of Date.parse. Encode runs toISOString on the passed in date object

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +date | @telostat/prelude - v0.5.0
    date: functional.Codec<Date>

    A codec for a parsable date string, on successful decoding it resolves to a Date object. The validity of the date string during decoding is decided by the browser implementation of Date.parse. Encode runs toISOString on the passed in date object

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.nullType.html b/variables/functional.nullType.html index df73c3f..7ff3108 100644 --- a/variables/functional.nullType.html +++ b/variables/functional.nullType.html @@ -1,188 +1,2 @@ -nullType | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable nullTypeConst

    -
    nullType: functional.Codec<null>
    -

    A codec for null only

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +nullType | @telostat/prelude - v0.5.0
    nullType: functional.Codec<null>

    A codec for null only

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.number.html b/variables/functional.number.html index cafa18d..feb9ed6 100644 --- a/variables/functional.number.html +++ b/variables/functional.number.html @@ -1,188 +1,2 @@ -number | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable numberConst

    -
    number: functional.Codec<number>
    -

    A codec for any number value. This includes anything that has a typeof number - NaN, Infinity etc. Encoding a number acts like the identity function

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +number | @telostat/prelude - v0.5.0
    number: functional.Codec<number>

    A codec for any number value. This includes anything that has a typeof number - NaN, Infinity etc. Encoding a number acts like the identity function

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.string.html b/variables/functional.string.html index 14b2de2..e67e122 100644 --- a/variables/functional.string.html +++ b/variables/functional.string.html @@ -1,188 +1,2 @@ -string | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable stringConst

    -
    string: functional.Codec<string>
    -

    A codec for any string value. Most of the time you will use it to implement an interface codec (see the Codec#interface example above). Encoding a string acts like the identity function

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +string | @telostat/prelude - v0.5.0
    string: functional.Codec<string>

    A codec for any string value. Most of the time you will use it to implement an interface codec (see the Codec#interface example above). Encoding a string acts like the identity function

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/functional.unknown.html b/variables/functional.unknown.html index c4ed643..d39b26b 100644 --- a/variables/functional.unknown.html +++ b/variables/functional.unknown.html @@ -1,188 +1,2 @@ -unknown | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable unknownConst

    -
    unknown: functional.Codec<unknown>
    -

    A codec that can never fail, but of course you get no type information. Encoding an unknown acts like the identity function

    -
    -
    -
    - -
    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +unknown | @telostat/prelude - v0.5.0
    unknown: functional.Codec<unknown>

    A codec that can never fail, but of course you get no type information. Encoding an unknown acts like the identity function

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/numeric.hundred.html b/variables/numeric.hundred.html index 2a436eb..c918090 100644 --- a/variables/numeric.hundred.html +++ b/variables/numeric.hundred.html @@ -1,143 +1,3 @@ -hundred | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable hundredConst

    -
    hundred: Decimal = ...
    -

    Convenience definition of the constant value of 100 as a +hundred | @telostat/prelude - v0.5.0

    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/numeric.one.html b/variables/numeric.one.html index ed92665..163c6a1 100644 --- a/variables/numeric.one.html +++ b/variables/numeric.one.html @@ -1,143 +1,3 @@ -one | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable oneConst

    -
    one: Decimal = ...
    -

    Convenience definition of the constant value of 1 as a +one | @telostat/prelude - v0.5.0

    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/numeric.thousand.html b/variables/numeric.thousand.html index c73772b..656300a 100644 --- a/variables/numeric.thousand.html +++ b/variables/numeric.thousand.html @@ -1,143 +1,3 @@ -thousand | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable thousandConst

    -
    thousand: Decimal = ...
    -

    Convenience definition of the constant value of 1,000 as a +thousand | @telostat/prelude - v0.5.0

    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/numeric.zero.html b/variables/numeric.zero.html index ba8c2b4..9a38ebd 100644 --- a/variables/numeric.zero.html +++ b/variables/numeric.zero.html @@ -1,143 +1,3 @@ -zero | @telostat/prelude - v0.4.1
    -
    - -
    -
    -
    -
    - -

    Variable zeroConst

    -
    zero: Decimal = ...
    -

    Convenience definition of the constant value of 0 as a +zero | @telostat/prelude - v0.5.0

    -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/temporal.isoFormatDate.html b/variables/temporal.isoFormatDate.html index db48b56..41cf2b2 100644 --- a/variables/temporal.isoFormatDate.html +++ b/variables/temporal.isoFormatDate.html @@ -1,139 +1,2 @@ -isoFormatDate | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +isoFormatDate | @telostat/prelude - v0.5.0

    Variable isoFormatDateConst

    isoFormatDate: "YYYY-MM-DD" = 'YYYY-MM-DD'

    ISO date format used in the library.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/temporal.isoFormatDateTime.html b/variables/temporal.isoFormatDateTime.html index 39df12c..d1287b3 100644 --- a/variables/temporal.isoFormatDateTime.html +++ b/variables/temporal.isoFormatDateTime.html @@ -1,139 +1,2 @@ -isoFormatDateTime | @telostat/prelude - v0.4.1
    -
    - -
    - -
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +isoFormatDateTime | @telostat/prelude - v0.5.0

    Variable isoFormatDateTimeConst

    isoFormatDateTime: "YYYY-MM-DDTHH:MM:ss" = 'YYYY-MM-DDTHH:MM:ss'

    ISO date/time format used in the library.

    +

    Generated using TypeDoc

    \ No newline at end of file