From d032dbb2ecd27ff9f4775dcd768cd5435e342814 Mon Sep 17 00:00:00 2001 From: SukkaW Date: Thu, 18 Apr 2024 06:57:19 +0000 Subject: [PATCH] deploy: d6301c4074865ac10bd8667846f2cc5dffba5502 --- assets/icons.js | 15 ++ assets/icons.svg | 1 + assets/main.js | 8 +- assets/style.css | 12 +- classes/database.default.html | 36 +-- classes/document.default.html | 40 +-- classes/error.default.html | 14 +- classes/error_population.default.html | 14 +- classes/error_validation.default.html | 14 +- classes/model.default.html | 238 +++++++++--------- classes/mutex.default.html | 12 +- classes/query.default.html | 126 +++++----- classes/schema.default.html | 92 +++---- classes/schematype.default.html | 94 +++---- classes/types_array.default.html | 138 +++++----- classes/types_boolean.default.html | 94 +++---- classes/types_buffer.default.html | 92 +++---- classes/types_cuid.default.html | 94 +++---- classes/types_date.default.html | 114 ++++----- classes/types_enum.default.html | 92 +++---- classes/types_integer.default.html | 122 ++++----- classes/types_number.default.html | 122 ++++----- classes/types_object.default.html | 92 +++---- classes/types_string.default.html | 98 ++++---- classes/types_virtual.default.html | 106 ++++---- functions/lib_jsonstream.parse.html | 2 +- functions/util.arr2obj.html | 2 +- functions/util.delProp.html | 2 +- functions/util.getProp.html | 2 +- functions/util.parseArgs.html | 2 +- functions/util.reverse.html | 2 +- functions/util.setGetter.html | 2 +- functions/util.setProp.html | 2 +- functions/util.shuffle.html | 2 +- hierarchy.html | 2 +- index.html | 4 +- .../types-1.AddSchemaTypeLoopOptions.html | 2 +- interfaces/types-1.Options.html | 8 +- modules/database.html | 4 +- modules/document.html | 4 +- modules/error.html | 4 +- modules/error_population.html | 4 +- modules/error_validation.html | 4 +- modules/lib_jsonstream.html | 4 +- modules/model.html | 4 +- modules/mutex.html | 4 +- modules/query.html | 4 +- modules/schema.html | 4 +- modules/schematype.html | 4 +- modules/types-1.html | 18 +- modules/types.html | 26 +- modules/types_array.html | 4 +- modules/types_boolean.html | 4 +- modules/types_buffer.html | 4 +- modules/types_cuid.html | 4 +- modules/types_date.html | 4 +- modules/types_enum.html | 4 +- modules/types_integer.html | 4 +- modules/types_number.html | 4 +- modules/types_object.html | 4 +- modules/types_string.html | 4 +- modules/types_virtual.html | 4 +- modules/util.html | 18 +- types/types-1.AddSchemaTypeMixedOptions.html | 2 +- types/types-1.AddSchemaTypeOptions.html | 2 +- types/types-1.AddSchemaTypeSimpleOptions.html | 2 +- types/types-1.NodeJSLikeCallback.html | 2 +- types/types-1.PopulateResult.html | 2 +- types/types-1.SchemaTypeOptions.html | 2 +- 69 files changed, 1045 insertions(+), 1031 deletions(-) create mode 100644 assets/icons.js create mode 100644 assets/icons.svg diff --git a/assets/icons.js b/assets/icons.js new file mode 100644 index 0000000..b79c9e8 --- /dev/null +++ b/assets/icons.js @@ -0,0 +1,15 @@ +(function(svg) { + svg.innerHTML = ``; + svg.style.display = 'none'; + if (location.protocol === 'file:') { + if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); + else updateUseElements() + function updateUseElements() { + document.querySelectorAll('use').forEach(el => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } + } +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/assets/icons.svg b/assets/icons.svg new file mode 100644 index 0000000..7dead61 --- /dev/null +++ b/assets/icons.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/main.js b/assets/main.js index 7270cff..d6f1388 100644 --- a/assets/main.js +++ b/assets/main.js @@ -1,8 +1,8 @@ "use strict"; -"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(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(console.log("Show page"),document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){console.log("Scorlling");let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ve(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ve(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ne(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/assets/style.css b/assets/style.css index 98a4377..778b949 100644 --- a/assets/style.css +++ b/assets/style.css @@ -327,17 +327,14 @@ dd { } /* Footer */ -.tsd-generator { +footer { border-top: 1px solid var(--color-accent); padding-top: 1rem; padding-bottom: 1rem; max-height: 3.5rem; } - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; +.tsd-generator { + margin: 0 1em; } .container-main { @@ -405,7 +402,8 @@ dd { } body { background: var(--color-background); - font-family: "Segoe UI", sans-serif; + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; font-size: 16px; color: var(--color-text); } diff --git a/classes/database.default.html b/classes/database.default.html index 7b288e5..7357e30 100644 --- a/classes/database.default.html +++ b/classes/database.default.html @@ -1,18 +1,18 @@ -default | hexojs/warehouse

Class default

Constructors

constructor -

Properties

Model -Schema -SchemaType -_models -options -Schema -SchemaType -version -

Methods

load -model -save -toJSON -

Constructors

constructor

  • new default(options?): default

  • Database constructor.

    -

    Parameters

    • Optional options: {
          path: string;
      } & Partial<DatabaseOptions>

    Returns default

Properties

Model

Model: typeof default

Schema

Schema: typeof default

SchemaType

SchemaType: typeof default

_models

_models: Record<string, default<any>>

options

options: DatabaseOptions

Static Schema

Schema: typeof default = Schema

Static SchemaType

SchemaType: typeof default = SchemaType

Static version

version: number

Methods

load

model

save

toJSON

  • toJSON(): {
        meta: {
            version: number;
            warehouse: string;
        };
        models: Record<string, default<any>>;
    }

  • Returns {
        meta: {
            version: number;
            warehouse: string;
        };
        models: Record<string, default<any>>;
    }

    • meta: {
          version: number;
          warehouse: string;
      }
      • version: number
      • warehouse: string
    • models: Record<string, default<any>>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Constructors

constructor +

Properties

Model +Schema +SchemaType +_models +options +Schema +SchemaType +version +

Methods

load +model +save +toJSON +

Constructors

constructor

  • new default(options?): default

  • Database constructor.

    +

    Parameters

    • Optional options: {
          path: string;
      } & Partial<DatabaseOptions>

    Returns default

Properties

Model

Model: typeof default

Schema

Schema: typeof default

SchemaType

SchemaType: typeof default

_models

_models: Record<string, default<any>>

options

options: DatabaseOptions

Static Schema

Schema: typeof default = Schema

Static SchemaType

SchemaType: typeof default = SchemaType

Static version

version: number

Methods

load

model

save

toJSON

  • toJSON(): {
        meta: {
            version: number;
            warehouse: string;
        };
        models: Record<string, default<any>>;
    }

  • Returns {
        meta: {
            version: number;
            warehouse: string;
        };
        models: Record<string, default<any>>;
    }

    • meta: {
          version: number;
          warehouse: string;
      }
      • version: number
      • warehouse: string
    • models: Record<string, default<any>>

Settings

Member Visibility

Theme

On This Page

constructorModelSchemaSchemaType_modelsoptionsSchemaSchemaTypeversionloadmodelsavetoJSON
\ No newline at end of file diff --git a/classes/document.default.html b/classes/document.default.html index 2306d84..46336e5 100644 --- a/classes/document.default.html +++ b/classes/document.default.html @@ -1,20 +1,20 @@ -default | hexojs/warehouse

Class default<T>Abstract

Type Parameters

  • T

Indexable

[key: string]: any

Constructors

constructor -

Properties

_id -_model -_schema -

Methods

populate -remove -replace -save -toObject -toString -update -

Constructors

constructor

Properties

_id

_id: string | number

Abstract _model

_model: default<T>

Abstract _schema

_schema: default

Methods

populate

  • populate(expr): default<T>

  • Populates document references.

    -

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns default<T>

remove

replace

save

toObject

  • toObject(): T

  • Returns a plain JavaScript object.

    -

    Returns T

toString

  • toString(): string

  • Returns a string representing the document.

    -

    Returns string

update

  • update(data, callback?): Promise<any>

  • Updates the document.

    -

    Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default<T>Abstract

Type Parameters

  • T

Indexable

[key: string]: any

Constructors

constructor +

Properties

_id +_model +_schema +

Methods

populate +remove +replace +save +toObject +toString +update +

Constructors

constructor

Properties

_id

_id: string | number

Abstract _model

_model: default<T>

Abstract _schema

_schema: default

Methods

populate

  • populate(expr): default<T>

  • Populates document references.

    +

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns default<T>

remove

replace

save

toObject

  • toObject(): T

  • Returns a plain JavaScript object.

    +

    Returns T

toString

  • toString(): string

  • Returns a string representing the document.

    +

    Returns string

update

  • update(data, callback?): Promise<any>

  • Updates the document.

    +

    Parameters

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructor_id_model_schemapopulateremovereplacesavetoObjecttoStringupdate
\ No newline at end of file diff --git a/classes/error.default.html b/classes/error.default.html index 724bc33..2c09c6b 100644 --- a/classes/error.default.html +++ b/classes/error.default.html @@ -1,7 +1,7 @@ -default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor -

Properties

code? -ID_EXIST -ID_NOT_EXIST -ID_UNDEFINED -

Constructors

constructor

  • new default(msg, code?): default

  • WarehouseError constructor

    -

    Parameters

    • msg: string
    • Optional code: string

    Returns default

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor +

Properties

code? +ID_EXIST +ID_NOT_EXIST +ID_UNDEFINED +

Constructors

constructor

  • new default(msg, code?): default

  • WarehouseError constructor

    +

    Parameters

    • msg: string
    • Optional code: string

    Returns default

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

constructorcodeID_EXISTID_NOT_EXISTID_UNDEFINED
\ No newline at end of file diff --git a/classes/error_population.default.html b/classes/error_population.default.html index b9ca804..c108920 100644 --- a/classes/error_population.default.html +++ b/classes/error_population.default.html @@ -1,7 +1,7 @@ -default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor -

Properties

code? -ID_EXIST -ID_NOT_EXIST -ID_UNDEFINED -

Constructors

constructor

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor +

Properties

code? +ID_EXIST +ID_NOT_EXIST +ID_UNDEFINED +

Constructors

constructor

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

constructorcodeID_EXISTID_NOT_EXISTID_UNDEFINED
\ No newline at end of file diff --git a/classes/error_validation.default.html b/classes/error_validation.default.html index 61fdaa5..2924ebf 100644 --- a/classes/error_validation.default.html +++ b/classes/error_validation.default.html @@ -1,7 +1,7 @@ -default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor -

Properties

code? -ID_EXIST -ID_NOT_EXIST -ID_UNDEFINED -

Constructors

constructor

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Hierarchy (view full)

Constructors

constructor +

Properties

code? +ID_EXIST +ID_NOT_EXIST +ID_UNDEFINED +

Constructors

constructor

Properties

Optional code

code?: string

Static ID_EXIST

ID_EXIST: string = 'ID_EXIST'

Static ID_NOT_EXIST

ID_NOT_EXIST: string = 'ID_NOT_EXIST'

Static ID_UNDEFINED

ID_UNDEFINED: string = 'ID_UNDEFINED'

Settings

Member Visibility

Theme

On This Page

constructorcodeID_EXISTID_NOT_EXISTID_UNDEFINED
\ No newline at end of file diff --git a/classes/model.default.html b/classes/model.default.html index 58d606e..67a480b 100644 --- a/classes/model.default.html +++ b/classes/model.default.html @@ -1,125 +1,125 @@ -default | hexojs/warehouse

Class default<T>

Type Parameters

  • T

Hierarchy

  • EventEmitter
    • default

Constructors

constructor -

Properties

Document -Query -_database -_mutex -data -each -get -length -name -random -schema -size -

Methods

_acquireWriteLock -_export -_import -_insertOne -_populate -_populateGetter -_populateGetterArray -_removeById -_replaceById -_updateWithStack -count -destroy -eq -every -filter -find -findById -findOne -first -forEach -has -insert -insertOne -last -limit -map -new -populate -reduce -reduceRight -remove -removeById -replace -replaceById -reverse -save -shuffle -skip -slice -some -sort -toArray -toJSON -update -updateById -

Constructors

constructor

Properties

Document

Document: any

Query

Query: any

_database

_database: default

_mutex

_mutex: default = ...

data

data: Record<PropertyKey, T> = {}

each

each: ((iterator, options?) => void)

Type declaration

    • (iterator, options?): void

    • Iterates over all documents.

      -

      Parameters

      • iterator: ((value, index) => void)
          • (value, index): void

          • Parameters

            • value: any
            • index: number

            Returns void

      • Optional options: Options

        See Model#findById.

        -

      Returns void

get

get: ((id, options_?) => T | default<T>)

Type declaration

    • (id, options_?): T | default<T>

    • Finds a document by its identifier.

      -

      Parameters

      • id: PropertyKey
      • Optional options_: Options

      Returns T | default<T>

length

length: number = 0

name

name: string

Model name

-

random

random: (() => default<T>)

Type declaration

schema

schema: default

size

size: (() => number)

Type declaration

    • (): number

    • Returns the number of elements.

      -

      Returns number

Methods

Private _acquireWriteLock

  • _acquireWriteLock(): Disposer<void>
  • Private

    Acquires write lock.

    -

    Returns Disposer<void>

Private _export

  • _export(): string
  • Private

    Exports data.

    -

    Returns string

Private _import

  • _import(arr): void
  • Private

    Imports data.

    -

    Parameters

    • arr: any[]

    Returns void

Private _insertOne

  • _insertOne(data_): Bluebird<any>
  • Private

    Inserts a document.

    -

    Parameters

    Returns Bluebird<any>

Private _populate

Private _populateGetter

  • _populateGetter(data, model, options): (() => default<T> | Record<PropertyKey, any>)
  • Private

    Returns a getter function for normal population.

    -

    Parameters

    • data: string | number
    • model: default<T>
    • options: unknown

    Returns (() => default<T> | Record<PropertyKey, any>)

      • (): default<T> | Record<PropertyKey, any>

      • Returns default<T> | Record<PropertyKey, any>

Private _populateGetterArray

Private _removeById

  • _removeById(id): Bluebird<any>
  • Private

    Finds a document by its identifier and remove it.

    -

    Parameters

    • id: string | number

    Returns Bluebird<any>

Private _replaceById

  • _replaceById(id, data_): Bluebird<any>
  • Private

    Finds a document by its identifier and replace it.

    -

    Parameters

    Returns Bluebird<any>

Private _updateWithStack

  • _updateWithStack(id, stack): Bluebird<any>
  • Private

    Updates a document with a compiled stack.

    -

    Parameters

    • id: string | number
    • stack: ((data) => void)[]

    Returns Bluebird<any>

count

  • count(): number

  • Returns the number of elements.

    -

    Returns number

destroy

  • destroy(): void

  • Deletes a model.

    -

    Returns void

eq

  • eq(i_, options?): default<T> | Record<PropertyKey, any>

  • Returns the document at the specified index. num can be a positive or +default | hexojs/warehouse

    Class default<T>

    Type Parameters

    • T

    Hierarchy

    • EventEmitter
      • default

    Constructors

    constructor +

    Properties

    Document +Query +_database +_mutex +data +each +get +length +name +random +schema +size +

    Methods

    _acquireWriteLock +_export +_import +_insertOne +_populate +_populateGetter +_populateGetterArray +_removeById +_replaceById +_updateWithStack +count +destroy +eq +every +filter +find +findById +findOne +first +forEach +has +insert +insertOne +last +limit +map +new +populate +reduce +reduceRight +remove +removeById +replace +replaceById +reverse +save +shuffle +skip +slice +some +sort +toArray +toJSON +update +updateById +

    Constructors

    constructor

    Properties

    Document

    Document: any

    Query

    Query: any

    _database

    _database: default

    _mutex

    _mutex: default = ...

    data

    data: Record<PropertyKey, T> = {}

    each

    each: ((iterator, options?) => void)

    Type declaration

      • (iterator, options?): void

      • Iterates over all documents.

        +

        Parameters

        • iterator: ((value, index) => void)
            • (value, index): void

            • Parameters

              • value: any
              • index: number

              Returns void

        • Optional options: Options

          See Model#findById.

          +

        Returns void

    get

    get: ((id, options_?) => T | default<T>)

    Type declaration

      • (id, options_?): T | default<T>

      • Finds a document by its identifier.

        +

        Parameters

        • id: PropertyKey
        • Optional options_: Options

        Returns T | default<T>

    length

    length: number = 0

    name

    name: string

    Model name

    +

    random

    random: (() => default<T>)

    Type declaration

    schema

    schema: default

    size

    size: (() => number)

    Type declaration

      • (): number

      • Returns the number of elements.

        +

        Returns number

    Methods

    Private _acquireWriteLock

    • _acquireWriteLock(): Disposer<void>
    • Private

      Acquires write lock.

      +

      Returns Disposer<void>

    Private _export

    • _export(): string
    • Private

      Exports data.

      +

      Returns string

    Private _import

    • _import(arr): void
    • Private

      Imports data.

      +

      Parameters

      • arr: any[]

      Returns void

    Private _insertOne

    • _insertOne(data_): Bluebird<any>
    • Private

      Inserts a document.

      +

      Parameters

      Returns Bluebird<any>

    Private _populate

    Private _populateGetter

    • _populateGetter(data, model, options): (() => default<T> | Record<PropertyKey, any>)
    • Private

      Returns a getter function for normal population.

      +

      Parameters

      • data: string | number
      • model: default<T>
      • options: unknown

      Returns (() => default<T> | Record<PropertyKey, any>)

        • (): default<T> | Record<PropertyKey, any>

        • Returns default<T> | Record<PropertyKey, any>

    Private _populateGetterArray

    Private _removeById

    • _removeById(id): Bluebird<any>
    • Private

      Finds a document by its identifier and remove it.

      +

      Parameters

      • id: string | number

      Returns Bluebird<any>

    Private _replaceById

    • _replaceById(id, data_): Bluebird<any>
    • Private

      Finds a document by its identifier and replace it.

      +

      Parameters

      Returns Bluebird<any>

    Private _updateWithStack

    • _updateWithStack(id, stack): Bluebird<any>
    • Private

      Updates a document with a compiled stack.

      +

      Parameters

      • id: string | number
      • stack: ((data) => void)[]

      Returns Bluebird<any>

    count

    • count(): number

    • Returns the number of elements.

      +

      Returns number

    destroy

    • destroy(): void

    • Deletes a model.

      +

      Returns void

    eq

    • eq(i_, options?): default<T> | Record<PropertyKey, any>

    • Returns the document at the specified index. num can be a positive or negative number.

      -

      Parameters

      • i_: number
      • Optional options: Options

        See Model#findById.

        -

      Returns default<T> | Record<PropertyKey, any>

    every

    • every(iterator): boolean

    • Tests whether all documents pass the test implemented by the provided +

      Parameters

      • i_: number
      • Optional options: Options

        See Model#findById.

        +

      Returns default<T> | Record<PropertyKey, any>

    every

    • every(iterator): boolean

    • Tests whether all documents pass the test implemented by the provided function.

      -

      Parameters

      • iterator: ((value, index) => any)
          • (value, index): any

          • Parameters

            • value: any
            • index: number

            Returns any

      Returns boolean

    filter

    • filter(iterator, options?): default<T>

    • Creates a new array with all documents that pass the test implemented by the +

      Parameters

      • iterator: ((value, index) => any)
          • (value, index): any

          • Parameters

            • value: any
            • index: number

            Returns any

      Returns boolean

    filter

    • filter(iterator, options?): default<T>

    • Creates a new array with all documents that pass the test implemented by the provided function.

      -

      Parameters

      • iterator: ((value, index) => any)
          • (value, index): any

          • Parameters

            • value: any
            • index: number

            Returns any

      • Optional options: Options

      Returns default<T>

    find

    findById

    findOne

    first

    • first(options?): default<T> | Record<PropertyKey, any>

    • Returns the first document.

      -

      Parameters

      • Optional options: Options

        See Model#findById.

        -

      Returns default<T> | Record<PropertyKey, any>

    forEach

    • forEach(iterator, options?): void

    • Iterates over all documents.

      -

      Parameters

      • iterator: ((value, index) => void)
          • (value, index): void

          • Parameters

            • value: any
            • index: number

            Returns void

      • Optional options: Options

        See Model#findById.

        -

      Returns void

    has

    • has(id): boolean

    • Checks if the model contains a document with the specified id.

      -

      Parameters

      • id: PropertyKey

      Returns boolean

    insert

    insertOne

    last

    • last(options?): default<T> | Record<PropertyKey, any>

    • Returns the last document.

      -

      Parameters

      • Optional options: Options

        See Model#findById.

        -

      Returns default<T> | Record<PropertyKey, any>

    limit

    map

    • map<T>(iterator, options?): T[]

    • Creates an array of values by iterating each element in the collection.

      -

      Type Parameters

      • T

      Parameters

      • iterator: ((value, index) => T)
          • (value, index): T

          • Parameters

            • value: any
            • index: number

            Returns T

      • Optional options: Options

      Returns T[]

    new

    populate

    • populate(path): default<T>

    • Populates document references.

      -

      Parameters

      • path: string | any[] | {
            model?: any;
            path?: string;
            [key: PropertyKey]: any;
        }

      Returns default<T>

    reduce

    • reduce<T>(iterator, initial?): T

    • Reduces a collection to a value which is the accumulated result of iterating +

      Parameters

      • iterator: ((value, index) => any)
          • (value, index): any

          • Parameters

            • value: any
            • index: number

            Returns any

      • Optional options: Options

      Returns default<T>

    find

    findById

    findOne

    first

    • first(options?): default<T> | Record<PropertyKey, any>

    • Returns the first document.

      +

      Parameters

      • Optional options: Options

        See Model#findById.

        +

      Returns default<T> | Record<PropertyKey, any>

    forEach

    • forEach(iterator, options?): void

    • Iterates over all documents.

      +

      Parameters

      • iterator: ((value, index) => void)
          • (value, index): void

          • Parameters

            • value: any
            • index: number

            Returns void

      • Optional options: Options

        See Model#findById.

        +

      Returns void

    has

    • has(id): boolean

    • Checks if the model contains a document with the specified id.

      +

      Parameters

      • id: PropertyKey

      Returns boolean

    insert

    insertOne

    last

    • last(options?): default<T> | Record<PropertyKey, any>

    • Returns the last document.

      +

      Parameters

      • Optional options: Options

        See Model#findById.

        +

      Returns default<T> | Record<PropertyKey, any>

    limit

    map

    • map<T>(iterator, options?): T[]

    • Creates an array of values by iterating each element in the collection.

      +

      Type Parameters

      • T

      Parameters

      • iterator: ((value, index) => T)
          • (value, index): T

          • Parameters

            • value: any
            • index: number

            Returns T

      • Optional options: Options

      Returns T[]

    new

    populate

    • populate(path): default<T>

    • Populates document references.

      +

      Parameters

      • path: string | any[] | {
            model?: any;
            path?: string;
            [key: PropertyKey]: any;
        }

      Returns default<T>

    reduce

    • reduce<T>(iterator, initial?): T

    • Reduces a collection to a value which is the accumulated result of iterating each element in the collection.

      -

      Type Parameters

      • T

      Parameters

      • iterator: ((pre, cur, index) => T)
          • (pre, cur, index): T

          • Parameters

            • pre: any
            • cur: any
            • index: number

            Returns T

      • Optional initial: T

        By default, the initial value is the first document.

        -

      Returns T

    reduceRight

    • reduceRight<T>(iterator, initial?): T

    • Reduces a collection to a value which is the accumulated result of iterating +

      Type Parameters

      • T

      Parameters

      • iterator: ((pre, cur, index) => T)
          • (pre, cur, index): T

          • Parameters

            • pre: any
            • cur: any
            • index: number

            Returns T

      • Optional initial: T

        By default, the initial value is the first document.

        +

      Returns T

    reduceRight

    • reduceRight<T>(iterator, initial?): T

    • Reduces a collection to a value which is the accumulated result of iterating each element in the collection from right to left.

      -

      Type Parameters

      • T

      Parameters

      • iterator: ((pre, cur, index) => T)
          • (pre, cur, index): T

          • Parameters

            • pre: any
            • cur: any
            • index: number

            Returns T

      • Optional initial: T

        By default, the initial value is the last document.

        -

      Returns T

    remove

    • remove(query, callback?): Bluebird<any>

    • Removes matching documents.

      -

      Parameters

      Returns Bluebird<any>

    removeById

    • removeById(id, callback?): Bluebird<any>

    • Finds a document by its identifier and remove it.

      -

      Parameters

      Returns Bluebird<any>

    replace

    • replace(query, data, callback?): Bluebird<any>

    • Replaces matching documents.

      -

      Parameters

      Returns Bluebird<any>

    replaceById

    • replaceById(id, data, callback?): Bluebird<any>

    • Finds a document by its identifier and replace it.

      -

      Parameters

      Returns Bluebird<any>

    reverse

    save

    • save(data, callback?): Bluebird<any>

    • Inserts the document if it does not exist; otherwise updates it.

      -

      Parameters

      Returns Bluebird<any>

    shuffle

    skip

    slice

    • slice(start_?, end_?): default<T>

    • Returns the specified range of documents.

      -

      Parameters

      • Optional start_: number
      • Optional end_: number

      Returns default<T>

    some

    • some(iterator): boolean

    • Tests whether some documents pass the test implemented by the provided +

      Type Parameters

      • T

      Parameters

      • iterator: ((pre, cur, index) => T)
          • (pre, cur, index): T

          • Parameters

            • pre: any
            • cur: any
            • index: number

            Returns T

      • Optional initial: T

        By default, the initial value is the last document.

        +

      Returns T

    remove

    • remove(query, callback?): Bluebird<any>

    • Removes matching documents.

      +

      Parameters

      Returns Bluebird<any>

    removeById

    • removeById(id, callback?): Bluebird<any>

    • Finds a document by its identifier and remove it.

      +

      Parameters

      Returns Bluebird<any>

    replace

    • replace(query, data, callback?): Bluebird<any>

    • Replaces matching documents.

      +

      Parameters

      Returns Bluebird<any>

    replaceById

    • replaceById(id, data, callback?): Bluebird<any>

    • Finds a document by its identifier and replace it.

      +

      Parameters

      Returns Bluebird<any>

    reverse

    save

    • save(data, callback?): Bluebird<any>

    • Inserts the document if it does not exist; otherwise updates it.

      +

      Parameters

      Returns Bluebird<any>

    shuffle

    skip

    slice

    • slice(start_?, end_?): default<T>

    • Returns the specified range of documents.

      +

      Parameters

      • Optional start_: number
      • Optional end_: number

      Returns default<T>

    some

    • some(iterator): boolean

    • Tests whether some documents pass the test implemented by the provided function.

      -

      Parameters

      • iterator: ((value, index) => any)
          • (value, index): any

          • Parameters

            • value: any
            • index: number

            Returns any

      Returns boolean

    sort

    toArray

    • toArray(options?): any[]

    • Returns an array containing all documents.

      -

      Parameters

      • Optional options: Options

        See Model#findById.

        -

      Returns any[]

    toJSON

    update

    • update(query, data, callback?): Bluebird<any>

    • Updates matching documents.

      -

      Parameters

      Returns Bluebird<any>

    updateById

    • updateById(id, update, callback?): Bluebird<any>

    • Finds a document by its identifier and update it.

      -

      Parameters

      Returns Bluebird<any>

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Parameters

    • iterator: ((value, index) => any)
        • (value, index): any

        • Parameters

          • value: any
          • index: number

          Returns any

    Returns boolean

sort

toArray

  • toArray(options?): any[]

  • Returns an array containing all documents.

    +

    Parameters

    • Optional options: Options

      See Model#findById.

      +

    Returns any[]

toJSON

update

  • update(query, data, callback?): Bluebird<any>

  • Updates matching documents.

    +

    Parameters

    Returns Bluebird<any>

updateById

  • updateById(id, update, callback?): Bluebird<any>

  • Finds a document by its identifier and update it.

    +

    Parameters

    Returns Bluebird<any>

Settings

Member Visibility

Theme

On This Page

constructorDocumentQuery_database_mutexdataeachgetlengthnamerandomschemasize_acquireWriteLock_export_import_insertOne_populate_populateGetter_populateGetterArray_removeById_replaceById_updateWithStackcountdestroyeqeveryfilterfindfindByIdfindOnefirstforEachhasinsertinsertOnelastlimitmapnewpopulatereducereduceRightremoveremoveByIdreplacereplaceByIdreversesaveshuffleskipslicesomesorttoArraytoJSONupdateupdateById
\ No newline at end of file diff --git a/classes/mutex.default.html b/classes/mutex.default.html index 0fa7e4a..dc5df26 100644 --- a/classes/mutex.default.html +++ b/classes/mutex.default.html @@ -1,6 +1,6 @@ -default | hexojs/warehouse

Class default

Constructors

constructor -

Properties

_locked -_queue -

Methods

lock -unlock -

Constructors

constructor

Properties

Private _locked

_locked: boolean

Private Readonly _queue

_queue: (() => void)[]

Type declaration

    • (): void

    • Returns void

Methods

lock

  • lock(fn): void

  • Parameters

    • fn: (() => void)
        • (): void

        • Returns void

    Returns void

unlock

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Constructors

constructor +

Properties

_locked +_queue +

Methods

lock +unlock +

Constructors

constructor

Properties

Private _locked

_locked: boolean

Private Readonly _queue

_queue: (() => void)[]

Type declaration

    • (): void

    • Returns void

Methods

lock

  • lock(fn): void

  • Parameters

    • fn: (() => void)
        • (): void

        • Returns void

    Returns void

unlock

Settings

Member Visibility

Theme

On This Page

constructor_locked_queuelockunlock
\ No newline at end of file diff --git a/classes/query.default.html b/classes/query.default.html index 8151319..c9aa85d 100644 --- a/classes/query.default.html +++ b/classes/query.default.html @@ -1,76 +1,76 @@ -default | hexojs/warehouse

Class default<T>Abstract

Type Parameters

  • T

Constructors

constructor -

Properties

_model -_schema -data -each -length -random -size -

Methods

count -eq -every -filter -find -findOne -first -forEach -last -limit -map -populate -reduce -reduceRight -remove -replace -reverse -shuffle -skip -slice -some -sort -toArray -update -

Constructors

constructor

Properties

Abstract _model

_model: default<T>

Abstract _schema

_schema: default

data

data: default<T>[]

each

each: ((iterator) => void)

Type declaration

    • (iterator): void

    • Iterates over all documents.

      -

      Parameters

      • iterator: ((item, index) => void)
          • (item, index): void

          • Parameters

            • item: any
            • index: number

            Returns void

      Returns void

length

length: number

random

random: (() => default<T>)

Type declaration

size

size: (() => number)

Type declaration

Methods

count

  • count(): number

  • Returns the number of elements.

    Returns number

    Number

    -

eq

  • eq(i): default<T>

  • Returns the document at the specified index. num can be a positive or +

eq

  • eq(i): default<T>

  • Returns the document at the specified index. num can be a positive or negative number.

    -

    Parameters

    • i: number

    Returns default<T>

every

  • every(iterator): boolean

  • Tests whether all documents pass the test implemented by the provided +

    Parameters

    • i: number

    Returns default<T>

every

  • every(iterator): boolean

  • Tests whether all documents pass the test implemented by the provided function.

    -

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns boolean

filter

  • filter(iterator): default<T>

  • Creates a new array with all documents that pass the test implemented by the +

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns boolean

filter

  • filter(iterator): default<T>

  • Creates a new array with all documents that pass the test implemented by the provided function.

    -

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns default<T>

find

findOne

first

forEach

  • forEach(iterator): void

  • Iterates over all documents.

    -

    Parameters

    • iterator: ((item, index) => void)
        • (item, index): void

        • Parameters

          • item: any
          • index: number

          Returns void

    Returns void

last

limit

map

  • map<T>(iterator): T[]

  • Creates an array of values by iterating each element in the collection.

    -

    Type Parameters

    • T

    Parameters

    • iterator: ((item, index) => T)
        • (item, index): T

        • Parameters

          • item: any
          • index: number

          Returns T

    Returns T[]

populate

  • populate(expr): default<T>

  • Populates document references.

    -

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns default<T>

reduce

  • reduce<R>(iterator, initial?): R

  • Reduces a collection to a value which is the accumulated result of iterating +

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns default<T>

find

findOne

first

forEach

  • forEach(iterator): void

  • Iterates over all documents.

    +

    Parameters

    • iterator: ((item, index) => void)
        • (item, index): void

        • Parameters

          • item: any
          • index: number

          Returns void

    Returns void

last

limit

map

  • map<T>(iterator): T[]

  • Creates an array of values by iterating each element in the collection.

    +

    Type Parameters

    • T

    Parameters

    • iterator: ((item, index) => T)
        • (item, index): T

        • Parameters

          • item: any
          • index: number

          Returns T

    Returns T[]

populate

  • populate(expr): default<T>

  • Populates document references.

    +

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns default<T>

reduce

  • reduce<R>(iterator, initial?): R

  • Reduces a collection to a value which is the accumulated result of iterating each element in the collection.

    -

    Type Parameters

    • R

    Parameters

    • iterator: ((pre, cur, index) => R)
        • (pre, cur, index): R

        • Parameters

          • pre: any
          • cur: any
          • index: number

          Returns R

    • Optional initial: R

      By default, the initial value is the first document.

      -

    Returns R

reduceRight

  • reduceRight<R>(iterator, initial?): R

  • Reduces a collection to a value which is the accumulated result of iterating +

    Type Parameters

    • R

    Parameters

    • iterator: ((pre, cur, index) => R)
        • (pre, cur, index): R

        • Parameters

          • pre: any
          • cur: any
          • index: number

          Returns R

    • Optional initial: R

      By default, the initial value is the first document.

      +

    Returns R

reduceRight

  • reduceRight<R>(iterator, initial?): R

  • Reduces a collection to a value which is the accumulated result of iterating each element in the collection from right to left.

    -

    Type Parameters

    • R

    Parameters

    • iterator: ((pre, cur, index) => R)
        • (pre, cur, index): R

        • Parameters

          • pre: any
          • cur: any
          • index: number

          Returns R

    • Optional initial: R

      By default, the initial value is the last document.

      -

    Returns R

remove

  • remove(callback?): Bluebird<any>

  • Remove all documents.

    -

    Parameters

    Returns Bluebird<any>

replace

  • replace(data, callback?): Bluebird<any>

  • Replace all documents.

    -

    Parameters

    Returns Bluebird<any>

reverse

shuffle

skip

slice

  • slice(start, end?): default<T>

  • Returns the specified range of documents.

    -

    Parameters

    • start: number
    • Optional end: number

    Returns default<T>

some

  • some(iterator): boolean

  • Tests whether some documents pass the test implemented by the provided +

    Type Parameters

    • R

    Parameters

    • iterator: ((pre, cur, index) => R)
        • (pre, cur, index): R

        • Parameters

          • pre: any
          • cur: any
          • index: number

          Returns R

    • Optional initial: R

      By default, the initial value is the last document.

      +

    Returns R

remove

  • remove(callback?): Bluebird<any>

  • Remove all documents.

    +

    Parameters

    Returns Bluebird<any>

replace

  • replace(data, callback?): Bluebird<any>

  • Replace all documents.

    +

    Parameters

    Returns Bluebird<any>

reverse

shuffle

skip

slice

  • slice(start, end?): default<T>

  • Returns the specified range of documents.

    +

    Parameters

    • start: number
    • Optional end: number

    Returns default<T>

some

  • some(iterator): boolean

  • Tests whether some documents pass the test implemented by the provided function.

    -

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns boolean

sort

  • sort(orderby, order?): default<T>

  • Sorts documents.

    +

    Parameters

    • iterator: ((item, index) => boolean)
        • (item, index): boolean

        • Parameters

          • item: any
          • index: number

          Returns boolean

    Returns boolean

sort

  • sort(orderby, order?): default<T>

  • Sorts documents.

    Example:

    query.sort('date', -1);
    query.sort({date: -1, title: 1});
    query.sort('-date title');

    If the order equals to -1, desc or descending, the data will be returned in reversed order.

    -

    Parameters

    • orderby: string | object
    • Optional order: string | number | object

    Returns default<T>

toArray

update

  • update(data, callback?): Bluebird<any>

  • Update all documents.

    -

    Parameters

    Returns Bluebird<any>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Parameters

  • orderby: string | object
  • Optional order: string | number | object

Returns default<T>

toArray

update

  • update(data, callback?): Bluebird<any>

  • Update all documents.

    +

    Parameters

    Returns Bluebird<any>

Settings

Member Visibility

Theme

On This Page

constructor_model_schemadataeachlengthrandomsizecounteqeveryfilterfindfindOnefirstforEachlastlimitmappopulatereducereduceRightremovereplacereverseshuffleskipslicesomesorttoArrayupdate
\ No newline at end of file diff --git a/classes/schema.default.html b/classes/schema.default.html index 40bba5f..9cde7a4 100644 --- a/classes/schema.default.html +++ b/classes/schema.default.html @@ -1,46 +1,46 @@ -default | hexojs/warehouse

Class default

Constructors

constructor -

Properties

Types -hooks -methods -paths -stacks -statics -Types -

Methods

_applyGetters -_applySetters -_execQuery -_execSort -_exportDatabase -_parseDatabase -_parsePopulate -_parseSort -_parseUpdate -_updateStack -add -method -path -post -pre -static -virtual -

Constructors

constructor

Properties

Types

Types: types

hooks

hooks: {
    post: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    };
    pre: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    };
}

Type declaration

  • post: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    }
    • remove: ((...args) => Bluebird<any>)[]
    • save: ((...args) => Bluebird<any>)[]
  • pre: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    }
    • remove: ((...args) => Bluebird<any>)[]
    • save: ((...args) => Bluebird<any>)[]

methods

methods: Record<string, ((...args) => any)> = {}

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

paths

paths: Record<string, default<any>> = {}

stacks

stacks: {
    export: ((data) => void)[];
    getter: ((data) => void)[];
    import: ((data) => void)[];
    setter: ((data) => void)[];
}

Type declaration

  • export: ((data) => void)[]
  • getter: ((data) => void)[]
  • import: ((data) => void)[]
  • setter: ((data) => void)[]

statics

statics: Record<string, ((...args) => any)> = {}

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Static Types

Types: types = Types

Methods

Private _applyGetters

  • _applyGetters(data): void
  • Private

    Apply getters.

    -

    Parameters

    • data: object

    Returns void

Private _applySetters

  • _applySetters(data): void
  • Private

    Apply setters.

    -

    Parameters

    • data: object

    Returns void

Private _execQuery

  • _execQuery(query): queryFilterCallback
  • Private

    Returns a function for querying.

    -

    Parameters

    • query: object

    Returns queryFilterCallback

Private _execSort

  • _execSort(sorts): queryParseCallback
  • Private

    Returns a function for sorting.

    -

    Parameters

    • sorts: object

    Returns queryParseCallback

Private _exportDatabase

  • _exportDatabase(data): object
  • Private

    Exports database.

    -

    Parameters

    • data: object

    Returns object

Private _parseDatabase

  • _parseDatabase(data): object
  • Private

    Parses database.

    -

    Parameters

    • data: object

    Returns object

Private _parsePopulate

  • _parsePopulate(expr): PopulateResult[]
  • Private

    Parses population expression and returns a stack.

    -

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns PopulateResult[]

Private _parseSort

  • _parseSort(sorts, prefix?, stack?): queryParseCallback[]
  • Private

    Parses sorting expressions and returns a stack.

    -

    Parameters

    • sorts: object
    • Optional prefix: string = ''
    • Optional stack: queryParseCallback[] = []

    Returns queryParseCallback[]

Private _parseUpdate

  • _parseUpdate(updates): queryCallback[]
  • Private

    Parses updating expressions and returns a stack.

    -

    Parameters

    • updates: object

    Returns queryCallback[]

Private _updateStack

  • _updateStack(name, type): void
  • Private

    Updates cache stacks.

    -

    Parameters

    Returns void

add

method

  • method(name, fn): void

  • Adds a instance method.

    -

    Parameters

    • name: string
    • fn: ((...args) => any)
        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

path

post

  • post(type, fn): void

  • Adds a post-hook.

    -

    Parameters

    • type: "remove" | "save"

      Hook type. One of save or remove.

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

pre

  • pre(type, fn): void

  • Adds a pre-hook.

    -

    Parameters

    • type: "remove" | "save"

      Hook type. One of save or remove.

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

static

  • static(name, fn): void

  • Adds a static method.

    -

    Parameters

    • name: string
    • fn: ((...args) => any)
        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

virtual

  • virtual(name, getter?): default

  • Adds a virtual path.

    -

    Parameters

    • name: string
    • Optional getter: (() => any)
        • (): any

        • Returns any

    Returns default

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Constructors

constructor +

Properties

Types +hooks +methods +paths +stacks +statics +Types +

Methods

_applyGetters +_applySetters +_execQuery +_execSort +_exportDatabase +_parseDatabase +_parsePopulate +_parseSort +_parseUpdate +_updateStack +add +method +path +post +pre +static +virtual +

Constructors

constructor

Properties

Types

Types: types

hooks

hooks: {
    post: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    };
    pre: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    };
}

Type declaration

  • post: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    }
    • remove: ((...args) => Bluebird<any>)[]
    • save: ((...args) => Bluebird<any>)[]
  • pre: {
        remove: ((...args) => Bluebird<any>)[];
        save: ((...args) => Bluebird<any>)[];
    }
    • remove: ((...args) => Bluebird<any>)[]
    • save: ((...args) => Bluebird<any>)[]

methods

methods: Record<string, ((...args) => any)> = {}

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

paths

paths: Record<string, default<any>> = {}

stacks

stacks: {
    export: ((data) => void)[];
    getter: ((data) => void)[];
    import: ((data) => void)[];
    setter: ((data) => void)[];
}

Type declaration

  • export: ((data) => void)[]
  • getter: ((data) => void)[]
  • import: ((data) => void)[]
  • setter: ((data) => void)[]

statics

statics: Record<string, ((...args) => any)> = {}

Type declaration

    • (...args): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Static Types

Types: types = Types

Methods

Private _applyGetters

  • _applyGetters(data): void
  • Private

    Apply getters.

    +

    Parameters

    • data: object

    Returns void

Private _applySetters

  • _applySetters(data): void
  • Private

    Apply setters.

    +

    Parameters

    • data: object

    Returns void

Private _execQuery

  • _execQuery(query): queryFilterCallback
  • Private

    Returns a function for querying.

    +

    Parameters

    • query: object

    Returns queryFilterCallback

Private _execSort

  • _execSort(sorts): queryParseCallback
  • Private

    Returns a function for sorting.

    +

    Parameters

    • sorts: object

    Returns queryParseCallback

Private _exportDatabase

  • _exportDatabase(data): object
  • Private

    Exports database.

    +

    Parameters

    • data: object

    Returns object

Private _parseDatabase

  • _parseDatabase(data): object
  • Private

    Parses database.

    +

    Parameters

    • data: object

    Returns object

Private _parsePopulate

  • _parsePopulate(expr): PopulateResult[]
  • Private

    Parses population expression and returns a stack.

    +

    Parameters

    • expr: string | any[] | {
          model?: any;
          path?: string;
          [key: PropertyKey]: any;
      }

    Returns PopulateResult[]

Private _parseSort

  • _parseSort(sorts, prefix?, stack?): queryParseCallback[]
  • Private

    Parses sorting expressions and returns a stack.

    +

    Parameters

    • sorts: object
    • Optional prefix: string = ''
    • Optional stack: queryParseCallback[] = []

    Returns queryParseCallback[]

Private _parseUpdate

  • _parseUpdate(updates): queryCallback[]
  • Private

    Parses updating expressions and returns a stack.

    +

    Parameters

    • updates: object

    Returns queryCallback[]

Private _updateStack

  • _updateStack(name, type): void
  • Private

    Updates cache stacks.

    +

    Parameters

    Returns void

add

method

  • method(name, fn): void

  • Adds a instance method.

    +

    Parameters

    • name: string
    • fn: ((...args) => any)
        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

path

post

  • post(type, fn): void

  • Adds a post-hook.

    +

    Parameters

    • type: "remove" | "save"

      Hook type. One of save or remove.

      +
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

pre

  • pre(type, fn): void

  • Adds a pre-hook.

    +

    Parameters

    • type: "remove" | "save"

      Hook type. One of save or remove.

      +
    • fn: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns void

static

  • static(name, fn): void

  • Adds a static method.

    +

    Parameters

    • name: string
    • fn: ((...args) => any)
        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

    Returns void

virtual

  • virtual(name, getter?): default

  • Adds a virtual path.

    +

    Parameters

    • name: string
    • Optional getter: (() => any)
        • (): any

        • Returns any

    Returns default

Settings

Member Visibility

Theme

On This Page

constructorTypeshooksmethodspathsstacksstaticsTypes_applyGetters_applySetters_execQuery_execSort_exportDatabase_parseDatabase_parsePopulate_parseSort_parseUpdate_updateStackaddmethodpathpostprestaticvirtual
\ No newline at end of file diff --git a/classes/schematype.default.html b/classes/schematype.default.html index 1001eff..5d41f56 100644 --- a/classes/schematype.default.html +++ b/classes/schematype.default.html @@ -1,4 +1,4 @@ -default | hexojs/warehouse

Class default<T>

This is the basic schema type. +default | hexojs/warehouse

Class default<T>

This is the basic schema type. All schema types should inherit from this class. For example:

class SchemaTypeCustom extends SchemaType {};
@@ -21,50 +21,50 @@
 is the value passed to the update operator; the data parameter is the
 complete data.

 
The return value will replace the original data.

-

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default<T>(name?, options?): default<T>

  • SchemaType constructor.

    -

    Type Parameters

    • T

    Parameters

    • name: string = ''
    • Optional options: {
          default?: T | (() => T);
          required?: boolean;
      }
      • Optional default?: T | (() => T)
      • Optional required?: boolean

    Returns default<T>

Properties

default

default: (() => T)

Type declaration

    • (): T

    • Returns T

name

name: string = ''

options

options: {
    default?: T | (() => T);
    required: boolean;
}

Type declaration

  • Optional default?: T | (() => T)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value?, data?): unknown

  • Casts data. This function is used by getters to cast an object to document +

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default<T>(name?, options?): default<T>

  • SchemaType constructor.

    +

    Type Parameters

    • T

    Parameters

    • name: string = ''
    • Optional options: {
          default?: T | (() => T);
          required?: boolean;
      }
      • Optional default?: T | (() => T)
      • Optional required?: boolean

    Returns default<T>

Properties

default

default: (() => T)

Type declaration

    • (): T

    • Returns T

name

name: string = ''

options

options: {
    default?: T | (() => T);
    required: boolean;
}

Type declaration

  • Optional default?: T | (() => T)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value?, data?): unknown

  • Casts data. This function is used by getters to cast an object to document instances. If the value is null, the default value will be returned.

    -

    Parameters

    • Optional value: unknown
    • Optional data: unknown

    Returns unknown

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: T
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    -

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: T
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value, data?): unknown

  • Validates data. This function is used by setters.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns unknown

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Parameters

  • Optional value: unknown
  • Optional data: unknown

Returns unknown

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: T
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: T
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value, data?): unknown

  • Validates data. This function is used by setters.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns unknown

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_array.default.html b/classes/types_array.default.html index 4729dac..8a7d112 100644 --- a/classes/types_array.default.html +++ b/classes/types_array.default.html @@ -1,69 +1,69 @@ -default | hexojs/warehouse

Class default<I, T>

Array schema type.

-

Type Parameters

Hierarchy (view full)

Constructors

constructor -

Properties

child -default -name -options -q$exists -q$length -q$max -q$min -u$append -u$prepend -

Methods

cast -compare -match -parse -q$all -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -q$size -u$addToSet -u$pop -u$pull -u$push -u$rename -u$set -u$shift -u$unset -u$unshift -validate -value -

Constructors

constructor

Properties

child

child: T

default

default: (() => I[])

Type declaration

    • (): I[]

    • Returns I[]

name

name: string = ''

options

options: {
    default?: I[] | (() => I[]);
    required: boolean;
} & {
    child?: T;
}

Type declaration

  • Optional default?: I[] | (() => I[])
  • required: boolean

Type declaration

  • Optional child?: T

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$length

q$length: ((value?, query?, data?) => boolean)

Type declaration

    • (value?, query?, data?): boolean

    • Checks whether the number of elements in an array is equal to query.

      -

      Parameters

      • Optional value: unknown[]
      • Optional query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

u$append

u$append: (<T>(value?, update?, data?) => T[])

Type declaration

    • <T>(value?, update?, data?): T[]

    • Add elements to an array.

      -

      Type Parameters

      • T

      Parameters

      • Optional value: T[]
      • Optional update: T | T[]
      • Optional data: unknown

      Returns T[]

u$prepend

u$prepend: (<T>(value?, update?, data?) => T[])

Type declaration

    • <T>(value?, update?, data?): T[]

    • Add elements in front of an array.

      -

      Type Parameters

      • T

      Parameters

      • Optional value: T[]
      • Optional update: T | T[]
      • Optional data: unknown

      Returns T[]

Methods

cast

  • cast(value_, data?): I[]

  • Casts an array and its child elements.

    -

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns I[]

  • cast(value_?, data?): I[]

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns I[]

compare

  • compare(a?, b?): number

  • Compares an array by its child elements and the size of the array.

    -

    Parameters

    • Optional a: I[]
    • Optional b: I[]

    Returns number

match

  • match(value?, query?, data?): boolean

  • Checks the equality of an array.

    -

    Parameters

    • Optional value: I[]
    • Optional query: unknown[]
    • Optional data: unknown

    Returns boolean

parse

q$all

  • q$all<T>(value?, query?, data?): boolean

  • Checks whether an array contains all elements in query.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional query: T[]
    • Optional data: unknown

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value?, query?, data?): boolean

  • Checks whether an array contains one of elements in query.

    -

    Parameters

    • Optional value: unknown[]
    • Optional query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: I[]
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin<T>(value?, query?, data?): boolean

  • Checks whether an array does not contain in any elements in query.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional query: T[]
    • Optional data: unknown

    Returns boolean

q$size

  • q$size(value?, query?, data?): boolean

  • Checks whether the number of elements in an array is equal to query.

    -

    Parameters

    • Optional value: unknown[]
    • Optional query: unknown
    • Optional data: unknown

    Returns boolean

u$addToSet

  • u$addToSet<T>(value?, update?, data?): T[]

  • Add elements to an array only if the value is not already in the array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$pop

  • u$pop<T>(value?, update?, data?): T[]

  • Removes the last element from an array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: number | boolean
    • Optional data: unknown

    Returns T[]

u$pull

  • u$pull<T>(value?, update?, data?): T[]

  • Removes elements from an array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$push

  • u$push<T>(value?, update?, data?): T[]

  • Add elements to an array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$shift

  • u$shift<T>(value?, update?, data?): T[]

  • Removes the first element from an array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: number | boolean
    • Optional data: unknown

    Returns T[]

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

u$unshift

  • u$unshift<T>(value?, update?, data?): T[]

  • Add elements in front of an array.

    -

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

validate

  • validate(value_?, data?): I[]

  • Validates an array and its child elements.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns I[]

value

  • value(value, data?): any[]

  • Transforms data.

    -

    Parameters

    • value: unknown[]
    • Optional data: unknown

    Returns any[]

  • value(): undefined

  • Returns undefined

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default<I, T>

Array schema type.

+

Type Parameters

Hierarchy (view full)

Constructors

constructor +

Properties

child +default +name +options +q$exists +q$length +q$max +q$min +u$append +u$prepend +

Methods

cast +compare +match +parse +q$all +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +q$size +u$addToSet +u$pop +u$pull +u$push +u$rename +u$set +u$shift +u$unset +u$unshift +validate +value +

Constructors

constructor

Properties

child

child: T

default

default: (() => I[])

Type declaration

    • (): I[]

    • Returns I[]

name

name: string = ''

options

options: {
    default?: I[] | (() => I[]);
    required: boolean;
} & {
    child?: T;
}

Type declaration

  • Optional default?: I[] | (() => I[])
  • required: boolean

Type declaration

  • Optional child?: T

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$length

q$length: ((value?, query?, data?) => boolean)

Type declaration

    • (value?, query?, data?): boolean

    • Checks whether the number of elements in an array is equal to query.

      +

      Parameters

      • Optional value: unknown[]
      • Optional query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

u$append

u$append: (<T>(value?, update?, data?) => T[])

Type declaration

    • <T>(value?, update?, data?): T[]

    • Add elements to an array.

      +

      Type Parameters

      • T

      Parameters

      • Optional value: T[]
      • Optional update: T | T[]
      • Optional data: unknown

      Returns T[]

u$prepend

u$prepend: (<T>(value?, update?, data?) => T[])

Type declaration

    • <T>(value?, update?, data?): T[]

    • Add elements in front of an array.

      +

      Type Parameters

      • T

      Parameters

      • Optional value: T[]
      • Optional update: T | T[]
      • Optional data: unknown

      Returns T[]

Methods

cast

  • cast(value_, data?): I[]

  • Casts an array and its child elements.

    +

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns I[]

  • cast(value_?, data?): I[]

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns I[]

compare

  • compare(a?, b?): number

  • Compares an array by its child elements and the size of the array.

    +

    Parameters

    • Optional a: I[]
    • Optional b: I[]

    Returns number

match

  • match(value?, query?, data?): boolean

  • Checks the equality of an array.

    +

    Parameters

    • Optional value: I[]
    • Optional query: unknown[]
    • Optional data: unknown

    Returns boolean

parse

q$all

  • q$all<T>(value?, query?, data?): boolean

  • Checks whether an array contains all elements in query.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional query: T[]
    • Optional data: unknown

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value?, query?, data?): boolean

  • Checks whether an array contains one of elements in query.

    +

    Parameters

    • Optional value: unknown[]
    • Optional query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: I[]
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin<T>(value?, query?, data?): boolean

  • Checks whether an array does not contain in any elements in query.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional query: T[]
    • Optional data: unknown

    Returns boolean

q$size

  • q$size(value?, query?, data?): boolean

  • Checks whether the number of elements in an array is equal to query.

    +

    Parameters

    • Optional value: unknown[]
    • Optional query: unknown
    • Optional data: unknown

    Returns boolean

u$addToSet

  • u$addToSet<T>(value?, update?, data?): T[]

  • Add elements to an array only if the value is not already in the array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$pop

  • u$pop<T>(value?, update?, data?): T[]

  • Removes the last element from an array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: number | boolean
    • Optional data: unknown

    Returns T[]

u$pull

  • u$pull<T>(value?, update?, data?): T[]

  • Removes elements from an array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$push

  • u$push<T>(value?, update?, data?): T[]

  • Add elements to an array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$shift

  • u$shift<T>(value?, update?, data?): T[]

  • Removes the first element from an array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: number | boolean
    • Optional data: unknown

    Returns T[]

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

u$unshift

  • u$unshift<T>(value?, update?, data?): T[]

  • Add elements in front of an array.

    +

    Type Parameters

    • T

    Parameters

    • Optional value: T[]
    • Optional update: T | T[]
    • Optional data: unknown

    Returns T[]

validate

  • validate(value_?, data?): I[]

  • Validates an array and its child elements.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns I[]

value

  • value(value, data?): any[]

  • Transforms data.

    +

    Parameters

    • value: unknown[]
    • Optional data: unknown

    Returns any[]

  • value(): undefined

  • Returns undefined

Settings

Member Visibility

Theme

On This Page

constructorchilddefaultnameoptionsq$existsq$lengthq$maxq$minu$appendu$prependcastcomparematchparseq$allq$existq$gtq$gteq$inq$ltq$lteq$neq$ninq$sizeu$addToSetu$popu$pullu$pushu$renameu$setu$shiftu$unsetu$unshiftvalidatevalue
\ No newline at end of file diff --git a/classes/types_boolean.default.html b/classes/types_boolean.default.html index b6db08e..39a4f9f 100644 --- a/classes/types_boolean.default.html +++ b/classes/types_boolean.default.html @@ -1,47 +1,47 @@ -default | hexojs/warehouse

Class default

Boolean schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: boolean | (() => boolean);
          required?: boolean;
      }
      • Optional default?: boolean | (() => boolean)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

name

name: string = ''

options

options: {
    default?: boolean | (() => boolean);
    required: boolean;
}

Type declaration

  • Optional default?: boolean | (() => boolean)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_?, data?): boolean

  • Casts a boolean.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns boolean

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: boolean
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): boolean

  • Parses data and transform them into boolean values.

    -

    Parameters

    • value: unknown

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: boolean
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_, data?): boolean

  • Validates a boolean.

    -

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns boolean

value

  • value(value): number

  • Transforms data into number to compress the size of database files.

    -

    Parameters

    • value: unknown

    Returns number

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Boolean schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: boolean | (() => boolean);
          required?: boolean;
      }
      • Optional default?: boolean | (() => boolean)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => boolean)

Type declaration

    • (): boolean

    • Returns boolean

name

name: string = ''

options

options: {
    default?: boolean | (() => boolean);
    required: boolean;
}

Type declaration

  • Optional default?: boolean | (() => boolean)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_?, data?): boolean

  • Casts a boolean.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns boolean

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: boolean
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): boolean

  • Parses data and transform them into boolean values.

    +

    Parameters

    • value: unknown

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: boolean
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_, data?): boolean

  • Validates a boolean.

    +

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns boolean

value

  • value(value): number

  • Transforms data into number to compress the size of database files.

    +

    Parameters

    • value: unknown

    Returns number

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_buffer.default.html b/classes/types_buffer.default.html index b605543..3abb1e6 100644 --- a/classes/types_buffer.default.html +++ b/classes/types_buffer.default.html @@ -1,46 +1,46 @@ -default | hexojs/warehouse

Class default

Boolean schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name, options?): default

  • Parameters

    • name: string
    • Optional options: Partial<{
          default?: Buffer | (() => Buffer);
          required: boolean;
      }> & {
          encoding?: BufferEncoding;
      }

    Returns default

Properties

default

default: (() => Buffer)

Type declaration

    • (): Buffer

    • Returns Buffer

name

name: string = ''

options

options: {
    default?: Buffer | (() => Buffer);
    required: boolean;
} & {
    encoding: BufferEncoding;
}

Type declaration

  • Optional default?: Buffer | (() => Buffer)
  • required: boolean

Type declaration

  • encoding: BufferEncoding

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): Buffer

  • Casts data.

    -

    Parameters

    • value_: WithImplicitCoercion<string | Uint8Array | readonly number[]>
    • Optional data: unknown

    Returns Buffer

  • cast(value_?, data?): Buffer

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns Buffer

compare

  • compare(a?, b?): number

  • Compares between two buffers.

    -

    Parameters

    • Optional a: Buffer
    • Optional b: Buffer

    Returns number

match

  • match(value, query): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: Buffer
    • query: Buffer

    Returns boolean

parse

  • parse(value): Buffer

  • Parses data and transform them into buffer values.

    -

    Parameters

    • value: WithImplicitCoercion<string | Uint8Array | readonly number[]>

    Returns Buffer

  • parse(value?): Buffer

  • Parameters

    • Optional value: unknown

    Returns Buffer

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: Buffer
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

value

  • value(value?): string

  • Transforms data into number to compress the size of database files.

    -

    Parameters

    • Optional value: Buffer

    Returns string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Boolean schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name, options?): default

  • Parameters

    • name: string
    • Optional options: Partial<{
          default?: Buffer | (() => Buffer);
          required: boolean;
      }> & {
          encoding?: BufferEncoding;
      }

    Returns default

Properties

default

default: (() => Buffer)

Type declaration

    • (): Buffer

    • Returns Buffer

name

name: string = ''

options

options: {
    default?: Buffer | (() => Buffer);
    required: boolean;
} & {
    encoding: BufferEncoding;
}

Type declaration

  • Optional default?: Buffer | (() => Buffer)
  • required: boolean

Type declaration

  • encoding: BufferEncoding

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): Buffer

  • Casts data.

    +

    Parameters

    • value_: WithImplicitCoercion<string | Uint8Array | readonly number[]>
    • Optional data: unknown

    Returns Buffer

  • cast(value_?, data?): Buffer

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns Buffer

compare

  • compare(a?, b?): number

  • Compares between two buffers.

    +

    Parameters

    • Optional a: Buffer
    • Optional b: Buffer

    Returns number

match

  • match(value, query): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: Buffer
    • query: Buffer

    Returns boolean

parse

  • parse(value): Buffer

  • Parses data and transform them into buffer values.

    +

    Parameters

    • value: WithImplicitCoercion<string | Uint8Array | readonly number[]>

    Returns Buffer

  • parse(value?): Buffer

  • Parameters

    • Optional value: unknown

    Returns Buffer

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: Buffer
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

value

  • value(value?): string

  • Transforms data into number to compress the size of database files.

    +

    Parameters

    • Optional value: Buffer

    Returns string

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_cuid.default.html b/classes/types_cuid.default.html index 9144312..4cfe4dc 100644 --- a/classes/types_cuid.default.html +++ b/classes/types_cuid.default.html @@ -1,48 +1,48 @@ -default | hexojs/warehouse

Class default

CUID schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: string | (() => string);
          required?: boolean;
      }
      • Optional default?: string | (() => string)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => string)

Type declaration

    • (): string

    • Returns string

name

name: string = ''

options

options: {
    default?: string | (() => string);
    required: boolean;
}

Type declaration

  • Optional default?: string | (() => string)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value?): string

  • Casts data. Returns a new CUID only if value is null and the field is +default | hexojs/warehouse

    Class default

    CUID schema type.

    +

    Hierarchy (view full)

    Constructors

    constructor +

    Properties

    default +name +options +q$exists +q$max +q$min +

    Methods

    cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

    Constructors

    constructor

    • new default(name?, options?): default

    • SchemaType constructor.

      +

      Parameters

      • name: string = ''
      • Optional options: {
            default?: string | (() => string);
            required?: boolean;
        }
        • Optional default?: string | (() => string)
        • Optional required?: boolean

      Returns default

    Properties

    default

    default: (() => string)

    Type declaration

      • (): string

      • Returns string

    name

    name: string = ''

    options

    options: {
        default?: string | (() => string);
        required: boolean;
    }

    Type declaration

    • Optional default?: string | (() => string)
    • required: boolean

    q$exists

    q$exists: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks the existance of data.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$max

    q$max: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is less than or equal to (i.e. <=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$min

    q$min: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is greater than or equal to (i.e. >=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    Methods

    cast

    • cast(value?): string

    • Casts data. Returns a new CUID only if value is null and the field is required.

      -

      Parameters

      • Optional value: string

      Returns string

    compare

    • compare(a, b): number

    • Compares data. This function is used when sorting.

      -

      Parameters

      • a: unknown
      • b: unknown

      Returns number

    match

    • match(value, query, data?): boolean

    • Checks the equality of data.

      -

      Parameters

      • value: string
      • query: unknown
      • Optional data: unknown

      Returns boolean

    parse

    • parse(value): any

    • Parses data. This function is used when restoring data from database files.

      -

      Parameters

      • value: unknown

      Returns any

    q$exist

    • q$exist(value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gt

    • q$gt(value, query, data?): boolean

    • Checks whether value is greater than (i.e. >) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gte

    • q$gte(value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$in

    • q$in(value, query, data?): boolean

    • Checks whether value is equal to one of elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    q$lt

    • q$lt(value, query, data?): boolean

    • Checks whether value is less than (i.e. <) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$lte

    • q$lte(value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$ne

    • q$ne(value, query, data?): boolean

    • Checks the equality of data. Returns true if the value doesn't match.

      -

      Parameters

      • value: string
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$nin

    • q$nin(value, query, data?): boolean

    • Checks whether value is not equal to any elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    u$rename

    • u$rename(value, update, data): void

    • Renames a field.

      -

      Parameters

      • value: unknown
      • update: unknown
      • data: unknown

      Returns void

    u$set

    • u$set<T>(value, update, data?): T

    • Sets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: unknown
      • update: T
      • Optional data: unknown

      Returns T

    u$unset

    • u$unset<T>(value, update, data?): T

    • Unsets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: T
      • update: boolean
      • Optional data: unknown

      Returns T

    validate

    • validate(value?): string

    • Validates data. A valid CUID must be started with c and 25 in length.

      -

      Parameters

      • Optional value: string

      Returns string

    value

    • value(value, data?): any

    • Transforms value. This function is used when saving data to database files.

      -

      Parameters

      • value: unknown
      • Optional data: unknown

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Parameters

    • Optional value: string

    Returns string

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: string
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: string
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value?): string

  • Validates data. A valid CUID must be started with c and 25 in length.

    +

    Parameters

    • Optional value: string

    Returns string

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_date.default.html b/classes/types_date.default.html index bd0cc9e..b0c13d8 100644 --- a/classes/types_date.default.html +++ b/classes/types_date.default.html @@ -1,57 +1,57 @@ -default | hexojs/warehouse

Class default

Date schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$day -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$month -q$ne -q$nin -q$year -u$dec -u$inc -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: Date | (() => Date);
          required?: boolean;
      }
      • Optional default?: Date | (() => Date)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => Date)

Type declaration

    • (): Date

    • Returns Date

name

name: string = ''

options

options: {
    default?: Date | (() => Date);
    required: boolean;
}

Type declaration

  • Optional default?: Date | (() => Date)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_): Date

  • Casts data.

    -

    Parameters

    • value_: string | number | Date

    Returns Date

  • cast(value_?): Date

  • Parameters

    • Optional value_: unknown

    Returns Date

compare

  • compare(a?, b?): number

  • Compares between two dates.

    -

    Parameters

    • Optional a: Date
    • Optional b: Date

    Returns number

match

  • match(value, query): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: Date
    • query: Date

    Returns boolean

parse

  • parse(value): Date

  • Parses data and transforms it into a date object.

    -

    Parameters

    • value: string | number | Date

    Returns Date

  • parse(): undefined

  • Returns undefined

q$day

  • q$day(value, query): boolean

  • Finds data by its date.

    -

    Parameters

    • value: Date
    • query: number

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$month

  • q$month(value, query): boolean

  • Finds data by its month. (Start from 0)

    -

    Parameters

    • value: Date
    • query: number

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: Date
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$year

  • q$year(value, query): boolean

  • Finds data by its year. (4-digit)

    -

    Parameters

    • value: Date
    • query: number

    Returns boolean

u$dec

  • u$dec(value, update): Date

  • Subtracts milliseconds from date.

    -

    Parameters

    • value: Date
    • update: number

    Returns Date

u$inc

  • u$inc(value, update): Date

  • Adds milliseconds to date.

    -

    Parameters

    • value: Date
    • update: number

    Returns Date

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_, data?): Date

  • Validates data.

    -

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns Date

value

  • value(value): string

  • Transforms a date object to a string.

    -

    Parameters

    • value: Date

    Returns string

  • value(): undefined

  • Returns undefined

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Date schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$day +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$month +q$ne +q$nin +q$year +u$dec +u$inc +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: Date | (() => Date);
          required?: boolean;
      }
      • Optional default?: Date | (() => Date)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => Date)

Type declaration

    • (): Date

    • Returns Date

name

name: string = ''

options

options: {
    default?: Date | (() => Date);
    required: boolean;
}

Type declaration

  • Optional default?: Date | (() => Date)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_): Date

  • Casts data.

    +

    Parameters

    • value_: string | number | Date

    Returns Date

  • cast(value_?): Date

  • Parameters

    • Optional value_: unknown

    Returns Date

compare

  • compare(a?, b?): number

  • Compares between two dates.

    +

    Parameters

    • Optional a: Date
    • Optional b: Date

    Returns number

match

  • match(value, query): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: Date
    • query: Date

    Returns boolean

parse

  • parse(value): Date

  • Parses data and transforms it into a date object.

    +

    Parameters

    • value: string | number | Date

    Returns Date

  • parse(): undefined

  • Returns undefined

q$day

  • q$day(value, query): boolean

  • Finds data by its date.

    +

    Parameters

    • value: Date
    • query: number

    Returns boolean

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$month

  • q$month(value, query): boolean

  • Finds data by its month. (Start from 0)

    +

    Parameters

    • value: Date
    • query: number

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: Date
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$year

  • q$year(value, query): boolean

  • Finds data by its year. (4-digit)

    +

    Parameters

    • value: Date
    • query: number

    Returns boolean

u$dec

  • u$dec(value, update): Date

  • Subtracts milliseconds from date.

    +

    Parameters

    • value: Date
    • update: number

    Returns Date

u$inc

  • u$inc(value, update): Date

  • Adds milliseconds to date.

    +

    Parameters

    • value: Date
    • update: number

    Returns Date

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_, data?): Date

  • Validates data.

    +

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns Date

value

  • value(value): string

  • Transforms a date object to a string.

    +

    Parameters

    • value: Date

    Returns string

  • value(): undefined

  • Returns undefined

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$dayq$existq$gtq$gteq$inq$ltq$lteq$monthq$neq$ninq$yearu$decu$incu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_enum.default.html b/classes/types_enum.default.html index f15f893..e2828c8 100644 --- a/classes/types_enum.default.html +++ b/classes/types_enum.default.html @@ -1,47 +1,47 @@ -default | hexojs/warehouse

Class default

Enum schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name, options?): default

  • Parameters

    • name: string
    • Optional options: Partial<{
          default?: any[] | (() => any[]);
          required: boolean;
      }> & {
          elements?: any[];
      }

    Returns default

Properties

default

default: (() => any[])

Type declaration

    • (): any[]

    • Returns any[]

name

name: string = ''

options

options: {
    default?: any[] | (() => any[]);
    required: boolean;
} & {
    elements: any[];
}

Type declaration

  • Optional default?: any[] | (() => any[])
  • required: boolean

Type declaration

  • elements: any[]

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value?, data?): unknown

  • Casts data. This function is used by getters to cast an object to document +default | hexojs/warehouse

    Class default

    Enum schema type.

    +

    Hierarchy (view full)

    Constructors

    constructor +

    Properties

    default +name +options +q$exists +q$max +q$min +

    Methods

    cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

    Constructors

    constructor

    • new default(name, options?): default

    • Parameters

      • name: string
      • Optional options: Partial<{
            default?: any[] | (() => any[]);
            required: boolean;
        }> & {
            elements?: any[];
        }

      Returns default

    Properties

    default

    default: (() => any[])

    Type declaration

      • (): any[]

      • Returns any[]

    name

    name: string = ''

    options

    options: {
        default?: any[] | (() => any[]);
        required: boolean;
    } & {
        elements: any[];
    }

    Type declaration

    • Optional default?: any[] | (() => any[])
    • required: boolean

    Type declaration

    • elements: any[]

    q$exists

    q$exists: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks the existance of data.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$max

    q$max: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is less than or equal to (i.e. <=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$min

    q$min: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is greater than or equal to (i.e. >=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    Methods

    cast

    • cast(value?, data?): unknown

    • Casts data. This function is used by getters to cast an object to document instances. If the value is null, the default value will be returned.

      -

      Parameters

      • Optional value: unknown
      • Optional data: unknown

      Returns unknown

    compare

    • compare(a, b): number

    • Compares data. This function is used when sorting.

      -

      Parameters

      • a: unknown
      • b: unknown

      Returns number

    match

    • match(value, query, data?): boolean

    • Checks the equality of data.

      -

      Parameters

      • value: any[]
      • query: unknown
      • Optional data: unknown

      Returns boolean

    parse

    • parse(value): any

    • Parses data. This function is used when restoring data from database files.

      -

      Parameters

      • value: unknown

      Returns any

    q$exist

    • q$exist(value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gt

    • q$gt(value, query, data?): boolean

    • Checks whether value is greater than (i.e. >) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gte

    • q$gte(value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$in

    • q$in(value, query, data?): boolean

    • Checks whether value is equal to one of elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    q$lt

    • q$lt(value, query, data?): boolean

    • Checks whether value is less than (i.e. <) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$lte

    • q$lte(value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$ne

    • q$ne(value, query, data?): boolean

    • Checks the equality of data. Returns true if the value doesn't match.

      -

      Parameters

      • value: any[]
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$nin

    • q$nin(value, query, data?): boolean

    • Checks whether value is not equal to any elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    u$rename

    • u$rename(value, update, data): void

    • Renames a field.

      -

      Parameters

      • value: unknown
      • update: unknown
      • data: unknown

      Returns void

    u$set

    • u$set<T>(value, update, data?): T

    • Sets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: unknown
      • update: T
      • Optional data: unknown

      Returns T

    u$unset

    • u$unset<T>(value, update, data?): T

    • Unsets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: T
      • update: boolean
      • Optional data: unknown

      Returns T

    validate

    • validate(value_, data?): unknown

    • Validates data. The value must be one of elements set in the options.

      -

      Parameters

      • value_: unknown
      • Optional data: unknown

      Returns unknown

    value

    • value(value, data?): any

    • Transforms value. This function is used when saving data to database files.

      -

      Parameters

      • value: unknown
      • Optional data: unknown

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Parameters

    • Optional value: unknown
    • Optional data: unknown

    Returns unknown

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: any[]
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: any[]
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_, data?): unknown

  • Validates data. The value must be one of elements set in the options.

    +

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns unknown

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_integer.default.html b/classes/types_integer.default.html index 42215cd..9a2df52 100644 --- a/classes/types_integer.default.html +++ b/classes/types_integer.default.html @@ -1,61 +1,61 @@ -default | hexojs/warehouse

Class default

Integer schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$dec -u$div -u$inc -u$max -u$min -u$mod -u$mul -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: number | (() => number);
          required?: boolean;
      }
      • Optional default?: number | (() => number)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => number)

Type declaration

    • (): number

    • Returns number

name

name: string = ''

options

options: {
    default?: number | (() => number);
    required: boolean;
}

Type declaration

  • Optional default?: number | (() => number)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_?, data?): number

  • Casts a integer.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    -

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$dec

  • u$dec(value, update): number

  • Subtracts value from a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$div

  • u$div(value, update): number

  • Divides a number by a value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$inc

  • u$inc(value, update): number

  • Adds value to a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$max

  • u$max(value, update): number

  • Updates a number if the value is greater than the current value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$min

  • u$min(value, update): number

  • Updates a number if the value is less than the current value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$mod

  • u$mod(value, update): number

  • Divides a number by a value and returns the remainder.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$mul

  • u$mul(value, update): number

  • Multiplies value to a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): number

  • Validates an integer.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Integer schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$dec +u$div +u$inc +u$max +u$min +u$mod +u$mul +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: number | (() => number);
          required?: boolean;
      }
      • Optional default?: number | (() => number)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => number)

Type declaration

    • (): number

    • Returns number

name

name: string = ''

options

options: {
    default?: number | (() => number);
    required: boolean;
}

Type declaration

  • Optional default?: number | (() => number)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_?, data?): number

  • Casts a integer.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$dec

  • u$dec(value, update): number

  • Subtracts value from a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$div

  • u$div(value, update): number

  • Divides a number by a value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$inc

  • u$inc(value, update): number

  • Adds value to a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$max

  • u$max(value, update): number

  • Updates a number if the value is greater than the current value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$min

  • u$min(value, update): number

  • Updates a number if the value is less than the current value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$mod

  • u$mod(value, update): number

  • Divides a number by a value and returns the remainder.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$mul

  • u$mul(value, update): number

  • Multiplies value to a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): number

  • Validates an integer.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$decu$divu$incu$maxu$minu$modu$mulu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_number.default.html b/classes/types_number.default.html index 235098f..8820d5b 100644 --- a/classes/types_number.default.html +++ b/classes/types_number.default.html @@ -1,61 +1,61 @@ -default | hexojs/warehouse

Class default

Number schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$dec -u$div -u$inc -u$max -u$min -u$mod -u$mul -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: number | (() => number);
          required?: boolean;
      }
      • Optional default?: number | (() => number)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => number)

Type declaration

    • (): number

    • Returns number

name

name: string = ''

options

options: {
    default?: number | (() => number);
    required: boolean;
}

Type declaration

  • Optional default?: number | (() => number)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): number

  • Casts a number.

    -

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns number

  • cast(value_?, data?): number

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    -

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$dec

  • u$dec(value, update): number

  • Subtracts value from a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$div

  • u$div(value, update): number

  • Divides a number by a value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$inc

  • u$inc(value, update): number

  • Adds value to a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$max

  • u$max(value, update): number

  • Updates a number if the value is greater than the current value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$min

  • u$min(value, update): number

  • Updates a number if the value is less than the current value.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$mod

  • u$mod(value, update): number

  • Divides a number by a value and returns the remainder.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$mul

  • u$mul(value, update): number

  • Multiplies value to a number.

    -

    Parameters

    • value: number
    • update: number

    Returns number

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): number

  • Validates a number.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Number schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$dec +u$div +u$inc +u$max +u$min +u$mod +u$mul +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: number | (() => number);
          required?: boolean;
      }
      • Optional default?: number | (() => number)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => number)

Type declaration

    • (): number

    • Returns number

name

name: string = ''

options

options: {
    default?: number | (() => number);
    required: boolean;
}

Type declaration

  • Optional default?: number | (() => number)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): number

  • Casts a number.

    +

    Parameters

    • value_: unknown
    • Optional data: unknown

    Returns number

  • cast(value_?, data?): number

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: number
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$dec

  • u$dec(value, update): number

  • Subtracts value from a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$div

  • u$div(value, update): number

  • Divides a number by a value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$inc

  • u$inc(value, update): number

  • Adds value to a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$max

  • u$max(value, update): number

  • Updates a number if the value is greater than the current value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$min

  • u$min(value, update): number

  • Updates a number if the value is less than the current value.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$mod

  • u$mod(value, update): number

  • Divides a number by a value and returns the remainder.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$mul

  • u$mul(value, update): number

  • Multiplies value to a number.

    +

    Parameters

    • value: number
    • update: number

    Returns number

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): number

  • Validates a number.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns number

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$decu$divu$incu$maxu$minu$modu$mulu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_object.default.html b/classes/types_object.default.html index d846a32..182c9e0 100644 --- a/classes/types_object.default.html +++ b/classes/types_object.default.html @@ -1,47 +1,47 @@ -default | hexojs/warehouse

Class default

Object schema type.

-

Hierarchy (view full)

  • default<Record<string, any>>
    • default

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • Parameters

    • Optional name: string
    • Optional options: Partial<{
          default?: Record<string, any> | (() => Record<string, any>);
          required: boolean;
      }>

    Returns default

Properties

default

default: (() => Record<string, any>)

Type declaration

    • (): Record<string, any>

    • Returns Record<string, any>

name

name: string = ''

options

options: {
    default?: Record<string, any> | (() => Record<string, any>);
    required: boolean;
}

Type declaration

  • Optional default?: Record<string, any> | (() => Record<string, any>)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value?, data?): unknown

  • Casts data. This function is used by getters to cast an object to document +default | hexojs/warehouse

    Class default

    Object schema type.

    +

    Hierarchy (view full)

    • default<Record<string, any>>
      • default

    Constructors

    constructor +

    Properties

    default +name +options +q$exists +q$max +q$min +

    Methods

    cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

    Constructors

    constructor

    • new default(name?, options?): default

    • Parameters

      • Optional name: string
      • Optional options: Partial<{
            default?: Record<string, any> | (() => Record<string, any>);
            required: boolean;
        }>

      Returns default

    Properties

    default

    default: (() => Record<string, any>)

    Type declaration

      • (): Record<string, any>

      • Returns Record<string, any>

    name

    name: string = ''

    options

    options: {
        default?: Record<string, any> | (() => Record<string, any>);
        required: boolean;
    }

    Type declaration

    • Optional default?: Record<string, any> | (() => Record<string, any>)
    • required: boolean

    q$exists

    q$exists: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks the existance of data.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$max

    q$max: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is less than or equal to (i.e. <=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    q$min

    q$min: ((value, query, data?) => boolean)

    Type declaration

      • (value, query, data?): boolean

      • Checks whether value is greater than or equal to (i.e. >=) the query.

        +

        Parameters

        • value: unknown
        • query: unknown
        • Optional data: unknown

        Returns boolean

    Methods

    cast

    • cast(value?, data?): unknown

    • Casts data. This function is used by getters to cast an object to document instances. If the value is null, the default value will be returned.

      -

      Parameters

      • Optional value: unknown
      • Optional data: unknown

      Returns unknown

    compare

    • compare(a, b): number

    • Compares data. This function is used when sorting.

      -

      Parameters

      • a: unknown
      • b: unknown

      Returns number

    match

    • match(value, query, data?): boolean

    • Checks the equality of data.

      -

      Parameters

      • value: Record<string, any>
      • query: unknown
      • Optional data: unknown

      Returns boolean

    parse

    • parse(value): any

    • Parses data. This function is used when restoring data from database files.

      -

      Parameters

      • value: unknown

      Returns any

    q$exist

    • q$exist(value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gt

    • q$gt(value, query, data?): boolean

    • Checks whether value is greater than (i.e. >) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$gte

    • q$gte(value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$in

    • q$in(value, query, data?): boolean

    • Checks whether value is equal to one of elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    q$lt

    • q$lt(value, query, data?): boolean

    • Checks whether value is less than (i.e. <) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$lte

    • q$lte(value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$ne

    • q$ne(value, query, data?): boolean

    • Checks the equality of data. Returns true if the value doesn't match.

      -

      Parameters

      • value: Record<string, any>
      • query: unknown
      • Optional data: unknown

      Returns boolean

    q$nin

    • q$nin(value, query, data?): boolean

    • Checks whether value is not equal to any elements in query.

      -

      Parameters

      • value: unknown
      • query: unknown[]
      • Optional data: unknown

      Returns boolean

    u$rename

    • u$rename(value, update, data): void

    • Renames a field.

      -

      Parameters

      • value: unknown
      • update: unknown
      • data: unknown

      Returns void

    u$set

    • u$set<T>(value, update, data?): T

    • Sets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: unknown
      • update: T
      • Optional data: unknown

      Returns T

    u$unset

    • u$unset<T>(value, update, data?): T

    • Unsets the value.

      -

      Type Parameters

      • T

      Parameters

      • value: T
      • update: boolean
      • Optional data: unknown

      Returns T

    validate

    • validate(value, data?): unknown

    • Validates data. This function is used by setters.

      -

      Parameters

      • value: unknown
      • Optional data: unknown

      Returns unknown

    value

    • value(value, data?): any

    • Transforms value. This function is used when saving data to database files.

      -

      Parameters

      • value: unknown
      • Optional data: unknown

      Returns any

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Parameters

    • Optional value: unknown
    • Optional data: unknown

    Returns unknown

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: Record<string, any>
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: Record<string, any>
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value, data?): unknown

  • Validates data. This function is used by setters.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns unknown

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_string.default.html b/classes/types_string.default.html index 2cad343..d6ae1e2 100644 --- a/classes/types_string.default.html +++ b/classes/types_string.default.html @@ -1,49 +1,49 @@ -default | hexojs/warehouse

Class default

String schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -name -options -q$exists -q$max -q$min -

Methods

cast -compare -match -parse -q$exist -q$gt -q$gte -q$in -q$length -q$lt -q$lte -q$ne -q$nin -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: string | (() => string);
          required?: boolean;
      }
      • Optional default?: string | (() => string)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => string)

Type declaration

    • (): string

    • Returns string

name

name: string = ''

options

options: {
    default?: string | (() => string);
    required: boolean;
}

Type declaration

  • Optional default?: string | (() => string)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): string

  • Casts a string.

    -

    Parameters

    • value_: {
          toString(): string;
      }
    • Optional data: unknown

    Returns string

  • cast(value_?, data?): string

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns string

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: string
    • query: string | RegExp
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    -

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether a string is equal to one of elements in query.

    -

    Parameters

    • value: string
    • query: string[] | RegExp[]
    • Optional data: unknown

    Returns boolean

q$length

  • q$length(value, query): boolean

  • Checks length of a string.

    -

    Parameters

    • value: string
    • query: number

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: string
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether a string is not equal to any elements in query.

    -

    Parameters

    • value: string
    • query: string[] | RegExp[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): string

  • Validates a string.

    -

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns string

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

String schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +name +options +q$exists +q$max +q$min +

Methods

cast +compare +match +parse +q$exist +q$gt +q$gte +q$in +q$length +q$lt +q$lte +q$ne +q$nin +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: string | (() => string);
          required?: boolean;
      }
      • Optional default?: string | (() => string)
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => string)

Type declaration

    • (): string

    • Returns string

name

name: string = ''

options

options: {
    default?: string | (() => string);
    required: boolean;
}

Type declaration

  • Optional default?: string | (() => string)
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

Methods

cast

  • cast(value_, data?): string

  • Casts a string.

    +

    Parameters

    • value_: {
          toString(): string;
      }
    • Optional data: unknown

    Returns string

  • cast(value_?, data?): string

  • Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns string

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: string
    • query: string | RegExp
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether a string is equal to one of elements in query.

    +

    Parameters

    • value: string
    • query: string[] | RegExp[]
    • Optional data: unknown

    Returns boolean

q$length

  • q$length(value, query): boolean

  • Checks length of a string.

    +

    Parameters

    • value: string
    • query: number

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: string
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether a string is not equal to any elements in query.

    +

    Parameters

    • value: string
    • query: string[] | RegExp[]
    • Optional data: unknown

    Returns boolean

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

  • validate(value_?, data?): string

  • Validates a string.

    +

    Parameters

    • Optional value_: unknown
    • Optional data: unknown

    Returns string

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultnameoptionsq$existsq$maxq$mincastcomparematchparseq$existq$gtq$gteq$inq$lengthq$ltq$lteq$neq$ninu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/classes/types_virtual.default.html b/classes/types_virtual.default.html index 57a881c..9d61622 100644 --- a/classes/types_virtual.default.html +++ b/classes/types_virtual.default.html @@ -1,53 +1,53 @@ -default | hexojs/warehouse

Class default

Virtual schema type.

-

Hierarchy (view full)

Constructors

constructor -

Properties

default -getter -name -options -q$exists -q$max -q$min -setter -

Methods

cast -compare -get -match -parse -q$exist -q$gt -q$gte -q$in -q$lt -q$lte -q$ne -q$nin -set -u$rename -u$set -u$unset -validate -value -

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    -

    Parameters

    • name: string = ''
    • Optional options: {
          default?: any;
          required?: boolean;
      }
      • Optional default?: any
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => any)

Type declaration

    • (): any

    • Returns any

getter

getter: (() => any)

Type declaration

    • (): any

    • Returns any

name

name: string = ''

options

options: {
    default?: any;
    required: boolean;
}

Type declaration

  • Optional default?: any
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      -

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

setter

setter: ((value) => void)

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Methods

cast

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    -

    Parameters

    • a: unknown
    • b: unknown

    Returns number

get

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    -

    Parameters

    • value: any
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    -

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    -

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    -

    Parameters

    • value: any
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    -

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

set

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    -

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    -

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    -

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +default | hexojs/warehouse

Class default

Virtual schema type.

+

Hierarchy (view full)

Constructors

constructor +

Properties

default +getter +name +options +q$exists +q$max +q$min +setter +

Methods

cast +compare +get +match +parse +q$exist +q$gt +q$gte +q$in +q$lt +q$lte +q$ne +q$nin +set +u$rename +u$set +u$unset +validate +value +

Constructors

constructor

  • new default(name?, options?): default

  • SchemaType constructor.

    +

    Parameters

    • name: string = ''
    • Optional options: {
          default?: any;
          required?: boolean;
      }
      • Optional default?: any
      • Optional required?: boolean

    Returns default

Properties

default

default: (() => any)

Type declaration

    • (): any

    • Returns any

getter

getter: (() => any)

Type declaration

    • (): any

    • Returns any

name

name: string = ''

options

options: {
    default?: any;
    required: boolean;
}

Type declaration

  • Optional default?: any
  • required: boolean

q$exists

q$exists: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks the existance of data.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$max

q$max: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is less than or equal to (i.e. <=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

q$min

q$min: ((value, query, data?) => boolean)

Type declaration

    • (value, query, data?): boolean

    • Checks whether value is greater than or equal to (i.e. >=) the query.

      +

      Parameters

      • value: unknown
      • query: unknown
      • Optional data: unknown

      Returns boolean

setter

setter: ((value) => void)

Type declaration

    • (value): void

    • Parameters

      • value: any

      Returns void

Methods

cast

compare

  • compare(a, b): number

  • Compares data. This function is used when sorting.

    +

    Parameters

    • a: unknown
    • b: unknown

    Returns number

get

match

  • match(value, query, data?): boolean

  • Checks the equality of data.

    +

    Parameters

    • value: any
    • query: unknown
    • Optional data: unknown

    Returns boolean

parse

  • parse(value): any

  • Parses data. This function is used when restoring data from database files.

    +

    Parameters

    • value: unknown

    Returns any

q$exist

  • q$exist(value, query, data?): boolean

  • Checks the existance of data.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gt

  • q$gt(value, query, data?): boolean

  • Checks whether value is greater than (i.e. >) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$gte

  • q$gte(value, query, data?): boolean

  • Checks whether value is greater than or equal to (i.e. >=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$in

  • q$in(value, query, data?): boolean

  • Checks whether value is equal to one of elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

q$lt

  • q$lt(value, query, data?): boolean

  • Checks whether value is less than (i.e. <) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$lte

  • q$lte(value, query, data?): boolean

  • Checks whether value is less than or equal to (i.e. <=) the query.

    +

    Parameters

    • value: unknown
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$ne

  • q$ne(value, query, data?): boolean

  • Checks the equality of data. Returns true if the value doesn't match.

    +

    Parameters

    • value: any
    • query: unknown
    • Optional data: unknown

    Returns boolean

q$nin

  • q$nin(value, query, data?): boolean

  • Checks whether value is not equal to any elements in query.

    +

    Parameters

    • value: unknown
    • query: unknown[]
    • Optional data: unknown

    Returns boolean

set

u$rename

  • u$rename(value, update, data): void

  • Renames a field.

    +

    Parameters

    • value: unknown
    • update: unknown
    • data: unknown

    Returns void

u$set

  • u$set<T>(value, update, data?): T

  • Sets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: unknown
    • update: T
    • Optional data: unknown

    Returns T

u$unset

  • u$unset<T>(value, update, data?): T

  • Unsets the value.

    +

    Type Parameters

    • T

    Parameters

    • value: T
    • update: boolean
    • Optional data: unknown

    Returns T

validate

value

  • value(value, data?): any

  • Transforms value. This function is used when saving data to database files.

    +

    Parameters

    • value: unknown
    • Optional data: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

constructordefaultgetternameoptionsq$existsq$maxq$minsettercastcomparegetmatchparseq$existq$gtq$gteq$inq$ltq$lteq$neq$ninsetu$renameu$setu$unsetvalidatevalue
\ No newline at end of file diff --git a/functions/lib_jsonstream.parse.html b/functions/lib_jsonstream.parse.html index a3dcc2e..40ec00e 100644 --- a/functions/lib_jsonstream.parse.html +++ b/functions/lib_jsonstream.parse.html @@ -1 +1 @@ -parse | hexojs/warehouse

Function parse

Settings

Member Visibility

Theme

\ No newline at end of file +parse | hexojs/warehouse

Function parse

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/util.arr2obj.html b/functions/util.arr2obj.html index fcf4259..ecb5347 100644 --- a/functions/util.arr2obj.html +++ b/functions/util.arr2obj.html @@ -1 +1 @@ -arr2obj | hexojs/warehouse

Function arr2obj

  • arr2obj(arr, value): {}

  • Parameters

    • arr: any
    • value: any

    Returns {}

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +arr2obj | hexojs/warehouse

    Function arr2obj

    • arr2obj(arr, value): {}

    • Parameters

      • arr: any
      • value: any

      Returns {}

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.delProp.html b/functions/util.delProp.html index 7f7b346..044c85c 100644 --- a/functions/util.delProp.html +++ b/functions/util.delProp.html @@ -1 +1 @@ -delProp | hexojs/warehouse

      Function delProp

      • delProp(obj, key): void

      • Parameters

        • obj: any
        • key: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +delProp | hexojs/warehouse

      Function delProp

      • delProp(obj, key): void

      • Parameters

        • obj: any
        • key: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.getProp.html b/functions/util.getProp.html index 1acd2bb..8b37f97 100644 --- a/functions/util.getProp.html +++ b/functions/util.getProp.html @@ -1 +1 @@ -getProp | hexojs/warehouse

      Function getProp

      • getProp(obj, key): any

      • Parameters

        • obj: any
        • key: any

        Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +getProp | hexojs/warehouse

      Function getProp

      • getProp(obj, key): any

      • Parameters

        • obj: any
        • key: any

        Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.parseArgs.html b/functions/util.parseArgs.html index c072ecf..0434256 100644 --- a/functions/util.parseArgs.html +++ b/functions/util.parseArgs.html @@ -1 +1 @@ -parseArgs | hexojs/warehouse

      Function parseArgs

      • parseArgs(orderby, order?): any

      • Parameters

        • orderby: string | object
        • Optional order: string | number | object

        Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +parseArgs | hexojs/warehouse

      Function parseArgs

      • parseArgs(orderby, order?): any

      • Parameters

        • orderby: string | object
        • Optional order: string | number | object

        Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.reverse.html b/functions/util.reverse.html index 493411b..c12bb91 100644 --- a/functions/util.reverse.html +++ b/functions/util.reverse.html @@ -1 +1 @@ -reverse | hexojs/warehouse

      Function reverse

      • reverse(arr): any[]

      • Parameters

        • arr: any

        Returns any[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +reverse | hexojs/warehouse

      Function reverse

      • reverse(arr): any[]

      • Parameters

        • arr: any

        Returns any[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.setGetter.html b/functions/util.setGetter.html index d9d0de4..9094864 100644 --- a/functions/util.setGetter.html +++ b/functions/util.setGetter.html @@ -1 +1 @@ -setGetter | hexojs/warehouse

      Function setGetter

      • setGetter(obj, key, fn): void

      • Parameters

        • obj: any
        • key: any
        • fn: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +setGetter | hexojs/warehouse

      Function setGetter

      • setGetter(obj, key, fn): void

      • Parameters

        • obj: any
        • key: any
        • fn: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.setProp.html b/functions/util.setProp.html index 1aa80d6..5c73c76 100644 --- a/functions/util.setProp.html +++ b/functions/util.setProp.html @@ -1 +1 @@ -setProp | hexojs/warehouse

      Function setProp

      • setProp(obj, key, value): void

      • Parameters

        • obj: any
        • key: any
        • value: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +setProp | hexojs/warehouse

      Function setProp

      • setProp(obj, key, value): void

      • Parameters

        • obj: any
        • key: any
        • value: any

        Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/functions/util.shuffle.html b/functions/util.shuffle.html index 28841e0..883a600 100644 --- a/functions/util.shuffle.html +++ b/functions/util.shuffle.html @@ -1 +1 @@ -shuffle | hexojs/warehouse

      Function shuffle

      • shuffle(array): any[]

      • Parameters

        • array: any

        Returns any[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +shuffle | hexojs/warehouse

      Function shuffle

      • shuffle(array): any[]

      • Parameters

        • array: any

        Returns any[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/hierarchy.html b/hierarchy.html index c532af0..8233123 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -1 +1 @@ -hexojs/warehouse

      hexojs/warehouse

      Class Hierarchy

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +hexojs/warehouse

      hexojs/warehouse

      Class Hierarchy

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/index.html b/index.html index eb2bac6..c4ea9f9 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -hexojs/warehouse

      hexojs/warehouse

      Warehouse

      Tester +hexojs/warehouse

      hexojs/warehouse

      Warehouse

      Tester Pages Deployer NPM version Coverage Status

      @@ -22,4 +22,4 @@

      Test

      $ npm test
      -

      Settings

      Member Visibility

      Theme

      On This Page

      \ No newline at end of file +

      Settings

      Member Visibility

      Theme

      On This Page

      Warehouse
      \ No newline at end of file diff --git a/interfaces/types-1.AddSchemaTypeLoopOptions.html b/interfaces/types-1.AddSchemaTypeLoopOptions.html index ad692e6..5593a10 100644 --- a/interfaces/types-1.AddSchemaTypeLoopOptions.html +++ b/interfaces/types-1.AddSchemaTypeLoopOptions.html @@ -1 +1 @@ -AddSchemaTypeLoopOptions | hexojs/warehouse

      Interface AddSchemaTypeLoopOptions

      interface AddSchemaTypeLoopOptions {
          [key: string]: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions;
      }

      Indexable

      [key: string]: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AddSchemaTypeLoopOptions | hexojs/warehouse

      Interface AddSchemaTypeLoopOptions

      interface AddSchemaTypeLoopOptions {
          [key: string]: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions;
      }

      Indexable

      [key: string]: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/interfaces/types-1.Options.html b/interfaces/types-1.Options.html index d8354d2..1594916 100644 --- a/interfaces/types-1.Options.html +++ b/interfaces/types-1.Options.html @@ -1,4 +1,4 @@ -Options | hexojs/warehouse

      Interface Options

      interface Options {
          lean?: boolean;
          limit?: number;
          skip?: number;
          [key: PropertyKey]: any;
      }

      Indexable

      [key: PropertyKey]: any

      Properties

      lean? -limit? -skip? -

      Properties

      Optional lean

      lean?: boolean

      Optional limit

      limit?: number

      Optional skip

      skip?: number

      Settings

      Member Visibility

      Theme

      On This Page

      \ No newline at end of file +Options | hexojs/warehouse

      Interface Options

      interface Options {
          lean?: boolean;
          limit?: number;
          skip?: number;
          [key: PropertyKey]: any;
      }

      Indexable

      [key: PropertyKey]: any

      Properties

      lean? +limit? +skip? +

      Properties

      Optional lean

      lean?: boolean

      Optional limit

      limit?: number

      Optional skip

      skip?: number

      Settings

      Member Visibility

      Theme

      On This Page

      leanlimitskip
      \ No newline at end of file diff --git a/modules/database.html b/modules/database.html index 0427b2f..2fab3ec 100644 --- a/modules/database.html +++ b/modules/database.html @@ -1,2 +1,2 @@ -database | hexojs/warehouse

      Module database

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +database | hexojs/warehouse

      Module database

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/document.html b/modules/document.html index cb5283e..138401e 100644 --- a/modules/document.html +++ b/modules/document.html @@ -1,2 +1,2 @@ -document | hexojs/warehouse

      Module document

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +document | hexojs/warehouse

      Module document

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/error.html b/modules/error.html index d9b9eaf..8eab939 100644 --- a/modules/error.html +++ b/modules/error.html @@ -1,2 +1,2 @@ -error | hexojs/warehouse

      Module error

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +error | hexojs/warehouse

      Module error

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/error_population.html b/modules/error_population.html index 81afaed..79287a7 100644 --- a/modules/error_population.html +++ b/modules/error_population.html @@ -1,2 +1,2 @@ -error/population | hexojs/warehouse

      Module error/population

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +error/population | hexojs/warehouse

      Module error/population

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/error_validation.html b/modules/error_validation.html index de3fb1d..a5ece72 100644 --- a/modules/error_validation.html +++ b/modules/error_validation.html @@ -1,2 +1,2 @@ -error/validation | hexojs/warehouse

      Module error/validation

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +error/validation | hexojs/warehouse

      Module error/validation

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/lib_jsonstream.html b/modules/lib_jsonstream.html index dd04b52..80cbfe1 100644 --- a/modules/lib_jsonstream.html +++ b/modules/lib_jsonstream.html @@ -1,2 +1,2 @@ -lib/jsonstream | hexojs/warehouse

      Module lib/jsonstream

      Index

      Functions

      parse -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +lib/jsonstream | hexojs/warehouse

      Module lib/jsonstream

      Index

      Functions

      parse +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/model.html b/modules/model.html index c9da9c4..ce960d6 100644 --- a/modules/model.html +++ b/modules/model.html @@ -1,2 +1,2 @@ -model | hexojs/warehouse

      Module model

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +model | hexojs/warehouse

      Module model

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/mutex.html b/modules/mutex.html index b7f980b..1a47f64 100644 --- a/modules/mutex.html +++ b/modules/mutex.html @@ -1,2 +1,2 @@ -mutex | hexojs/warehouse

      Module mutex

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +mutex | hexojs/warehouse

      Module mutex

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/query.html b/modules/query.html index 28a3caf..0d39d9d 100644 --- a/modules/query.html +++ b/modules/query.html @@ -1,2 +1,2 @@ -query | hexojs/warehouse

      Module query

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +query | hexojs/warehouse

      Module query

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/schema.html b/modules/schema.html index a4d9858..4cd6a2b 100644 --- a/modules/schema.html +++ b/modules/schema.html @@ -1,2 +1,2 @@ -schema | hexojs/warehouse

      Module schema

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +schema | hexojs/warehouse

      Module schema

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/schematype.html b/modules/schematype.html index de1b472..3ffa8c7 100644 --- a/modules/schematype.html +++ b/modules/schematype.html @@ -1,2 +1,2 @@ -schematype | hexojs/warehouse

      Module schematype

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +schematype | hexojs/warehouse

      Module schematype

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types-1.html b/modules/types-1.html index a1afd27..e2f7348 100644 --- a/modules/types-1.html +++ b/modules/types-1.html @@ -1,9 +1,9 @@ -types | hexojs/warehouse

      Module types

      Index

      Interfaces

      AddSchemaTypeLoopOptions -Options -

      Type Aliases

      AddSchemaTypeMixedOptions -AddSchemaTypeOptions -AddSchemaTypeSimpleOptions -NodeJSLikeCallback -PopulateResult -SchemaTypeOptions -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types | hexojs/warehouse

      Module types

      Index

      Interfaces

      AddSchemaTypeLoopOptions +Options +

      Type Aliases

      AddSchemaTypeMixedOptions +AddSchemaTypeOptions +AddSchemaTypeSimpleOptions +NodeJSLikeCallback +PopulateResult +SchemaTypeOptions +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types.html b/modules/types.html index ff13097..90d0289 100644 --- a/modules/types.html +++ b/modules/types.html @@ -1,13 +1,13 @@ -types | hexojs/warehouse

      Module types

      References

      Array -Boolean -Buffer -CUID -Date -Enum -Integer -Mixed -Number -Object -String -Virtual -

      References

      Array

      Renames and re-exports default

      Boolean

      Renames and re-exports default

      Buffer

      Renames and re-exports default

      CUID

      Renames and re-exports default

      Date

      Renames and re-exports default

      Enum

      Renames and re-exports default

      Integer

      Renames and re-exports default

      Mixed

      Renames and re-exports default

      Number

      Renames and re-exports default

      Object

      Renames and re-exports default

      String

      Renames and re-exports default

      Virtual

      Renames and re-exports default

      Settings

      Member Visibility

      Theme

      On This Page

      \ No newline at end of file +types | hexojs/warehouse

      Module types

      References

      Array +Boolean +Buffer +CUID +Date +Enum +Integer +Mixed +Number +Object +String +Virtual +

      References

      Array

      Renames and re-exports default

      Boolean

      Renames and re-exports default

      Buffer

      Renames and re-exports default

      CUID

      Renames and re-exports default

      Date

      Renames and re-exports default

      Enum

      Renames and re-exports default

      Integer

      Renames and re-exports default

      Mixed

      Renames and re-exports default

      Number

      Renames and re-exports default

      Object

      Renames and re-exports default

      String

      Renames and re-exports default

      Virtual

      Renames and re-exports default

      Settings

      Member Visibility

      Theme

      On This Page

      ArrayBooleanBufferCUIDDateEnumIntegerMixedNumberObjectStringVirtual
      \ No newline at end of file diff --git a/modules/types_array.html b/modules/types_array.html index 394f711..70d16cc 100644 --- a/modules/types_array.html +++ b/modules/types_array.html @@ -1,2 +1,2 @@ -types/array | hexojs/warehouse

      Module types/array

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/array | hexojs/warehouse

      Module types/array

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_boolean.html b/modules/types_boolean.html index e2bb8d7..887109f 100644 --- a/modules/types_boolean.html +++ b/modules/types_boolean.html @@ -1,2 +1,2 @@ -types/boolean | hexojs/warehouse

      Module types/boolean

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/boolean | hexojs/warehouse

      Module types/boolean

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_buffer.html b/modules/types_buffer.html index 98eb08f..aa7874b 100644 --- a/modules/types_buffer.html +++ b/modules/types_buffer.html @@ -1,2 +1,2 @@ -types/buffer | hexojs/warehouse

      Module types/buffer

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/buffer | hexojs/warehouse

      Module types/buffer

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_cuid.html b/modules/types_cuid.html index 2f7a8b3..c8ca9f9 100644 --- a/modules/types_cuid.html +++ b/modules/types_cuid.html @@ -1,2 +1,2 @@ -types/cuid | hexojs/warehouse

      Module types/cuid

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/cuid | hexojs/warehouse

      Module types/cuid

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_date.html b/modules/types_date.html index 61e87e2..31d91fe 100644 --- a/modules/types_date.html +++ b/modules/types_date.html @@ -1,2 +1,2 @@ -types/date | hexojs/warehouse

      Module types/date

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/date | hexojs/warehouse

      Module types/date

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_enum.html b/modules/types_enum.html index 4d38949..3ab70f6 100644 --- a/modules/types_enum.html +++ b/modules/types_enum.html @@ -1,2 +1,2 @@ -types/enum | hexojs/warehouse

      Module types/enum

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/enum | hexojs/warehouse

      Module types/enum

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_integer.html b/modules/types_integer.html index 198ed6f..22e811d 100644 --- a/modules/types_integer.html +++ b/modules/types_integer.html @@ -1,2 +1,2 @@ -types/integer | hexojs/warehouse

      Module types/integer

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/integer | hexojs/warehouse

      Module types/integer

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_number.html b/modules/types_number.html index 0e14d61..686fea3 100644 --- a/modules/types_number.html +++ b/modules/types_number.html @@ -1,2 +1,2 @@ -types/number | hexojs/warehouse

      Module types/number

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/number | hexojs/warehouse

      Module types/number

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_object.html b/modules/types_object.html index bf08e5a..c871ff3 100644 --- a/modules/types_object.html +++ b/modules/types_object.html @@ -1,2 +1,2 @@ -types/object | hexojs/warehouse

      Module types/object

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/object | hexojs/warehouse

      Module types/object

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_string.html b/modules/types_string.html index 9063c4b..212dba7 100644 --- a/modules/types_string.html +++ b/modules/types_string.html @@ -1,2 +1,2 @@ -types/string | hexojs/warehouse

      Module types/string

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/string | hexojs/warehouse

      Module types/string

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/types_virtual.html b/modules/types_virtual.html index 74d57b9..942de13 100644 --- a/modules/types_virtual.html +++ b/modules/types_virtual.html @@ -1,2 +1,2 @@ -types/virtual | hexojs/warehouse

      Module types/virtual

      Index

      Classes

      default -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +types/virtual | hexojs/warehouse

      Module types/virtual

      Index

      Classes

      default +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/modules/util.html b/modules/util.html index bbb7bee..24f2b13 100644 --- a/modules/util.html +++ b/modules/util.html @@ -1,9 +1,9 @@ -util | hexojs/warehouse

      Module util

      Index

      Functions

      arr2obj -delProp -getProp -parseArgs -reverse -setGetter -setProp -shuffle -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +util | hexojs/warehouse

      Module util

      Index

      Functions

      arr2obj +delProp +getProp +parseArgs +reverse +setGetter +setProp +shuffle +

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.AddSchemaTypeMixedOptions.html b/types/types-1.AddSchemaTypeMixedOptions.html index ba33acf..8e5d08f 100644 --- a/types/types-1.AddSchemaTypeMixedOptions.html +++ b/types/types-1.AddSchemaTypeMixedOptions.html @@ -1 +1 @@ -AddSchemaTypeMixedOptions | hexojs/warehouse

      Type alias AddSchemaTypeMixedOptions

      AddSchemaTypeMixedOptions: AddSchemaTypeSimpleOptions | AddSchemaTypeSimpleOptions[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AddSchemaTypeMixedOptions | hexojs/warehouse

      Type alias AddSchemaTypeMixedOptions

      AddSchemaTypeMixedOptions: AddSchemaTypeSimpleOptions | AddSchemaTypeSimpleOptions[]

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.AddSchemaTypeOptions.html b/types/types-1.AddSchemaTypeOptions.html index f5d63a5..3408c63 100644 --- a/types/types-1.AddSchemaTypeOptions.html +++ b/types/types-1.AddSchemaTypeOptions.html @@ -1 +1 @@ -AddSchemaTypeOptions | hexojs/warehouse

      Type alias AddSchemaTypeOptions

      AddSchemaTypeOptions: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AddSchemaTypeOptions | hexojs/warehouse

      Type alias AddSchemaTypeOptions

      AddSchemaTypeOptions: AddSchemaTypeMixedOptions | AddSchemaTypeLoopOptions

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.AddSchemaTypeSimpleOptions.html b/types/types-1.AddSchemaTypeSimpleOptions.html index 5056d39..af28625 100644 --- a/types/types-1.AddSchemaTypeSimpleOptions.html +++ b/types/types-1.AddSchemaTypeSimpleOptions.html @@ -1 +1 @@ -AddSchemaTypeSimpleOptions | hexojs/warehouse

      Type alias AddSchemaTypeSimpleOptions

      AddSchemaTypeSimpleOptions: SchemaTypeOptions | {
          type: SchemaTypeOptions;
          [key: string]: any;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +AddSchemaTypeSimpleOptions | hexojs/warehouse

      Type alias AddSchemaTypeSimpleOptions

      AddSchemaTypeSimpleOptions: SchemaTypeOptions | {
          type: SchemaTypeOptions;
          [key: string]: any;
      }

      Type declaration

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.NodeJSLikeCallback.html b/types/types-1.NodeJSLikeCallback.html index 86036d3..ee42a5e 100644 --- a/types/types-1.NodeJSLikeCallback.html +++ b/types/types-1.NodeJSLikeCallback.html @@ -1 +1 @@ -NodeJSLikeCallback | hexojs/warehouse

      Type alias NodeJSLikeCallback<R, E>

      NodeJSLikeCallback<R, E>: ((err, result?) => void)

      Type Parameters

      • R

      • E = any

      Type declaration

        • (err, result?): void

        • Parameters

          • err: E
          • Optional result: R

          Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +NodeJSLikeCallback | hexojs/warehouse

      Type alias NodeJSLikeCallback<R, E>

      NodeJSLikeCallback<R, E>: ((err, result?) => void)

      Type Parameters

      • R
      • E = any

      Type declaration

        • (err, result?): void

        • Parameters

          • err: E
          • Optional result: R

          Returns void

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.PopulateResult.html b/types/types-1.PopulateResult.html index 974f7ee..4adf694 100644 --- a/types/types-1.PopulateResult.html +++ b/types/types-1.PopulateResult.html @@ -1 +1 @@ -PopulateResult | hexojs/warehouse

      Type alias PopulateResult

      PopulateResult: {
          model: any;
          path: string;
      }

      Type declaration

      • model: any
      • path: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +PopulateResult | hexojs/warehouse

      Type alias PopulateResult

      PopulateResult: {
          model: any;
          path: string;
      }

      Type declaration

      • model: any
      • path: string

      Settings

      Member Visibility

      Theme

      \ No newline at end of file diff --git a/types/types-1.SchemaTypeOptions.html b/types/types-1.SchemaTypeOptions.html index 760f67e..08a0f10 100644 --- a/types/types-1.SchemaTypeOptions.html +++ b/types/types-1.SchemaTypeOptions.html @@ -1 +1 @@ -SchemaTypeOptions | hexojs/warehouse

      Type alias SchemaTypeOptions

      SchemaTypeOptions: typeof default | default<unknown> | ((...args) => any)

      Type declaration

        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +SchemaTypeOptions | hexojs/warehouse

      Type alias SchemaTypeOptions

      SchemaTypeOptions: typeof default | default<unknown> | ((...args) => any)

      Type declaration

        • (...args): any

        • Parameters

          • Rest ...args: any[]

          Returns any

      Settings

      Member Visibility

      Theme

      \ No newline at end of file