From daf250261b5b20bb06e3c79cb547c424451821d8 Mon Sep 17 00:00:00 2001 From: Andrew Zolotukhin Date: Sun, 25 Jun 2023 03:47:39 +0300 Subject: [PATCH] feat(docs): docs for v1.1.4 --- docs/.typedoc-plugin-versions | 2 +- docs/dev | 2 +- docs/stable | 2 +- docs/v1.1 | 2 +- docs/v1.1.4/assets/gtm.js | 16 + docs/v1.1.4/assets/highlight.css | 99 ++ docs/v1.1.4/assets/main.js | 58 + docs/v1.1.4/assets/search.js | 1 + docs/v1.1.4/assets/style.css | 1279 +++++++++++++++++ docs/v1.1.4/assets/versionsMenu.js | 31 + .../classes/Async_utilities.Collector.html | 870 +++++++++++ .../classes/Job_Scheduler.JobScheduler.html | 1079 ++++++++++++++ .../Job_Scheduler.ScheduleCalculator.html | 115 ++ ...ition_And_Validation.AnySchemaBuilder.html | 327 +++++ ...ion_And_Validation.ArraySchemaBuilder.html | 423 ++++++ ...n_And_Validation.BooleanSchemaBuilder.html | 455 ++++++ ...tion_And_Validation.DateSchemaBuilder.html | 543 +++++++ ..._And_Validation.FunctionSchemaBuilder.html | 346 +++++ ...on_And_Validation.NumberSchemaBuilder.html | 541 +++++++ ...on_And_Validation.ObjectSchemaBuilder.html | 812 +++++++++++ ...finition_And_Validation.SchemaBuilder.html | 400 ++++++ ...on_And_Validation.StringSchemaBuilder.html | 564 ++++++++ ...ion_And_Validation.UnionSchemaBuilder.html | 447 ++++++ .../Deep_operations_on_objects.deepEqual.html | 87 ++ ...Deep_operations_on_objects.deepExtend.html | 69 + .../Schema_Definition_And_Validation.any.html | 85 ++ ...chema_Definition_And_Validation.array.html | 92 ++ ...ema_Definition_And_Validation.boolean.html | 79 + ...Schema_Definition_And_Validation.date.html | 79 + ...Schema_Definition_And_Validation.func.html | 81 ++ ...hema_Definition_And_Validation.number.html | 98 ++ ...hema_Definition_And_Validation.object.html | 98 ++ ...hema_Definition_And_Validation.string.html | 98 ++ ...chema_Definition_And_Validation.union.html | 91 ++ docs/v1.1.4/index.html | 47 + docs/v1.1.4/modules.html | 51 + docs/v1.1.4/modules/Async_utilities.html | 90 ++ .../modules/Deep_operations_on_objects.html | 129 ++ docs/v1.1.4/modules/Job_Scheduler.html | 89 ++ .../Schema_Definition_And_Validation.html | 197 +++ .../Deep_operations_on_objects.Merge.html | 60 + .../types/Job_Scheduler.TaskSchedule.html | 67 + ...a_Definition_And_Validation.InferType.html | 78 + ...efinition_And_Validation.MakeOptional.html | 78 + ...nition_And_Validation.ValidationError.html | 80 ++ ...ition_And_Validation.ValidationResult.html | 92 ++ .../Deep_operations_on_objects.default.html | 132 ++ .../variables/Job_Scheduler.Schemas.html | 73 + 48 files changed, 10630 insertions(+), 4 deletions(-) create mode 100644 docs/v1.1.4/assets/gtm.js create mode 100644 docs/v1.1.4/assets/highlight.css create mode 100644 docs/v1.1.4/assets/main.js create mode 100644 docs/v1.1.4/assets/search.js create mode 100644 docs/v1.1.4/assets/style.css create mode 100644 docs/v1.1.4/assets/versionsMenu.js create mode 100644 docs/v1.1.4/classes/Async_utilities.Collector.html create mode 100644 docs/v1.1.4/classes/Job_Scheduler.JobScheduler.html create mode 100644 docs/v1.1.4/classes/Job_Scheduler.ScheduleCalculator.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.AnySchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.DateSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.SchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.StringSchemaBuilder.html create mode 100644 docs/v1.1.4/classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html create mode 100644 docs/v1.1.4/functions/Deep_operations_on_objects.deepEqual.html create mode 100644 docs/v1.1.4/functions/Deep_operations_on_objects.deepExtend.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.any.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.array.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.boolean.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.date.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.func.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.number.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.object.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.string.html create mode 100644 docs/v1.1.4/functions/Schema_Definition_And_Validation.union.html create mode 100644 docs/v1.1.4/index.html create mode 100644 docs/v1.1.4/modules.html create mode 100644 docs/v1.1.4/modules/Async_utilities.html create mode 100644 docs/v1.1.4/modules/Deep_operations_on_objects.html create mode 100644 docs/v1.1.4/modules/Job_Scheduler.html create mode 100644 docs/v1.1.4/modules/Schema_Definition_And_Validation.html create mode 100644 docs/v1.1.4/types/Deep_operations_on_objects.Merge.html create mode 100644 docs/v1.1.4/types/Job_Scheduler.TaskSchedule.html create mode 100644 docs/v1.1.4/types/Schema_Definition_And_Validation.InferType.html create mode 100644 docs/v1.1.4/types/Schema_Definition_And_Validation.MakeOptional.html create mode 100644 docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationError.html create mode 100644 docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationResult.html create mode 100644 docs/v1.1.4/variables/Deep_operations_on_objects.default.html create mode 100644 docs/v1.1.4/variables/Job_Scheduler.Schemas.html diff --git a/docs/.typedoc-plugin-versions b/docs/.typedoc-plugin-versions index 3b9e78a..74724c8 100644 --- a/docs/.typedoc-plugin-versions +++ b/docs/.typedoc-plugin-versions @@ -1 +1 @@ -{"versions":["v1.1.1","v1.1.0","v1.0.0"],"stable":"v1.1.1"} +{"versions":["v1.1.4","v1.1.1","v1.1.0","v1.0.0"],"stable":"v1.1.4"} diff --git a/docs/dev b/docs/dev index f5e49ad..8045fa5 120000 --- a/docs/dev +++ b/docs/dev @@ -1 +1 @@ -/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.1 \ No newline at end of file +/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.4 \ No newline at end of file diff --git a/docs/stable b/docs/stable index f5e49ad..8045fa5 120000 --- a/docs/stable +++ b/docs/stable @@ -1 +1 @@ -/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.1 \ No newline at end of file +/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.4 \ No newline at end of file diff --git a/docs/v1.1 b/docs/v1.1 index f5e49ad..8045fa5 120000 --- a/docs/v1.1 +++ b/docs/v1.1 @@ -1 +1 @@ -/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.1 \ No newline at end of file +/home/andrew_zol/projects/cleverbrush-libs/docs/v1.1.4 \ No newline at end of file diff --git a/docs/v1.1.4/assets/gtm.js b/docs/v1.1.4/assets/gtm.js new file mode 100644 index 0000000..bfc8879 --- /dev/null +++ b/docs/v1.1.4/assets/gtm.js @@ -0,0 +1,16 @@ +// src/assets/gtm.ts +var scriptEl = document.getElementById("gtm"); +if (scriptEl) { + const gtmId = scriptEl.getAttribute("tagId"); + if (gtmId) { + (function(w, d, s, l, i) { + w[l] = w[l] || []; + w[l].push({ "gtm.start": (/* @__PURE__ */ new Date()).getTime(), event: "gtm.js" }); + var f = d.getElementsByTagName(s)[0], j = d.createElement(s), dl = l != "dataLayer" ? "&l=" + l : ""; + j.async = true; + j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl; + f.parentNode.insertBefore(j, f); + })(window, document, "script", "dataLayer", gtmId); + } +} +//# sourceMappingURL=gtm.js.map \ No newline at end of file diff --git a/docs/v1.1.4/assets/highlight.css b/docs/v1.1.4/assets/highlight.css new file mode 100644 index 0000000..688af9e --- /dev/null +++ b/docs/v1.1.4/assets/highlight.css @@ -0,0 +1,99 @@ +:root { + --light-hl-0: #000000; + --dark-hl-0: #D4D4D4; + --light-hl-1: #795E26; + --dark-hl-1: #DCDCAA; + --light-hl-2: #A31515; + --dark-hl-2: #CE9178; + --light-hl-3: #AF00DB; + --dark-hl-3: #C586C0; + --light-hl-4: #001080; + --dark-hl-4: #9CDCFE; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #267F99; + --dark-hl-6: #4EC9B0; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; + --light-hl-8: #098658; + --dark-hl-8: #B5CEA8; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; + --light-hl-10: #000000; + --dark-hl-10: #C8C8C8; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +pre, code { background: var(--code-background); } diff --git a/docs/v1.1.4/assets/main.js b/docs/v1.1.4/assets/main.js new file mode 100644 index 0000000..f7c8366 --- /dev/null +++ b/docs/v1.1.4/assets/main.js @@ -0,0 +1,58 @@ +"use strict"; +"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,he)=>{(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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.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()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);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)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(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"?pe(e,-1):s.key==="ArrowDown"?pe(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 Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(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 fe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),Le.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/docs/v1.1.4/assets/search.js b/docs/v1.1.4/assets/search.js new file mode 100644 index 0000000..fa58525 --- /dev/null +++ b/docs/v1.1.4/assets/search.js @@ -0,0 +1 @@ +window.searchData = JSON.parse("{\"kinds\":{\"2\":\"Module\",\"32\":\"Variable\",\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\",\"8388608\":\"Reference\"},\"rows\":[{\"kind\":2,\"name\":\"Async utilities\",\"url\":\"modules/Async_utilities.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":2,\"name\":\"Deep operations on objects\",\"url\":\"modules/Deep_operations_on_objects.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":32,\"name\":\"default\",\"url\":\"variables/Deep_operations_on_objects.default.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"Deep operations on objects\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"Deep operations on objects.default\"},{\"kind\":1024,\"name\":\"deepEqual\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepEqual\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Deep operations on objects.default.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepEqual.__type-1\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Deep operations on objects.default.__type.deepEqual\"},{\"kind\":1024,\"name\":\"deepExtend\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepExtend\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Deep operations on objects.default.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepExtend.__type-3\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Deep operations on objects.default.__type.deepExtend\"},{\"kind\":1024,\"name\":\"deepFlatten\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepFlatten\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Deep operations on objects.default.__type\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/Deep_operations_on_objects.default.html#__type.deepFlatten.__type-5\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"Deep operations on objects.default.__type.deepFlatten\"},{\"kind\":2,\"name\":\"Job Scheduler\",\"url\":\"modules/Job_Scheduler.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":128,\"name\":\"JobScheduler\",\"url\":\"classes/Job_Scheduler.JobScheduler.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Job Scheduler\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_rootFolder\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_rootFolder\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_status\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_status\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_defaultTimezone\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_defaultTimezone\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_checkTimer\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_checkTimer\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_jobsRepository\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_jobsRepository\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":1024,\"name\":\"_jobProps\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#_jobProps\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":262144,\"name\":\"status\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#status\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"getJobSchedule\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#getJobSchedule\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"runWorkerWithTimeout\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#runWorkerWithTimeout\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#runWorkerWithTimeout.runWorkerWithTimeout-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Job Scheduler.JobScheduler.runWorkerWithTimeout.runWorkerWithTimeout\"},{\"kind\":1024,\"name\":\"promise\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#runWorkerWithTimeout.runWorkerWithTimeout-1.__type.promise\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.JobScheduler.runWorkerWithTimeout.runWorkerWithTimeout.__type\"},{\"kind\":1024,\"name\":\"worker\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#runWorkerWithTimeout.runWorkerWithTimeout-1.__type.worker\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.JobScheduler.runWorkerWithTimeout.runWorkerWithTimeout.__type\"},{\"kind\":2048,\"name\":\"startJobInstance\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#startJobInstance\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"scheduleJobTo\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#scheduleJobTo\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"checkForUpcomingJobs\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#checkForUpcomingJobs\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"start\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#start\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"stop\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#stop\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"jobExists\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#jobExists\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"removeJob\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#removeJob\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"addJob\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#addJob\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2048,\"name\":\"on\",\"url\":\"classes/Job_Scheduler.JobScheduler.html#on\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.JobScheduler\"},{\"kind\":2,\"name\":\"Schema Definition And Validation\",\"url\":\"modules/Schema_Definition_And_Validation.html\",\"classes\":\"tsd-kind-module\"},{\"kind\":128,\"name\":\"Collector\",\"url\":\"classes/Async_utilities.Collector.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Async utilities\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Async_utilities.Collector.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Async utilities.Collector\"},{\"kind\":2048,\"name\":\"on\",\"url\":\"classes/Async_utilities.Collector.html#on\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Async utilities.Collector\"},{\"kind\":2048,\"name\":\"collect\",\"url\":\"classes/Async_utilities.Collector.html#collect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Async utilities.Collector\"},{\"kind\":2048,\"name\":\"toPromise\",\"url\":\"classes/Async_utilities.Collector.html#toPromise\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Async utilities.Collector\"},{\"kind\":64,\"name\":\"deepEqual\",\"url\":\"functions/Deep_operations_on_objects.deepEqual.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Deep operations on objects\"},{\"kind\":64,\"name\":\"deepExtend\",\"url\":\"functions/Deep_operations_on_objects.deepExtend.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Deep operations on objects\"},{\"kind\":8388608,\"name\":\"deepFlatten\",\"url\":\"modules/Deep_operations_on_objects.html#deepFlatten\",\"classes\":\"tsd-kind-reference tsd-parent-kind-module\",\"parent\":\"Deep operations on objects\"},{\"kind\":4194304,\"name\":\"Merge\",\"url\":\"types/Deep_operations_on_objects.Merge.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Deep operations on objects\"},{\"kind\":128,\"name\":\"ScheduleCalculator\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Job Scheduler\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Job Scheduler.ScheduleCalculator\"},{\"kind\":2048,\"name\":\"hasNext\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#hasNext\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.ScheduleCalculator\"},{\"kind\":2048,\"name\":\"next\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#next\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Job Scheduler.ScheduleCalculator\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#next.next-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Job Scheduler.ScheduleCalculator.next.next\"},{\"kind\":1024,\"name\":\"date\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#next.next-1.__type.date\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.ScheduleCalculator.next.next.__type\"},{\"kind\":1024,\"name\":\"index\",\"url\":\"classes/Job_Scheduler.ScheduleCalculator.html#next.next-1.__type.index\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.ScheduleCalculator.next.next.__type\"},{\"kind\":4194304,\"name\":\"TaskSchedule\",\"url\":\"types/Job_Scheduler.TaskSchedule.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Job Scheduler\"},{\"kind\":32,\"name\":\"Schemas\",\"url\":\"variables/Job_Scheduler.Schemas.html\",\"classes\":\"tsd-kind-variable tsd-parent-kind-module\",\"parent\":\"Job Scheduler\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-variable\",\"parent\":\"Job Scheduler.Schemas\"},{\"kind\":1024,\"name\":\"ScheduleSchemaBase\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleSchemaBase\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"CreateJobRequestSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.CreateJobRequestSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleMinuteSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleMinuteSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleDaySchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleDaySchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleWeekSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleWeekSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleMonthSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleMonthSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":1024,\"name\":\"ScheduleYearSchema\",\"url\":\"variables/Job_Scheduler.Schemas.html#__type.ScheduleYearSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Job Scheduler.Schemas.__type\"},{\"kind\":128,\"name\":\"AnySchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.AnySchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.AnySchemaBuilder\"},{\"kind\":128,\"name\":\"ArraySchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"elementSchema\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.elementSchema\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"of\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#of\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearOf\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#clearOf\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"minLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#minLength-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMinLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#clearMinLength\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"maxLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#maxLength-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMaxLength\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#clearMaxLength\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ArraySchemaBuilder\"},{\"kind\":128,\"name\":\"BooleanSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"equalsTo\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type.equalsTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"hasType\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#hasType\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearHasType\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#clearHasType\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"required\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#required\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"optional\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#optional\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"equals\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#equals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearEquals\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#clearEquals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.BooleanSchemaBuilder\"},{\"kind\":128,\"name\":\"DateSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"min\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.min\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"max\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.max\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"ensureIsInFuture\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.ensureIsInFuture\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"ensureIsInPast\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.ensureIsInPast\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"equalsTo\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.equalsTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"parseFromEpoch\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.parseFromEpoch\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"parseFromJson\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.parseFromJson\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"equals\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#equals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearEquals\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearEquals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"isInFuture\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#isInFuture\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearIsInFuture\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearIsInFuture\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"isInPast\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#isInPast\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearIsInPast\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearIsInPast\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"min\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#min-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMin\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearMin\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"max\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#max-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMax\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearMax\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"acceptJsonString\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#acceptJsonString\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"doNotAcceptJsonString\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#doNotAcceptJsonString\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"acceptEpoch\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#acceptEpoch\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"doNotAcceptEpoch\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#doNotAcceptEpoch\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.DateSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.DateSchemaBuilder\"},{\"kind\":128,\"name\":\"FunctionSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.FunctionSchemaBuilder\"},{\"kind\":128,\"name\":\"ObjectSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"properties\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.properties\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"acceptUnknownProps\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.acceptUnknownProps-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"acceptUnknownProps\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#acceptUnknownProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"notAcceptUnknownProps\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#notAcceptUnknownProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"addProp\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#addProp\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"addProps\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#addProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"omit\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#omit\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"intersect\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#intersect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"partial\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#partial\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"pick\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#pick\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"modifyPropSchema\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#modifyPropSchema\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"makePropOptional\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#makePropOptional\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"makePropRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#makePropRequired\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"makeAllPropsOptional\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#makeAllPropsOptional\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"makeAllPropsRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#makeAllPropsRequired\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.ObjectSchemaBuilder\"},{\"kind\":128,\"name\":\"NumberSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"min\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.min\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"max\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.max\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"ensureNotNaN\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.ensureNotNaN\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"ensureIsFinite\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.ensureIsFinite\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"equalsTo\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.equalsTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isInteger\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.isInteger\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"equals\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#equals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearEquals\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#clearEquals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"isFloat\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#isFloat\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"isInteger\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#isInteger-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"notNaN\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#notNaN\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"canBeNaN\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#canBeNaN\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"isFinite\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#isFinite\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"canBeInfinite\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#canBeInfinite\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"min\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#min-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMin\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#clearMin\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"max\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#max-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMax\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#clearMax\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.NumberSchemaBuilder\"},{\"kind\":128,\"name\":\"StringSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"minLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.minLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"maxLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.maxLength\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"equalsTo\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.equalsTo\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"startsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.startsWith\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"endsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.endsWith-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"matches\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.matches\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"equals\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#equals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearEquals\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearEquals\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"minLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#minLength-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMinLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearMinLength\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"maxLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#maxLength-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMaxLength\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearMaxLength\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"startsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#startsWith-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearStartsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearStartsWith\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"endsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#endsWith\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearEndsWith\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearEndsWith\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"matches\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#matches-1\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearMatches\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearMatches\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.StringSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.StringSchemaBuilder\"},{\"kind\":128,\"name\":\"UnionSchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":2048,\"name\":\"create\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#create\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"options\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type.options\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"or\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#or\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"removeOption\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#removeOption\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"removeFirstOption\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#removeFirstOption\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"reset\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#reset\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"Schema Definition And Validation.UnionSchemaBuilder\"},{\"kind\":128,\"name\":\"SchemaBuilder\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"hasType\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#hasType\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"clearHasType\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#clearHasType\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"createFromProps\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#createFromProps\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":262144,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#type\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":262144,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#preprocessors\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":262144,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#validators\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":262144,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#isRequired\",\"classes\":\"tsd-kind-accessor tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"preValidate\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#preValidate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"introspect\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect.introspect-1.__type\",\"classes\":\"tsd-kind-type-literal\",\"parent\":\"Schema Definition And Validation.SchemaBuilder.introspect.introspect\"},{\"kind\":1024,\"name\":\"type\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect.introspect-1.__type.type-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.SchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"isRequired\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect.introspect-1.__type.isRequired-3\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.SchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"preprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect.introspect-1.__type.preprocessors-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.SchemaBuilder.introspect.introspect.__type\"},{\"kind\":1024,\"name\":\"validators\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#introspect.introspect-1.__type.validators-2\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.SchemaBuilder.introspect.introspect.__type\"},{\"kind\":2048,\"name\":\"optional\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#optional\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"required\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#required\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"addPreprocessor\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#addPreprocessor\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"clearPreprocessors\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#clearPreprocessors\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"addValidator\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#addValidator\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"clearValidators\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#clearValidators\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":2048,\"name\":\"validate\",\"url\":\"classes/Schema_Definition_And_Validation.SchemaBuilder.html#validate\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Schema Definition And Validation.SchemaBuilder\"},{\"kind\":4194304,\"name\":\"InferType\",\"url\":\"types/Schema_Definition_And_Validation.InferType.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":4194304,\"name\":\"MakeOptional\",\"url\":\"types/Schema_Definition_And_Validation.MakeOptional.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":4194304,\"name\":\"ValidationError\",\"url\":\"types/Schema_Definition_And_Validation.ValidationError.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Schema_Definition_And_Validation.ValidationError.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Schema Definition And Validation.ValidationError\"},{\"kind\":1024,\"name\":\"path\",\"url\":\"types/Schema_Definition_And_Validation.ValidationError.html#__type.path\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ValidationError.__type\"},{\"kind\":1024,\"name\":\"message\",\"url\":\"types/Schema_Definition_And_Validation.ValidationError.html#__type.message\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ValidationError.__type\"},{\"kind\":4194304,\"name\":\"ValidationResult\",\"url\":\"types/Schema_Definition_And_Validation.ValidationResult.html\",\"classes\":\"tsd-kind-type-alias tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"types/Schema_Definition_And_Validation.ValidationResult.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"Schema Definition And Validation.ValidationResult\"},{\"kind\":1024,\"name\":\"valid\",\"url\":\"types/Schema_Definition_And_Validation.ValidationResult.html#__type.valid\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ValidationResult.__type\"},{\"kind\":1024,\"name\":\"object\",\"url\":\"types/Schema_Definition_And_Validation.ValidationResult.html#__type.object\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ValidationResult.__type\"},{\"kind\":1024,\"name\":\"errors\",\"url\":\"types/Schema_Definition_And_Validation.ValidationResult.html#__type.errors\",\"classes\":\"tsd-kind-property tsd-parent-kind-type-literal\",\"parent\":\"Schema Definition And Validation.ValidationResult.__type\"},{\"kind\":64,\"name\":\"any\",\"url\":\"functions/Schema_Definition_And_Validation.any.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"array\",\"url\":\"functions/Schema_Definition_And_Validation.array.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"boolean\",\"url\":\"functions/Schema_Definition_And_Validation.boolean.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"date\",\"url\":\"functions/Schema_Definition_And_Validation.date.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"func\",\"url\":\"functions/Schema_Definition_And_Validation.func.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"number\",\"url\":\"functions/Schema_Definition_And_Validation.number.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"object\",\"url\":\"functions/Schema_Definition_And_Validation.object.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"string\",\"url\":\"functions/Schema_Definition_And_Validation.string.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"},{\"kind\":64,\"name\":\"union\",\"url\":\"functions/Schema_Definition_And_Validation.union.html\",\"classes\":\"tsd-kind-function tsd-parent-kind-module\",\"parent\":\"Schema Definition And Validation\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,39.504,1,39.504]],[\"comment/0\",[]],[\"name/1\",[2,25.076,3,25.076,4,21.211,5,25.076]],[\"comment/1\",[]],[\"name/2\",[6,55.458]],[\"comment/2\",[]],[\"name/3\",[7,29.582]],[\"comment/3\",[]],[\"name/4\",[8,50.305]],[\"comment/4\",[]],[\"name/5\",[7,29.582]],[\"comment/5\",[]],[\"name/6\",[9,50.305]],[\"comment/6\",[]],[\"name/7\",[7,29.582]],[\"comment/7\",[]],[\"name/8\",[10,50.305]],[\"comment/8\",[]],[\"name/9\",[7,29.582]],[\"comment/9\",[]],[\"name/10\",[11,39.504,12,39.504]],[\"comment/10\",[]],[\"name/11\",[13,55.458]],[\"comment/11\",[]],[\"name/12\",[14,44.375]],[\"comment/12\",[]],[\"name/13\",[15,55.458]],[\"comment/13\",[]],[\"name/14\",[16,55.458]],[\"comment/14\",[]],[\"name/15\",[17,55.458]],[\"comment/15\",[]],[\"name/16\",[18,55.458]],[\"comment/16\",[]],[\"name/17\",[19,55.458]],[\"comment/17\",[]],[\"name/18\",[20,55.458]],[\"comment/18\",[]],[\"name/19\",[21,55.458]],[\"comment/19\",[]],[\"name/20\",[22,55.458]],[\"comment/20\",[]],[\"name/21\",[23,55.458]],[\"comment/21\",[]],[\"name/22\",[7,29.582]],[\"comment/22\",[]],[\"name/23\",[24,55.458]],[\"comment/23\",[]],[\"name/24\",[25,55.458]],[\"comment/24\",[]],[\"name/25\",[26,55.458]],[\"comment/25\",[]],[\"name/26\",[27,55.458]],[\"comment/26\",[]],[\"name/27\",[28,55.458]],[\"comment/27\",[]],[\"name/28\",[29,55.458]],[\"comment/28\",[]],[\"name/29\",[30,55.458]],[\"comment/29\",[]],[\"name/30\",[31,55.458]],[\"comment/30\",[]],[\"name/31\",[32,55.458]],[\"comment/31\",[]],[\"name/32\",[33,55.458]],[\"comment/32\",[]],[\"name/33\",[4,46.91]],[\"comment/33\",[]],[\"name/34\",[34,25.076,35,25.076,36,25.076,37,25.076]],[\"comment/34\",[]],[\"name/35\",[38,55.458]],[\"comment/35\",[]],[\"name/36\",[14,44.375]],[\"comment/36\",[]],[\"name/37\",[4,46.91]],[\"comment/37\",[]],[\"name/38\",[39,55.458]],[\"comment/38\",[]],[\"name/39\",[40,55.458]],[\"comment/39\",[]],[\"name/40\",[8,50.305]],[\"comment/40\",[]],[\"name/41\",[9,50.305]],[\"comment/41\",[]],[\"name/42\",[10,50.305]],[\"comment/42\",[]],[\"name/43\",[41,55.458]],[\"comment/43\",[]],[\"name/44\",[42,55.458]],[\"comment/44\",[]],[\"name/45\",[14,44.375]],[\"comment/45\",[]],[\"name/46\",[43,55.458]],[\"comment/46\",[]],[\"name/47\",[44,55.458]],[\"comment/47\",[]],[\"name/48\",[7,29.582]],[\"comment/48\",[]],[\"name/49\",[45,50.305]],[\"comment/49\",[]],[\"name/50\",[46,55.458]],[\"comment/50\",[]],[\"name/51\",[47,55.458]],[\"comment/51\",[]],[\"name/52\",[48,55.458]],[\"comment/52\",[]],[\"name/53\",[7,29.582]],[\"comment/53\",[]],[\"name/54\",[49,55.458]],[\"comment/54\",[]],[\"name/55\",[50,55.458]],[\"comment/55\",[]],[\"name/56\",[51,55.458]],[\"comment/56\",[]],[\"name/57\",[52,55.458]],[\"comment/57\",[]],[\"name/58\",[53,55.458]],[\"comment/58\",[]],[\"name/59\",[54,55.458]],[\"comment/59\",[]],[\"name/60\",[55,55.458]],[\"comment/60\",[]],[\"name/61\",[56,55.458]],[\"comment/61\",[]],[\"name/62\",[57,55.458]],[\"comment/62\",[]],[\"name/63\",[58,35.827]],[\"comment/63\",[]],[\"name/64\",[59,37.959]],[\"comment/64\",[]],[\"name/65\",[60,29.077]],[\"comment/65\",[]],[\"name/66\",[61,29.077]],[\"comment/66\",[]],[\"name/67\",[62,29.077]],[\"comment/67\",[]],[\"name/68\",[63,29.077]],[\"comment/68\",[]],[\"name/69\",[64,35.827]],[\"comment/69\",[]],[\"name/70\",[65,35.827]],[\"comment/70\",[]],[\"name/71\",[7,29.582]],[\"comment/71\",[]],[\"name/72\",[60,29.077]],[\"comment/72\",[]],[\"name/73\",[63,29.077]],[\"comment/73\",[]],[\"name/74\",[61,29.077]],[\"comment/74\",[]],[\"name/75\",[62,29.077]],[\"comment/75\",[]],[\"name/76\",[66,35.827]],[\"comment/76\",[]],[\"name/77\",[67,35.827]],[\"comment/77\",[]],[\"name/78\",[68,35.827]],[\"comment/78\",[]],[\"name/79\",[69,35.827]],[\"comment/79\",[]],[\"name/80\",[70,55.458]],[\"comment/80\",[]],[\"name/81\",[58,35.827]],[\"comment/81\",[]],[\"name/82\",[65,35.827]],[\"comment/82\",[]],[\"name/83\",[7,29.582]],[\"comment/83\",[]],[\"name/84\",[71,55.458]],[\"comment/84\",[]],[\"name/85\",[72,44.375]],[\"comment/85\",[]],[\"name/86\",[73,44.375]],[\"comment/86\",[]],[\"name/87\",[60,29.077]],[\"comment/87\",[]],[\"name/88\",[63,29.077]],[\"comment/88\",[]],[\"name/89\",[61,29.077]],[\"comment/89\",[]],[\"name/90\",[62,29.077]],[\"comment/90\",[]],[\"name/91\",[74,55.458]],[\"comment/91\",[]],[\"name/92\",[75,55.458]],[\"comment/92\",[]],[\"name/93\",[72,44.375]],[\"comment/93\",[]],[\"name/94\",[76,50.305]],[\"comment/94\",[]],[\"name/95\",[73,44.375]],[\"comment/95\",[]],[\"name/96\",[77,50.305]],[\"comment/96\",[]],[\"name/97\",[60,29.077]],[\"comment/97\",[]],[\"name/98\",[61,29.077]],[\"comment/98\",[]],[\"name/99\",[62,29.077]],[\"comment/99\",[]],[\"name/100\",[63,29.077]],[\"comment/100\",[]],[\"name/101\",[64,35.827]],[\"comment/101\",[]],[\"name/102\",[66,35.827]],[\"comment/102\",[]],[\"name/103\",[67,35.827]],[\"comment/103\",[]],[\"name/104\",[68,35.827]],[\"comment/104\",[]],[\"name/105\",[69,35.827]],[\"comment/105\",[]],[\"name/106\",[78,55.458]],[\"comment/106\",[]],[\"name/107\",[79,39.221]],[\"comment/107\",[]],[\"name/108\",[65,35.827]],[\"comment/108\",[]],[\"name/109\",[7,29.582]],[\"comment/109\",[]],[\"name/110\",[80,44.375]],[\"comment/110\",[]],[\"name/111\",[60,29.077]],[\"comment/111\",[]],[\"name/112\",[63,29.077]],[\"comment/112\",[]],[\"name/113\",[61,29.077]],[\"comment/113\",[]],[\"name/114\",[62,29.077]],[\"comment/114\",[]],[\"name/115\",[81,50.305]],[\"comment/115\",[]],[\"name/116\",[82,50.305]],[\"comment/116\",[]],[\"name/117\",[58,35.827]],[\"comment/117\",[]],[\"name/118\",[59,37.959]],[\"comment/118\",[]],[\"name/119\",[83,50.305]],[\"comment/119\",[]],[\"name/120\",[84,50.305]],[\"comment/120\",[]],[\"name/121\",[85,44.375]],[\"comment/121\",[]],[\"name/122\",[86,44.375]],[\"comment/122\",[]],[\"name/123\",[60,29.077]],[\"comment/123\",[]],[\"name/124\",[61,29.077]],[\"comment/124\",[]],[\"name/125\",[62,29.077]],[\"comment/125\",[]],[\"name/126\",[63,29.077]],[\"comment/126\",[]],[\"name/127\",[64,35.827]],[\"comment/127\",[]],[\"name/128\",[66,35.827]],[\"comment/128\",[]],[\"name/129\",[67,35.827]],[\"comment/129\",[]],[\"name/130\",[68,35.827]],[\"comment/130\",[]],[\"name/131\",[69,35.827]],[\"comment/131\",[]],[\"name/132\",[87,55.458]],[\"comment/132\",[]],[\"name/133\",[79,39.221]],[\"comment/133\",[]],[\"name/134\",[65,35.827]],[\"comment/134\",[]],[\"name/135\",[7,29.582]],[\"comment/135\",[]],[\"name/136\",[88,44.375]],[\"comment/136\",[]],[\"name/137\",[89,44.375]],[\"comment/137\",[]],[\"name/138\",[90,55.458]],[\"comment/138\",[]],[\"name/139\",[91,55.458]],[\"comment/139\",[]],[\"name/140\",[80,44.375]],[\"comment/140\",[]],[\"name/141\",[92,55.458]],[\"comment/141\",[]],[\"name/142\",[93,55.458]],[\"comment/142\",[]],[\"name/143\",[61,29.077]],[\"comment/143\",[]],[\"name/144\",[62,29.077]],[\"comment/144\",[]],[\"name/145\",[60,29.077]],[\"comment/145\",[]],[\"name/146\",[63,29.077]],[\"comment/146\",[]],[\"name/147\",[58,35.827]],[\"comment/147\",[]],[\"name/148\",[85,44.375]],[\"comment/148\",[]],[\"name/149\",[86,44.375]],[\"comment/149\",[]],[\"name/150\",[94,55.458]],[\"comment/150\",[]],[\"name/151\",[95,55.458]],[\"comment/151\",[]],[\"name/152\",[96,55.458]],[\"comment/152\",[]],[\"name/153\",[97,55.458]],[\"comment/153\",[]],[\"name/154\",[88,44.375]],[\"comment/154\",[]],[\"name/155\",[98,50.305]],[\"comment/155\",[]],[\"name/156\",[89,44.375]],[\"comment/156\",[]],[\"name/157\",[99,50.305]],[\"comment/157\",[]],[\"name/158\",[100,55.458]],[\"comment/158\",[]],[\"name/159\",[101,55.458]],[\"comment/159\",[]],[\"name/160\",[102,55.458]],[\"comment/160\",[]],[\"name/161\",[103,55.458]],[\"comment/161\",[]],[\"name/162\",[60,29.077]],[\"comment/162\",[]],[\"name/163\",[61,29.077]],[\"comment/163\",[]],[\"name/164\",[62,29.077]],[\"comment/164\",[]],[\"name/165\",[63,29.077]],[\"comment/165\",[]],[\"name/166\",[64,35.827]],[\"comment/166\",[]],[\"name/167\",[66,35.827]],[\"comment/167\",[]],[\"name/168\",[67,35.827]],[\"comment/168\",[]],[\"name/169\",[68,35.827]],[\"comment/169\",[]],[\"name/170\",[69,35.827]],[\"comment/170\",[]],[\"name/171\",[104,55.458]],[\"comment/171\",[]],[\"name/172\",[79,39.221]],[\"comment/172\",[]],[\"name/173\",[58,35.827]],[\"comment/173\",[]],[\"name/174\",[59,37.959]],[\"comment/174\",[]],[\"name/175\",[60,29.077]],[\"comment/175\",[]],[\"name/176\",[61,29.077]],[\"comment/176\",[]],[\"name/177\",[62,29.077]],[\"comment/177\",[]],[\"name/178\",[63,29.077]],[\"comment/178\",[]],[\"name/179\",[64,35.827]],[\"comment/179\",[]],[\"name/180\",[65,35.827]],[\"comment/180\",[]],[\"name/181\",[7,29.582]],[\"comment/181\",[]],[\"name/182\",[60,29.077]],[\"comment/182\",[]],[\"name/183\",[63,29.077]],[\"comment/183\",[]],[\"name/184\",[61,29.077]],[\"comment/184\",[]],[\"name/185\",[62,29.077]],[\"comment/185\",[]],[\"name/186\",[66,35.827]],[\"comment/186\",[]],[\"name/187\",[67,35.827]],[\"comment/187\",[]],[\"name/188\",[68,35.827]],[\"comment/188\",[]],[\"name/189\",[69,35.827]],[\"comment/189\",[]],[\"name/190\",[105,55.458]],[\"comment/190\",[]],[\"name/191\",[79,39.221]],[\"comment/191\",[]],[\"name/192\",[59,37.959]],[\"comment/192\",[]],[\"name/193\",[65,35.827]],[\"comment/193\",[]],[\"name/194\",[7,29.582]],[\"comment/194\",[]],[\"name/195\",[106,55.458]],[\"comment/195\",[]],[\"name/196\",[107,50.305]],[\"comment/196\",[]],[\"name/197\",[60,29.077]],[\"comment/197\",[]],[\"name/198\",[63,29.077]],[\"comment/198\",[]],[\"name/199\",[61,29.077]],[\"comment/199\",[]],[\"name/200\",[62,29.077]],[\"comment/200\",[]],[\"name/201\",[58,35.827]],[\"comment/201\",[]],[\"name/202\",[107,50.305]],[\"comment/202\",[]],[\"name/203\",[108,55.458]],[\"comment/203\",[]],[\"name/204\",[109,55.458]],[\"comment/204\",[]],[\"name/205\",[110,55.458]],[\"comment/205\",[]],[\"name/206\",[111,55.458]],[\"comment/206\",[]],[\"name/207\",[112,55.458]],[\"comment/207\",[]],[\"name/208\",[113,55.458]],[\"comment/208\",[]],[\"name/209\",[114,55.458]],[\"comment/209\",[]],[\"name/210\",[115,55.458]],[\"comment/210\",[]],[\"name/211\",[116,55.458]],[\"comment/211\",[]],[\"name/212\",[117,55.458]],[\"comment/212\",[]],[\"name/213\",[118,55.458]],[\"comment/213\",[]],[\"name/214\",[119,55.458]],[\"comment/214\",[]],[\"name/215\",[60,29.077]],[\"comment/215\",[]],[\"name/216\",[61,29.077]],[\"comment/216\",[]],[\"name/217\",[62,29.077]],[\"comment/217\",[]],[\"name/218\",[63,29.077]],[\"comment/218\",[]],[\"name/219\",[64,35.827]],[\"comment/219\",[]],[\"name/220\",[66,35.827]],[\"comment/220\",[]],[\"name/221\",[67,35.827]],[\"comment/221\",[]],[\"name/222\",[68,35.827]],[\"comment/222\",[]],[\"name/223\",[69,35.827]],[\"comment/223\",[]],[\"name/224\",[120,55.458]],[\"comment/224\",[]],[\"name/225\",[79,39.221]],[\"comment/225\",[]],[\"name/226\",[65,35.827]],[\"comment/226\",[]],[\"name/227\",[7,29.582]],[\"comment/227\",[]],[\"name/228\",[88,44.375]],[\"comment/228\",[]],[\"name/229\",[89,44.375]],[\"comment/229\",[]],[\"name/230\",[121,55.458]],[\"comment/230\",[]],[\"name/231\",[122,55.458]],[\"comment/231\",[]],[\"name/232\",[80,44.375]],[\"comment/232\",[]],[\"name/233\",[123,50.305]],[\"comment/233\",[]],[\"name/234\",[61,29.077]],[\"comment/234\",[]],[\"name/235\",[62,29.077]],[\"comment/235\",[]],[\"name/236\",[60,29.077]],[\"comment/236\",[]],[\"name/237\",[63,29.077]],[\"comment/237\",[]],[\"name/238\",[58,35.827]],[\"comment/238\",[]],[\"name/239\",[59,37.959]],[\"comment/239\",[]],[\"name/240\",[85,44.375]],[\"comment/240\",[]],[\"name/241\",[86,44.375]],[\"comment/241\",[]],[\"name/242\",[124,55.458]],[\"comment/242\",[]],[\"name/243\",[123,50.305]],[\"comment/243\",[]],[\"name/244\",[125,55.458]],[\"comment/244\",[]],[\"name/245\",[126,55.458]],[\"comment/245\",[]],[\"name/246\",[127,55.458]],[\"comment/246\",[]],[\"name/247\",[128,55.458]],[\"comment/247\",[]],[\"name/248\",[88,44.375]],[\"comment/248\",[]],[\"name/249\",[98,50.305]],[\"comment/249\",[]],[\"name/250\",[89,44.375]],[\"comment/250\",[]],[\"name/251\",[99,50.305]],[\"comment/251\",[]],[\"name/252\",[60,29.077]],[\"comment/252\",[]],[\"name/253\",[61,29.077]],[\"comment/253\",[]],[\"name/254\",[62,29.077]],[\"comment/254\",[]],[\"name/255\",[63,29.077]],[\"comment/255\",[]],[\"name/256\",[64,35.827]],[\"comment/256\",[]],[\"name/257\",[66,35.827]],[\"comment/257\",[]],[\"name/258\",[67,35.827]],[\"comment/258\",[]],[\"name/259\",[68,35.827]],[\"comment/259\",[]],[\"name/260\",[69,35.827]],[\"comment/260\",[]],[\"name/261\",[129,55.458]],[\"comment/261\",[]],[\"name/262\",[79,39.221]],[\"comment/262\",[]],[\"name/263\",[65,35.827]],[\"comment/263\",[]],[\"name/264\",[7,29.582]],[\"comment/264\",[]],[\"name/265\",[72,44.375]],[\"comment/265\",[]],[\"name/266\",[73,44.375]],[\"comment/266\",[]],[\"name/267\",[80,44.375]],[\"comment/267\",[]],[\"name/268\",[130,50.305]],[\"comment/268\",[]],[\"name/269\",[131,50.305]],[\"comment/269\",[]],[\"name/270\",[132,50.305]],[\"comment/270\",[]],[\"name/271\",[61,29.077]],[\"comment/271\",[]],[\"name/272\",[62,29.077]],[\"comment/272\",[]],[\"name/273\",[60,29.077]],[\"comment/273\",[]],[\"name/274\",[63,29.077]],[\"comment/274\",[]],[\"name/275\",[58,35.827]],[\"comment/275\",[]],[\"name/276\",[59,37.959]],[\"comment/276\",[]],[\"name/277\",[85,44.375]],[\"comment/277\",[]],[\"name/278\",[86,44.375]],[\"comment/278\",[]],[\"name/279\",[72,44.375]],[\"comment/279\",[]],[\"name/280\",[76,50.305]],[\"comment/280\",[]],[\"name/281\",[73,44.375]],[\"comment/281\",[]],[\"name/282\",[77,50.305]],[\"comment/282\",[]],[\"name/283\",[130,50.305]],[\"comment/283\",[]],[\"name/284\",[133,55.458]],[\"comment/284\",[]],[\"name/285\",[131,50.305]],[\"comment/285\",[]],[\"name/286\",[134,55.458]],[\"comment/286\",[]],[\"name/287\",[132,50.305]],[\"comment/287\",[]],[\"name/288\",[135,55.458]],[\"comment/288\",[]],[\"name/289\",[60,29.077]],[\"comment/289\",[]],[\"name/290\",[61,29.077]],[\"comment/290\",[]],[\"name/291\",[62,29.077]],[\"comment/291\",[]],[\"name/292\",[63,29.077]],[\"comment/292\",[]],[\"name/293\",[64,35.827]],[\"comment/293\",[]],[\"name/294\",[66,35.827]],[\"comment/294\",[]],[\"name/295\",[67,35.827]],[\"comment/295\",[]],[\"name/296\",[68,35.827]],[\"comment/296\",[]],[\"name/297\",[69,35.827]],[\"comment/297\",[]],[\"name/298\",[136,55.458]],[\"comment/298\",[]],[\"name/299\",[79,39.221]],[\"comment/299\",[]],[\"name/300\",[65,35.827]],[\"comment/300\",[]],[\"name/301\",[7,29.582]],[\"comment/301\",[]],[\"name/302\",[137,55.458]],[\"comment/302\",[]],[\"name/303\",[60,29.077]],[\"comment/303\",[]],[\"name/304\",[63,29.077]],[\"comment/304\",[]],[\"name/305\",[61,29.077]],[\"comment/305\",[]],[\"name/306\",[62,29.077]],[\"comment/306\",[]],[\"name/307\",[58,35.827]],[\"comment/307\",[]],[\"name/308\",[59,37.959]],[\"comment/308\",[]],[\"name/309\",[138,55.458]],[\"comment/309\",[]],[\"name/310\",[139,55.458]],[\"comment/310\",[]],[\"name/311\",[140,55.458]],[\"comment/311\",[]],[\"name/312\",[141,55.458]],[\"comment/312\",[]],[\"name/313\",[60,29.077]],[\"comment/313\",[]],[\"name/314\",[61,29.077]],[\"comment/314\",[]],[\"name/315\",[62,29.077]],[\"comment/315\",[]],[\"name/316\",[63,29.077]],[\"comment/316\",[]],[\"name/317\",[64,35.827]],[\"comment/317\",[]],[\"name/318\",[66,35.827]],[\"comment/318\",[]],[\"name/319\",[67,35.827]],[\"comment/319\",[]],[\"name/320\",[68,35.827]],[\"comment/320\",[]],[\"name/321\",[69,35.827]],[\"comment/321\",[]],[\"name/322\",[142,55.458]],[\"comment/322\",[]],[\"name/323\",[14,44.375]],[\"comment/323\",[]],[\"name/324\",[81,50.305]],[\"comment/324\",[]],[\"name/325\",[82,50.305]],[\"comment/325\",[]],[\"name/326\",[59,37.959]],[\"comment/326\",[]],[\"name/327\",[60,29.077]],[\"comment/327\",[]],[\"name/328\",[61,29.077]],[\"comment/328\",[]],[\"name/329\",[62,29.077]],[\"comment/329\",[]],[\"name/330\",[63,29.077]],[\"comment/330\",[]],[\"name/331\",[64,35.827]],[\"comment/331\",[]],[\"name/332\",[65,35.827]],[\"comment/332\",[]],[\"name/333\",[7,29.582]],[\"comment/333\",[]],[\"name/334\",[60,29.077]],[\"comment/334\",[]],[\"name/335\",[63,29.077]],[\"comment/335\",[]],[\"name/336\",[61,29.077]],[\"comment/336\",[]],[\"name/337\",[62,29.077]],[\"comment/337\",[]],[\"name/338\",[84,50.305]],[\"comment/338\",[]],[\"name/339\",[83,50.305]],[\"comment/339\",[]],[\"name/340\",[66,35.827]],[\"comment/340\",[]],[\"name/341\",[67,35.827]],[\"comment/341\",[]],[\"name/342\",[68,35.827]],[\"comment/342\",[]],[\"name/343\",[69,35.827]],[\"comment/343\",[]],[\"name/344\",[58,35.827]],[\"comment/344\",[]],[\"name/345\",[143,55.458]],[\"comment/345\",[]],[\"name/346\",[144,55.458]],[\"comment/346\",[]],[\"name/347\",[145,55.458]],[\"comment/347\",[]],[\"name/348\",[7,29.582]],[\"comment/348\",[]],[\"name/349\",[146,55.458]],[\"comment/349\",[]],[\"name/350\",[147,55.458]],[\"comment/350\",[]],[\"name/351\",[148,55.458]],[\"comment/351\",[]],[\"name/352\",[7,29.582]],[\"comment/352\",[]],[\"name/353\",[149,55.458]],[\"comment/353\",[]],[\"name/354\",[150,50.305]],[\"comment/354\",[]],[\"name/355\",[151,55.458]],[\"comment/355\",[]],[\"name/356\",[152,55.458]],[\"comment/356\",[]],[\"name/357\",[153,55.458]],[\"comment/357\",[]],[\"name/358\",[154,55.458]],[\"comment/358\",[]],[\"name/359\",[45,50.305]],[\"comment/359\",[]],[\"name/360\",[155,55.458]],[\"comment/360\",[]],[\"name/361\",[156,55.458]],[\"comment/361\",[]],[\"name/362\",[150,50.305]],[\"comment/362\",[]],[\"name/363\",[157,55.458]],[\"comment/363\",[]],[\"name/364\",[158,55.458]],[\"comment/364\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":7,\"name\":{\"3\":{},\"5\":{},\"7\":{},\"9\":{},\"22\":{},\"48\":{},\"53\":{},\"71\":{},\"83\":{},\"109\":{},\"135\":{},\"181\":{},\"194\":{},\"227\":{},\"264\":{},\"301\":{},\"333\":{},\"348\":{},\"352\":{}},\"comment\":{}}],[\"_checktimer\",{\"_index\":18,\"name\":{\"16\":{}},\"comment\":{}}],[\"_defaulttimezone\",{\"_index\":17,\"name\":{\"15\":{}},\"comment\":{}}],[\"_jobprops\",{\"_index\":20,\"name\":{\"18\":{}},\"comment\":{}}],[\"_jobsrepository\",{\"_index\":19,\"name\":{\"17\":{}},\"comment\":{}}],[\"_rootfolder\",{\"_index\":15,\"name\":{\"13\":{}},\"comment\":{}}],[\"_status\",{\"_index\":16,\"name\":{\"14\":{}},\"comment\":{}}],[\"acceptepoch\",{\"_index\":102,\"name\":{\"160\":{}},\"comment\":{}}],[\"acceptjsonstring\",{\"_index\":100,\"name\":{\"158\":{}},\"comment\":{}}],[\"acceptunknownprops\",{\"_index\":107,\"name\":{\"196\":{},\"202\":{}},\"comment\":{}}],[\"addjob\",{\"_index\":33,\"name\":{\"32\":{}},\"comment\":{}}],[\"addpreprocessor\",{\"_index\":66,\"name\":{\"76\":{},\"102\":{},\"128\":{},\"167\":{},\"186\":{},\"220\":{},\"257\":{},\"294\":{},\"318\":{},\"340\":{}},\"comment\":{}}],[\"addprop\",{\"_index\":109,\"name\":{\"204\":{}},\"comment\":{}}],[\"addprops\",{\"_index\":110,\"name\":{\"205\":{}},\"comment\":{}}],[\"addvalidator\",{\"_index\":68,\"name\":{\"78\":{},\"104\":{},\"130\":{},\"169\":{},\"188\":{},\"222\":{},\"259\":{},\"296\":{},\"320\":{},\"342\":{}},\"comment\":{}}],[\"and\",{\"_index\":36,\"name\":{\"34\":{}},\"comment\":{}}],[\"any\",{\"_index\":152,\"name\":{\"356\":{}},\"comment\":{}}],[\"anyschemabuilder\",{\"_index\":57,\"name\":{\"62\":{}},\"comment\":{}}],[\"array\",{\"_index\":153,\"name\":{\"357\":{}},\"comment\":{}}],[\"arrayschemabuilder\",{\"_index\":70,\"name\":{\"80\":{}},\"comment\":{}}],[\"async\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"boolean\",{\"_index\":154,\"name\":{\"358\":{}},\"comment\":{}}],[\"booleanschemabuilder\",{\"_index\":78,\"name\":{\"106\":{}},\"comment\":{}}],[\"canbeinfinite\",{\"_index\":128,\"name\":{\"247\":{}},\"comment\":{}}],[\"canbenan\",{\"_index\":126,\"name\":{\"245\":{}},\"comment\":{}}],[\"checkforupcomingjobs\",{\"_index\":28,\"name\":{\"27\":{}},\"comment\":{}}],[\"clearendswith\",{\"_index\":134,\"name\":{\"286\":{}},\"comment\":{}}],[\"clearequals\",{\"_index\":86,\"name\":{\"122\":{},\"149\":{},\"241\":{},\"278\":{}},\"comment\":{}}],[\"clearhastype\",{\"_index\":82,\"name\":{\"116\":{},\"325\":{}},\"comment\":{}}],[\"clearisinfuture\",{\"_index\":95,\"name\":{\"151\":{}},\"comment\":{}}],[\"clearisinpast\",{\"_index\":97,\"name\":{\"153\":{}},\"comment\":{}}],[\"clearmatches\",{\"_index\":135,\"name\":{\"288\":{}},\"comment\":{}}],[\"clearmax\",{\"_index\":99,\"name\":{\"157\":{},\"251\":{}},\"comment\":{}}],[\"clearmaxlength\",{\"_index\":77,\"name\":{\"96\":{},\"282\":{}},\"comment\":{}}],[\"clearmin\",{\"_index\":98,\"name\":{\"155\":{},\"249\":{}},\"comment\":{}}],[\"clearminlength\",{\"_index\":76,\"name\":{\"94\":{},\"280\":{}},\"comment\":{}}],[\"clearof\",{\"_index\":75,\"name\":{\"92\":{}},\"comment\":{}}],[\"clearpreprocessors\",{\"_index\":67,\"name\":{\"77\":{},\"103\":{},\"129\":{},\"168\":{},\"187\":{},\"221\":{},\"258\":{},\"295\":{},\"319\":{},\"341\":{}},\"comment\":{}}],[\"clearstartswith\",{\"_index\":133,\"name\":{\"284\":{}},\"comment\":{}}],[\"clearvalidators\",{\"_index\":69,\"name\":{\"79\":{},\"105\":{},\"131\":{},\"170\":{},\"189\":{},\"223\":{},\"260\":{},\"297\":{},\"321\":{},\"343\":{}},\"comment\":{}}],[\"collect\",{\"_index\":39,\"name\":{\"38\":{}},\"comment\":{}}],[\"collector\",{\"_index\":38,\"name\":{\"35\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":14,\"name\":{\"12\":{},\"36\":{},\"45\":{},\"323\":{}},\"comment\":{}}],[\"create\",{\"_index\":79,\"name\":{\"107\":{},\"133\":{},\"172\":{},\"191\":{},\"225\":{},\"262\":{},\"299\":{}},\"comment\":{}}],[\"createfromprops\",{\"_index\":59,\"name\":{\"64\":{},\"118\":{},\"174\":{},\"192\":{},\"239\":{},\"276\":{},\"308\":{},\"326\":{}},\"comment\":{}}],[\"createjobrequestschema\",{\"_index\":51,\"name\":{\"56\":{}},\"comment\":{}}],[\"date\",{\"_index\":45,\"name\":{\"49\":{},\"359\":{}},\"comment\":{}}],[\"dateschemabuilder\",{\"_index\":87,\"name\":{\"132\":{}},\"comment\":{}}],[\"deep\",{\"_index\":2,\"name\":{\"1\":{}},\"comment\":{}}],[\"deepequal\",{\"_index\":8,\"name\":{\"4\":{},\"40\":{}},\"comment\":{}}],[\"deepextend\",{\"_index\":9,\"name\":{\"6\":{},\"41\":{}},\"comment\":{}}],[\"deepflatten\",{\"_index\":10,\"name\":{\"8\":{},\"42\":{}},\"comment\":{}}],[\"default\",{\"_index\":6,\"name\":{\"2\":{}},\"comment\":{}}],[\"definition\",{\"_index\":35,\"name\":{\"34\":{}},\"comment\":{}}],[\"donotacceptepoch\",{\"_index\":103,\"name\":{\"161\":{}},\"comment\":{}}],[\"donotacceptjsonstring\",{\"_index\":101,\"name\":{\"159\":{}},\"comment\":{}}],[\"elementschema\",{\"_index\":71,\"name\":{\"84\":{}},\"comment\":{}}],[\"endswith\",{\"_index\":131,\"name\":{\"269\":{},\"285\":{}},\"comment\":{}}],[\"ensureisfinite\",{\"_index\":122,\"name\":{\"231\":{}},\"comment\":{}}],[\"ensureisinfuture\",{\"_index\":90,\"name\":{\"138\":{}},\"comment\":{}}],[\"ensureisinpast\",{\"_index\":91,\"name\":{\"139\":{}},\"comment\":{}}],[\"ensurenotnan\",{\"_index\":121,\"name\":{\"230\":{}},\"comment\":{}}],[\"equals\",{\"_index\":85,\"name\":{\"121\":{},\"148\":{},\"240\":{},\"277\":{}},\"comment\":{}}],[\"equalsto\",{\"_index\":80,\"name\":{\"110\":{},\"140\":{},\"232\":{},\"267\":{}},\"comment\":{}}],[\"errors\",{\"_index\":151,\"name\":{\"355\":{}},\"comment\":{}}],[\"func\",{\"_index\":155,\"name\":{\"360\":{}},\"comment\":{}}],[\"functionschemabuilder\",{\"_index\":104,\"name\":{\"171\":{}},\"comment\":{}}],[\"getjobschedule\",{\"_index\":22,\"name\":{\"20\":{}},\"comment\":{}}],[\"hasnext\",{\"_index\":43,\"name\":{\"46\":{}},\"comment\":{}}],[\"hastype\",{\"_index\":81,\"name\":{\"115\":{},\"324\":{}},\"comment\":{}}],[\"index\",{\"_index\":46,\"name\":{\"50\":{}},\"comment\":{}}],[\"infertype\",{\"_index\":143,\"name\":{\"345\":{}},\"comment\":{}}],[\"intersect\",{\"_index\":112,\"name\":{\"207\":{}},\"comment\":{}}],[\"introspect\",{\"_index\":65,\"name\":{\"70\":{},\"82\":{},\"108\":{},\"134\":{},\"180\":{},\"193\":{},\"226\":{},\"263\":{},\"300\":{},\"332\":{}},\"comment\":{}}],[\"isfinite\",{\"_index\":127,\"name\":{\"246\":{}},\"comment\":{}}],[\"isfloat\",{\"_index\":124,\"name\":{\"242\":{}},\"comment\":{}}],[\"isinfuture\",{\"_index\":94,\"name\":{\"150\":{}},\"comment\":{}}],[\"isinpast\",{\"_index\":96,\"name\":{\"152\":{}},\"comment\":{}}],[\"isinteger\",{\"_index\":123,\"name\":{\"233\":{},\"243\":{}},\"comment\":{}}],[\"isrequired\",{\"_index\":63,\"name\":{\"68\":{},\"73\":{},\"88\":{},\"100\":{},\"112\":{},\"126\":{},\"146\":{},\"165\":{},\"178\":{},\"183\":{},\"198\":{},\"218\":{},\"237\":{},\"255\":{},\"274\":{},\"292\":{},\"304\":{},\"316\":{},\"330\":{},\"335\":{}},\"comment\":{}}],[\"job\",{\"_index\":11,\"name\":{\"10\":{}},\"comment\":{}}],[\"jobexists\",{\"_index\":31,\"name\":{\"30\":{}},\"comment\":{}}],[\"jobscheduler\",{\"_index\":13,\"name\":{\"11\":{}},\"comment\":{}}],[\"makeallpropsoptional\",{\"_index\":118,\"name\":{\"213\":{}},\"comment\":{}}],[\"makeallpropsrequired\",{\"_index\":119,\"name\":{\"214\":{}},\"comment\":{}}],[\"makeoptional\",{\"_index\":144,\"name\":{\"346\":{}},\"comment\":{}}],[\"makepropoptional\",{\"_index\":116,\"name\":{\"211\":{}},\"comment\":{}}],[\"makeproprequired\",{\"_index\":117,\"name\":{\"212\":{}},\"comment\":{}}],[\"matches\",{\"_index\":132,\"name\":{\"270\":{},\"287\":{}},\"comment\":{}}],[\"max\",{\"_index\":89,\"name\":{\"137\":{},\"156\":{},\"229\":{},\"250\":{}},\"comment\":{}}],[\"maxlength\",{\"_index\":73,\"name\":{\"86\":{},\"95\":{},\"266\":{},\"281\":{}},\"comment\":{}}],[\"merge\",{\"_index\":41,\"name\":{\"43\":{}},\"comment\":{}}],[\"message\",{\"_index\":147,\"name\":{\"350\":{}},\"comment\":{}}],[\"min\",{\"_index\":88,\"name\":{\"136\":{},\"154\":{},\"228\":{},\"248\":{}},\"comment\":{}}],[\"minlength\",{\"_index\":72,\"name\":{\"85\":{},\"93\":{},\"265\":{},\"279\":{}},\"comment\":{}}],[\"modifypropschema\",{\"_index\":115,\"name\":{\"210\":{}},\"comment\":{}}],[\"next\",{\"_index\":44,\"name\":{\"47\":{}},\"comment\":{}}],[\"notacceptunknownprops\",{\"_index\":108,\"name\":{\"203\":{}},\"comment\":{}}],[\"notnan\",{\"_index\":125,\"name\":{\"244\":{}},\"comment\":{}}],[\"number\",{\"_index\":156,\"name\":{\"361\":{}},\"comment\":{}}],[\"numberschemabuilder\",{\"_index\":120,\"name\":{\"224\":{}},\"comment\":{}}],[\"object\",{\"_index\":150,\"name\":{\"354\":{},\"362\":{}},\"comment\":{}}],[\"objects\",{\"_index\":5,\"name\":{\"1\":{}},\"comment\":{}}],[\"objectschemabuilder\",{\"_index\":105,\"name\":{\"190\":{}},\"comment\":{}}],[\"of\",{\"_index\":74,\"name\":{\"91\":{}},\"comment\":{}}],[\"omit\",{\"_index\":111,\"name\":{\"206\":{}},\"comment\":{}}],[\"on\",{\"_index\":4,\"name\":{\"1\":{},\"33\":{},\"37\":{}},\"comment\":{}}],[\"operations\",{\"_index\":3,\"name\":{\"1\":{}},\"comment\":{}}],[\"optional\",{\"_index\":84,\"name\":{\"120\":{},\"338\":{}},\"comment\":{}}],[\"options\",{\"_index\":137,\"name\":{\"302\":{}},\"comment\":{}}],[\"or\",{\"_index\":138,\"name\":{\"309\":{}},\"comment\":{}}],[\"parsefromepoch\",{\"_index\":92,\"name\":{\"141\":{}},\"comment\":{}}],[\"parsefromjson\",{\"_index\":93,\"name\":{\"142\":{}},\"comment\":{}}],[\"partial\",{\"_index\":113,\"name\":{\"208\":{}},\"comment\":{}}],[\"path\",{\"_index\":146,\"name\":{\"349\":{}},\"comment\":{}}],[\"pick\",{\"_index\":114,\"name\":{\"209\":{}},\"comment\":{}}],[\"preprocessors\",{\"_index\":61,\"name\":{\"66\":{},\"74\":{},\"89\":{},\"98\":{},\"113\":{},\"124\":{},\"143\":{},\"163\":{},\"176\":{},\"184\":{},\"199\":{},\"216\":{},\"234\":{},\"253\":{},\"271\":{},\"290\":{},\"305\":{},\"314\":{},\"328\":{},\"336\":{}},\"comment\":{}}],[\"prevalidate\",{\"_index\":64,\"name\":{\"69\":{},\"101\":{},\"127\":{},\"166\":{},\"179\":{},\"219\":{},\"256\":{},\"293\":{},\"317\":{},\"331\":{}},\"comment\":{}}],[\"promise\",{\"_index\":24,\"name\":{\"23\":{}},\"comment\":{}}],[\"properties\",{\"_index\":106,\"name\":{\"195\":{}},\"comment\":{}}],[\"removefirstoption\",{\"_index\":140,\"name\":{\"311\":{}},\"comment\":{}}],[\"removejob\",{\"_index\":32,\"name\":{\"31\":{}},\"comment\":{}}],[\"removeoption\",{\"_index\":139,\"name\":{\"310\":{}},\"comment\":{}}],[\"required\",{\"_index\":83,\"name\":{\"119\":{},\"339\":{}},\"comment\":{}}],[\"reset\",{\"_index\":141,\"name\":{\"312\":{}},\"comment\":{}}],[\"runworkerwithtimeout\",{\"_index\":23,\"name\":{\"21\":{}},\"comment\":{}}],[\"schedulecalculator\",{\"_index\":42,\"name\":{\"44\":{}},\"comment\":{}}],[\"scheduledayschema\",{\"_index\":53,\"name\":{\"58\":{}},\"comment\":{}}],[\"schedulejobto\",{\"_index\":27,\"name\":{\"26\":{}},\"comment\":{}}],[\"scheduleminuteschema\",{\"_index\":52,\"name\":{\"57\":{}},\"comment\":{}}],[\"schedulemonthschema\",{\"_index\":55,\"name\":{\"60\":{}},\"comment\":{}}],[\"scheduler\",{\"_index\":12,\"name\":{\"10\":{}},\"comment\":{}}],[\"scheduleschema\",{\"_index\":50,\"name\":{\"55\":{}},\"comment\":{}}],[\"scheduleschemabase\",{\"_index\":49,\"name\":{\"54\":{}},\"comment\":{}}],[\"scheduleweekschema\",{\"_index\":54,\"name\":{\"59\":{}},\"comment\":{}}],[\"scheduleyearschema\",{\"_index\":56,\"name\":{\"61\":{}},\"comment\":{}}],[\"schema\",{\"_index\":34,\"name\":{\"34\":{}},\"comment\":{}}],[\"schemabuilder\",{\"_index\":142,\"name\":{\"322\":{}},\"comment\":{}}],[\"schemas\",{\"_index\":48,\"name\":{\"52\":{}},\"comment\":{}}],[\"start\",{\"_index\":29,\"name\":{\"28\":{}},\"comment\":{}}],[\"startjobinstance\",{\"_index\":26,\"name\":{\"25\":{}},\"comment\":{}}],[\"startswith\",{\"_index\":130,\"name\":{\"268\":{},\"283\":{}},\"comment\":{}}],[\"status\",{\"_index\":21,\"name\":{\"19\":{}},\"comment\":{}}],[\"stop\",{\"_index\":30,\"name\":{\"29\":{}},\"comment\":{}}],[\"string\",{\"_index\":157,\"name\":{\"363\":{}},\"comment\":{}}],[\"stringschemabuilder\",{\"_index\":129,\"name\":{\"261\":{}},\"comment\":{}}],[\"taskschedule\",{\"_index\":47,\"name\":{\"51\":{}},\"comment\":{}}],[\"topromise\",{\"_index\":40,\"name\":{\"39\":{}},\"comment\":{}}],[\"type\",{\"_index\":60,\"name\":{\"65\":{},\"72\":{},\"87\":{},\"97\":{},\"111\":{},\"123\":{},\"145\":{},\"162\":{},\"175\":{},\"182\":{},\"197\":{},\"215\":{},\"236\":{},\"252\":{},\"273\":{},\"289\":{},\"303\":{},\"313\":{},\"327\":{},\"334\":{}},\"comment\":{}}],[\"union\",{\"_index\":158,\"name\":{\"364\":{}},\"comment\":{}}],[\"unionschemabuilder\",{\"_index\":136,\"name\":{\"298\":{}},\"comment\":{}}],[\"utilities\",{\"_index\":1,\"name\":{\"0\":{}},\"comment\":{}}],[\"valid\",{\"_index\":149,\"name\":{\"353\":{}},\"comment\":{}}],[\"validate\",{\"_index\":58,\"name\":{\"63\":{},\"81\":{},\"117\":{},\"147\":{},\"173\":{},\"201\":{},\"238\":{},\"275\":{},\"307\":{},\"344\":{}},\"comment\":{}}],[\"validation\",{\"_index\":37,\"name\":{\"34\":{}},\"comment\":{}}],[\"validationerror\",{\"_index\":145,\"name\":{\"347\":{}},\"comment\":{}}],[\"validationresult\",{\"_index\":148,\"name\":{\"351\":{}},\"comment\":{}}],[\"validators\",{\"_index\":62,\"name\":{\"67\":{},\"75\":{},\"90\":{},\"99\":{},\"114\":{},\"125\":{},\"144\":{},\"164\":{},\"177\":{},\"185\":{},\"200\":{},\"217\":{},\"235\":{},\"254\":{},\"272\":{},\"291\":{},\"306\":{},\"315\":{},\"329\":{},\"337\":{}},\"comment\":{}}],[\"worker\",{\"_index\":25,\"name\":{\"24\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/v1.1.4/assets/style.css b/docs/v1.1.4/assets/style.css new file mode 100644 index 0000000..496e66f --- /dev/null +++ b/docs/v1.1.4/assets/style.css @@ -0,0 +1,1279 @@ +:root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-text: #222; + --light-color-text-aside: #707070; + --light-color-link: #4da6ff; + --light-color-ts: #db1373; + --light-color-ts-interface: #139d2c; + --light-color-ts-enum: #9c891a; + --light-color-ts-class: #2484e5; + --light-color-ts-function: #572be7; + --light-color-ts-namespace: #b111c9; + --light-color-ts-private: #707070; + --light-color-ts-variable: #4d68ff; + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + --dark-color-ts: #ff6492; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-class: #61b0ff; + --dark-color-ts-function: #9772ff; + --dark-color-ts-namespace: #e14dff; + --dark-color-ts-private: #e2e2e2; + --dark-color-ts-variable: #4d68ff; + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; +} + +@media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } +} + +@media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } +} + +html { + color-scheme: var(--color-scheme); +} + +body { + margin: 0; +} + +:root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + --color-ts: var(--light-color-ts); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-class: var(--light-color-ts-class); + --color-ts-function: var(--light-color-ts-function); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-private: var(--light-color-ts-private); + --color-ts-variable: var(--light-color-ts-variable); + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); +} + +:root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + --color-ts: var(--dark-color-ts); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-private: var(--dark-color-ts-private); + --color-ts-variable: var(--dark-color-ts-variable); + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); +} + +.always-visible, +.always-visible .tsd-signatures { + display: inherit !important; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: 1.2; +} + +h1 { + font-size: 1.875rem; + margin: 0.67rem 0; +} + +h2 { + font-size: 1.5rem; + margin: 0.83rem 0; +} + +h3 { + font-size: 1.25rem; + margin: 1rem 0; +} + +h4 { + font-size: 1.05rem; + margin: 1.33rem 0; +} + +h5 { + font-size: 1rem; + margin: 1.5rem 0; +} + +h6 { + font-size: 0.875rem; + margin: 2.33rem 0; +} + +.uppercase { + text-transform: uppercase; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +dl, +menu, +ol, +ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +.container { + max-width: 1600px; + padding: 0 2rem; +} + +@media (min-width: 640px) { + .container { + padding: 0 4rem; + } +} +@media (min-width: 1200px) { + .container { + padding: 0 8rem; + } +} +@media (min-width: 1600px) { + .container { + padding: 0 12rem; + } +} + +/* Footer */ +.tsd-generator { + 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; +} + +.container-main { + display: flex; + justify-content: space-between; + position: relative; + margin: 0 auto; +} + +.col-4, +.col-8 { + box-sizing: border-box; + float: left; + padding: 2rem 1rem; +} + +.col-4 { + flex: 0 0 25%; +} +.col-8 { + flex: 1 0; + flex-wrap: wrap; + padding-left: 0; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: var(--color-background); + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: var(--color-text); +} + +a { + color: var(--color-link); + text-decoration: none; +} +a:hover { + text-decoration: underline; +} +a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; +} + +code, +pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; +} + +pre { + padding: 10px; + border: 0.1em solid var(--color-accent); +} +pre code { + padding: 0; + font-size: 100%; +} + +blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, +.tsd-typography .tsd-index-panel h3, +.tsd-index-panel .tsd-typography h3, +.tsd-typography h5, +.tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, +.tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, +.tsd-typography ul, +.tsd-typography ol { + margin: 1em 0; +} + +@media (max-width: 1024px) { + html .col-content { + float: none; + max-width: 100%; + width: 100%; + padding-top: 3rem; + } + html .col-menu { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + max-width: 25rem; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-menu > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu :is(header, footer, .col-content) { + animation: shift-to-left 0.4s; + } + + .to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu :is(header, footer, .col-content) { + animation: unshift-to-left 0.4s; + } + + .from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu :is(header, footer, .col-content) { + transform: translate(-25%, 0); + } + .has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); +} +.tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +.tsd-comment-tags { + display: flex; + flex-direction: column; +} +dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; +} +dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; +} +dl.tsd-comment-tag-group dd { + margin: 0; +} +code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; +} +h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; +} + +dl.tsd-comment-tag-group dd:before, +dl.tsd-comment-tag-group dd:after { + content: " "; +} +dl.tsd-comment-tag-group dd pre, +dl.tsd-comment-tag-group dd:after { + clear: both; +} +dl.tsd-comment-tag-group p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; +} +.tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; +} +.tsd-filter-input { + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; +} +.tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; +} +.tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; +} +.tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; +} +.tsd-filter-input input[type="checkbox"]:focus + svg { + transform: scale(0.95); +} +.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { + transform: scale(1); +} +.tsd-checkbox-background { + fill: var(--color-accent); +} +input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; +} +.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); +} + +.tsd-theme-toggle { + padding-top: 0.75rem; +} +.tsd-theme-toggle > h4 { + display: inline; + vertical-align: middle; + margin-right: 0.75rem; +} + +.tsd-hierarchy { + list-style: square; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-panel-group.tsd-index-group { + margin-bottom: 0; +} +.tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; +} +@media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } +} +@media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } +} +.tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel a.tsd-parent-kind-module { + color: var(--color-ts); +} +.tsd-index-panel a.tsd-parent-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-parent-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-parent-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-module { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-interface { + color: var(--color-ts-interface); +} +.tsd-index-panel a.tsd-kind-enum { + color: var(--color-ts-enum); +} +.tsd-index-panel a.tsd-kind-class { + color: var(--color-ts-class); +} +.tsd-index-panel a.tsd-kind-function { + color: var(--color-ts-function); +} +.tsd-index-panel a.tsd-kind-namespace { + color: var(--color-ts-namespace); +} +.tsd-index-panel a.tsd-kind-variable { + color: var(--color-ts-variable); +} +.tsd-index-panel a.tsd-is-private { + color: var(--color-ts-private); +} + +.tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} +.tsd-member [data-tsd-kind] { + color: var(--color-ts); +} +.tsd-member [data-tsd-kind="Interface"] { + color: var(--color-ts-interface); +} +.tsd-member [data-tsd-kind="Enum"] { + color: var(--color-ts-enum); +} +.tsd-member [data-tsd-kind="Class"] { + color: var(--color-ts-class); +} +.tsd-member [data-tsd-kind="Private"] { + color: var(--color-ts-private); +} + +.tsd-navigation a { + display: block; + margin: 0.4rem 0; + border-left: 2px solid transparent; + color: var(--color-text); + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary .tsd-accordion-details > ul { + margin-top: 0.75rem; +} +.tsd-navigation.primary a { + padding: 0.75rem 0.5rem; + margin: 0; +} +.tsd-navigation.primary ul li a { + margin-left: 0.5rem; +} +.tsd-navigation.primary ul li li a { + margin-left: 1.5rem; +} +.tsd-navigation.primary ul li li li a { + margin-left: 2.5rem; +} +.tsd-navigation.primary ul li li li li a { + margin-left: 3.5rem; +} +.tsd-navigation.primary ul li li li li li a { + margin-left: 4.5rem; +} +.tsd-navigation.primary ul li li li li li li a { + margin-left: 5.5rem; +} +.tsd-navigation.primary li.current > a { + border-left: 0.15rem var(--color-text) solid; +} +.tsd-navigation.primary li.selected > a { + font-weight: bold; + border-left: 0.2rem var(--color-text) solid; +} +.tsd-navigation.primary ul li a:hover { + border-left: 0.2rem var(--color-text-aside) solid; +} +.tsd-navigation.primary li.globals + li > span, +.tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary > ul { + display: inline; + padding-right: 0.5rem; + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 0; +} +.tsd-navigation.secondary ul li li a { + padding-left: 1.1rem; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 2.2rem; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 3.3rem; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 4.4rem; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 5.5rem; +} + +#tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; +} +#tsd-sidebar-links a:last-of-type { + margin-bottom: 0; +} + +a.tsd-index-link { + margin: 0.25rem 0; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; +} +.tsd-accordion-summary > h1, +.tsd-accordion-summary > h2, +.tsd-accordion-summary > h3, +.tsd-accordion-summary > h4, +.tsd-accordion-summary > h5 { + display: inline-flex; + align-items: center; + vertical-align: middle; + margin-bottom: 0; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; +} +.tsd-accordion-summary { + display: block; + cursor: pointer; +} +.tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; +} +.tsd-accordion-summary::-webkit-details-marker { + display: none; +} +.tsd-index-accordion .tsd-accordion-summary svg { + margin-right: 0.25rem; +} +.tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; +} +.tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; +} + +.tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; +} +.tsd-kind-icon path { + transform-origin: center; + transform: scale(1.1); +} +.tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; +} + +@media (min-width: 1025px) { + .col-content { + margin: 2rem auto; + } + + .menu-sticky-wrap { + position: sticky; + height: calc(100vh - 2rem); + top: 4rem; + right: 0; + padding: 0 1.5rem; + padding-top: 1rem; + margin-top: 3rem; + transition: 0.3s ease-in-out; + transition-property: top, padding-top, padding, height; + overflow-y: auto; + } + .col-menu { + border-left: 1px solid var(--color-accent); + } + .col-menu--hide { + top: 1rem; + } + .col-menu .tsd-navigation:not(:last-child) { + padding-bottom: 1.75rem; + } +} + +.tsd-panel { + margin-bottom: 2.5rem; +} +.tsd-panel.tsd-member { + margin-bottom: 4rem; +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, +.tsd-panel > h2, +.tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; +} +.tsd-panel > h1.tsd-before-signature, +.tsd-panel > h2.tsd-before-signature, +.tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; +} + +.tsd-panel-group { + margin: 4rem 0; +} +.tsd-panel-group.tsd-index-group { + margin: 2rem 0; +} +.tsd-panel-group.tsd-index-group details { + margin: 2rem 0; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title, +#tsd-toolbar-links a { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: var(--color-background); +} +#tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: var(--color-accent); +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; +} +#tsd-search.has-focus { + background-color: var(--color-accent); +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title, +#tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +#tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; +} +#tsd-toolbar-links a { + margin-left: 1.5rem; +} +#tsd-toolbar-links a:hover { + text-decoration: underline; +} + +.tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} + +.tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; +} +.tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; +} + +ul.tsd-parameter-list, +ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameter-list > li.tsd-parameter-signature, +ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameter-list h5, +ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +.tsd-sources { + margin-top: 1rem; + font-size: 0.875em; +} +.tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; +} +.tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; +} +.tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} +.tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.9; +} +.tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} + +.tsd-widget.options, +.tsd-widget.menu { + display: none; +} +@media (max-width: 1024px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } +} +input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; +} +input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +img { + max-width: 100%; +} + +.tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); +} + +.tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; +} + +.tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; +} + +.deprecated { + text-decoration: line-through; +} + +.warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); +} + +* { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); +} + +*::-webkit-scrollbar { + width: 0.75rem; +} + +*::-webkit-scrollbar-track { + background: var(--color-icon-background); +} + +*::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); +} diff --git a/docs/v1.1.4/assets/versionsMenu.js b/docs/v1.1.4/assets/versionsMenu.js new file mode 100644 index 0000000..2f3475a --- /dev/null +++ b/docs/v1.1.4/assets/versionsMenu.js @@ -0,0 +1,31 @@ +import { DOC_VERSIONS } from '../../versions.js'; + +const select = document.getElementById('plugin-versions-select'); + +DOC_VERSIONS.forEach((version) => { + const option = document.createElement('option'); + option.value = version; + option.innerHTML = version; + select.appendChild(option); +}); + +const locationSplit = location.pathname.split('/'); +const thisVersion = locationSplit.find((path) => + ['stable', 'dev', ...DOC_VERSIONS].includes(path) +); +select.value = DOC_VERSIONS.includes(thisVersion) + ? thisVersion + : DOC_VERSIONS[0]; +select.onchange = () => { + const newPaths = window.location.pathname.replace( + `/${thisVersion}/`, + `/${select.value}/` + ); + const newUrl = new URL(newPaths, window.location.origin); + window.location.assign(newUrl); +}; + +const header = document.querySelector('header.tsd-page-toolbar #tsd-search'); +if (!!header && select.className.includes('title')) { + header.prepend(select); +} diff --git a/docs/v1.1.4/classes/Async_utilities.Collector.html b/docs/v1.1.4/classes/Async_utilities.Collector.html new file mode 100644 index 0000000..9218b62 --- /dev/null +++ b/docs/v1.1.4/classes/Async_utilities.Collector.html @@ -0,0 +1,870 @@ +Collector | Libraries
+
+ +
+
+
+
+ +

Class Collector<T, K>

+
+

Allows to collect results of async operations and wait for all of them to finish +supports timeout and promise interface to wait for all results. +Also implementes EventEmitter interface.

+ +

Example

const collector = new Collector(['a', 'b', 'c']);
collector.collect('a', Promise.resolve(1));
collector.collect('b', Promise.resolve(2));
collector.collect('c', Promise.resolve(3));
collector.on('end', (result) => {
   console.log(result); // { a: 1, b: 2, c: 3 }
});
+
+

or using promise interface

+
const collector = new Collector(['a', 'b', 'c']);
collector.collect('a', Promise.resolve(1));
collector.collect('b', Promise.resolve(2));
collector.collect('c', Promise.resolve(3));
collector.toPromise().then((result) => {
  console.log(result); // { a: 1, b: 2, c: 3 }
});
+
+
+
+

Type Parameters

+
    +
  • +

    T extends Record<string, unknown>

    • +
  • +

    K extends keyof T = keyof T

+
+

Hierarchy

+
    +
  • EventEmitter +
      +
    • Collector
+
+

Implements

+
    +
  • ICollector<T>
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
captureRejectionSymbol +captureRejections +defaultMaxListeners +errorMonitor +
+
+

Methods

+
addListener +collect +emit +eventNames +getMaxListeners +listenerCount +listeners +off +on +once +prependListener +prependOnceListener +rawListeners +removeAllListeners +removeListener +setMaxListeners +toPromise +getEventListeners +listenerCount +on +once +setMaxListeners +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, unknown>

      • +
    • +

      K extends string | number | symbol = keyof T

    +
    +

    Parameters

    +
      +
    • +
      keys: K[]
      +

      array of keys to collect

      +
      • +
    • +
      timeout: number = -1
      +

      optional timeout in ms. If timeout is reached, collector will emit 'timeout' event and reject promise

      +
    +

    Returns Collector<T, K>

+
+

Properties

+
+

Static Readonly captureRejectionSymbol

+
captureRejectionSymbol: typeof captureRejectionSymbol
+

Value: Symbol.for('nodejs.rejection')

+

See how to write a custom rejection handler.

+ +

Since

v13.4.0, v12.16.0

+
+
+

Static captureRejections

+
captureRejections: boolean
+

Value: boolean

+

Change the default captureRejections option on all new EventEmitter objects.

+ +

Since

v13.4.0, v12.16.0

+
+
+

Static defaultMaxListeners

+
defaultMaxListeners: number
+

By default, a maximum of 10 listeners can be registered for any single +event. This limit can be changed for individual EventEmitter instances +using the emitter.setMaxListeners(n) method. To change the default +for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

+

Take caution when setting the events.defaultMaxListeners because the +change affects allEventEmitter instances, including those created before +the change is made. However, calling emitter.setMaxListeners(n) still has +precedence over events.defaultMaxListeners.

+

This is not a hard limit. The EventEmitter instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to +temporarily avoid this warning:

+
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
+
+

The --trace-warnings command-line flag can be used to display the +stack trace for such warnings.

+

The emitted warning can be inspected with process.on('warning') and will +have the additional emitter, type, and count properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its name property is set to 'MaxListenersExceededWarning'.

+ +

Since

v0.11.2

+
+
+

Static Readonly errorMonitor

+
errorMonitor: typeof errorMonitor
+

This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

+

Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no +regular 'error' listener is installed.

+ +

Since

v13.6.0, v12.17.0

+
+
+

Methods

+
+

addListener

+
    + +
  • +

    Alias for emitter.on(eventName, listener).

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

collect

+
    + +
  • +

    Collects value for given key

    + +

    Returns

    this to allow chaining

    +
    +
    +

    Type Parameters

    +
      +
    • +

      L extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      key: L
      +

      key to collect

      +
      • +
    • +
      value: T[L]
      +

      value to collect for given key. If value is Promise - it will be awaited and result will be collected

      +
    +

    Returns Collector<T, K>

+
+

emit

+
    + +
  • +

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments +to each.

    +

    Returns true if the event had listeners, false otherwise.

    +
    import { EventEmitter } from 'node:events';
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
+
    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      Rest ...args: any[]
    +

    Returns boolean

+
+

eventNames

+
    + +
  • +

    Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or Symbols.

    +
    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
+
    + +

    Since

    v6.0.0

    +
    +

    Returns (string | symbol)[]

+
+

getMaxListeners

+
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    + +

    Since

    v1.0.0

    +
    +

    Returns number

+
+

listenerCount

+
    + +
  • +

    Returns the number of listeners listening for the event named eventName. +If listener is provided, it will return how many times the listener is found +in the list of the listeners of the event.

    + +

    Since

    v3.2.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event being listened for

      +
      • +
    • +
      Optional listener: Function
      +

      The event handler function

      +
    +

    Returns number

+
+

listeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
+
    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

+
+

off

+
    + +
  • +

    Alias for emitter.removeListener().

    + +

    Since

    v10.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

on

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      M extends keyof CollectorEvents<T>

    +
    +

    Parameters

    +
      +
    • +
      event: M
      • +
    • +
      listener: CollectorEvents<T>[M]
    +

    Returns Collector<T, K>

+
+

once

+
    + +
  • +

    Adds a one-timelistener function for the event named eventName. The +next time eventName is triggered, this listener is removed and then invoked.

    +
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the +event listener to the beginning of the listeners array.

    +
    import { EventEmitter } from 'node:events';
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
+
    + +

    Since

    v0.3.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

prependListener

+
    + +
  • +

    Adds the listener function to the beginning of the listeners array for the +event named eventName. No checks are made to see if the listener has +already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple +times.

    +
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v6.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

prependOnceListener

+
    + +
  • +

    Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +listener is removed, and then invoked.

    +
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v6.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

rawListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName, +including any wrappers (such as those created by .once()).

    +
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
+
    + +

    Since

    v9.4.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

+
+

removeAllListeners

+
    + +
  • +

    Removes all listeners, or those of the specified eventName.

    +

    It is bad practice to remove listeners added elsewhere in the code, +particularly when the EventEmitter instance was created by some other +component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
    +

    Returns Collector<T, K>

+
+

removeListener

+
    + +
  • +

    Removes the specified listener from the listener array for the event namedeventName.

    +
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
+
    +

    removeListener() will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified eventName, then removeListener() must be +called multiple times to remove each instance.

    +

    Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution +will not remove them fromemit() in progress. Subsequent events behave as expected.

    +
    import { EventEmitter } from 'node:events';
    class MyEmitter extends EventEmitter {}
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
+
    +

    Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered after the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the emitter.listeners() method will need to be recreated.

    +

    When a single function has been added as a handler multiple times for a single +event (as in the example below), removeListener() will remove the most +recently added instance. In the example the once('ping')listener is removed:

    +
    import { EventEmitter } from 'node:events';
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns Collector<T, K>

+
+

setMaxListeners

+
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.3.5

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns Collector<T, K>

+
+

toPromise

+
    + +
  • +

    Returns promise that will be resolved when all items are collected or rejected if timeout is reached.

    +
    +

    Returns Promise<T>

+
+

Static getEventListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +

    For EventEmitters this behaves exactly the same as calling .listeners on +the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes.

    +
    import { getEventListeners, EventEmitter } from 'node:events';

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
    }
+
    + +

    Since

    v15.2.0, v14.17.0

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
      • +
    • +
      name: string | symbol
    +

    Returns Function[]

+
+

Static listenerCount

+
    + +
  • +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    import { EventEmitter, listenerCount } from 'node:events';

    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
+
    + +

    Since

    v0.9.12

    + +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +

      The emitter to query

      +
      • +
    • +
      eventName: string | symbol
      +

      The event name

      +
    +

    Returns number

+
+

Static on

+
    + +
  • +
    import { on, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
      ee.emit('foo', 'bar');
      ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo')) {
      // The execution of this inner block is synchronous and it
      // processes one event at a time (even with await). Do not use
      // if concurrent execution is required.
      console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
+
    +

    Returns an AsyncIterator that iterates eventName events. It will throw +if the EventEmitter emits 'error'. It removes all listeners when +exiting the loop. The value returned by each iteration is an array +composed of the emitted event arguments.

    +

    An AbortSignal can be used to cancel waiting on events:

    +
    import { on, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
+
    + +

    Since

    v13.6.0, v12.16.0

    + +

    Returns

    that iterates eventName events emitted by the emitter

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      • +
    • +
      eventName: string
      +

      The name of the event being listened for

      +
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns AsyncIterableIterator<any>

+
+

Static once

+
    + +
  • +

    Creates a Promise that is fulfilled when the EventEmitter emits the given +event or that is rejected if the EventEmitter emits 'error' while waiting. +The Promise will resolve with an array of all the arguments emitted to the +given event.

    +

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +semantics and does not listen to the 'error' event.

    +
    import { once, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ee = new EventEmitter();

    process.nextTick(() => {
      ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
      ee.emit('error', err);
    });

    try {
      await once(ee, 'myevent');
    } catch (err) {
      console.error('error happened', err);
    }
+
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the +'error' event itself, then it is treated as any other kind of event without +special handling:

    +
    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.error('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
+
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
+
    + +

    Since

    v11.13.0, v10.16.0

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: _NodeEventTarget
      • +
    • +
      eventName: string | symbol
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      emitter: _DOMEventTarget
      • +
    • +
      eventName: string
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

+
+

Static setMaxListeners

+
    + +
  • +
    import { setMaxListeners, EventEmitter } from 'node:events';

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+
    + +

    Since

    v15.4.0

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional n: number
      +

      A non-negative number. The maximum number of listeners per EventTarget event.

      +
      • +
    • +
      Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Job_Scheduler.JobScheduler.html b/docs/v1.1.4/classes/Job_Scheduler.JobScheduler.html new file mode 100644 index 0000000..32dee46 --- /dev/null +++ b/docs/v1.1.4/classes/Job_Scheduler.JobScheduler.html @@ -0,0 +1,1079 @@ +JobScheduler | Libraries
+
+ +
+
+
+
+ +

Class JobScheduler

+
+

Job scheduler class that handles all the scheduling and running of jobs.

+
+
+

Hierarchy

+
    +
  • EventEmitter +
      +
    • JobScheduler
+
+

Implements

+
    +
  • IJobScheduler
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Properties

+
_checkTimer +_defaultTimezone +_jobProps +_jobsRepository +_rootFolder +_status +captureRejectionSymbol +captureRejections +defaultMaxListeners +errorMonitor +
+
+

Accessors

+
status +
+
+

Methods

+
addJob +addListener +checkForUpcomingJobs +emit +eventNames +getJobSchedule +getMaxListeners +jobExists +listenerCount +listeners +off +on +once +prependListener +prependOnceListener +rawListeners +removeAllListeners +removeJob +removeListener +runWorkerWithTimeout +scheduleJobTo +setMaxListeners +start +startJobInstance +stop +getEventListeners +listenerCount +on +once +setMaxListeners +
+
+

Constructors

+
+

constructor

+
+
+

Properties

+
+

Protected _checkTimer

+
_checkTimer: any
+
+

Protected _defaultTimezone

+
_defaultTimezone: string
+
+

Protected _jobProps

+
_jobProps: Map<string, any> = ...
+
+

Protected _jobsRepository

+
_jobsRepository: IJobRepository = ...
+
+

Protected _rootFolder

+
_rootFolder: string
+
+

Protected _status

+
_status: SchedulerStatus = 'stopped'
+
+

Static Readonly captureRejectionSymbol

+
captureRejectionSymbol: typeof captureRejectionSymbol
+

Value: Symbol.for('nodejs.rejection')

+

See how to write a custom rejection handler.

+ +

Since

v13.4.0, v12.16.0

+
+
+

Static captureRejections

+
captureRejections: boolean
+

Value: boolean

+

Change the default captureRejections option on all new EventEmitter objects.

+ +

Since

v13.4.0, v12.16.0

+
+
+

Static defaultMaxListeners

+
defaultMaxListeners: number
+

By default, a maximum of 10 listeners can be registered for any single +event. This limit can be changed for individual EventEmitter instances +using the emitter.setMaxListeners(n) method. To change the default +for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

+

Take caution when setting the events.defaultMaxListeners because the +change affects allEventEmitter instances, including those created before +the change is made. However, calling emitter.setMaxListeners(n) still has +precedence over events.defaultMaxListeners.

+

This is not a hard limit. The EventEmitter instance will allow +more listeners to be added but will output a trace warning to stderr indicating +that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to +temporarily avoid this warning:

+
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
+
+

The --trace-warnings command-line flag can be used to display the +stack trace for such warnings.

+

The emitted warning can be inspected with process.on('warning') and will +have the additional emitter, type, and count properties, referring to +the event emitter instance, the event's name and the number of attached +listeners, respectively. +Its name property is set to 'MaxListenersExceededWarning'.

+ +

Since

v0.11.2

+
+
+

Static Readonly errorMonitor

+
errorMonitor: typeof errorMonitor
+

This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

+

Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no +regular 'error' listener is installed.

+ +

Since

v13.6.0, v12.17.0

+
+
+

Accessors

+
+

status

+
+
+

Methods

+
+

addJob

+
    + +
  • +

    Adds job to the scheduler

    +
    +
    +

    Parameters

    +
      +
    • +
      job: {
          id: string;
          maxConsequentFails?: number;
          maxRetries?: number;
          path: string;
          props?: ((...args: any[]) => any) | ({});
          schedule: ({ every: "minute"; interval: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "day"; interval: number; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "week"; interval: number; dayOfWeek: number[]; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "month"; interval: number; day: number | "last"; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "year"; interval: number; day: number | "last"; month: number; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; });
          timeout?: number;
      }
      +

      {CreateJobRequest} - job to add

      +
      +
        +
      • +
        id: string
        +

        Id of job, must be uniq

        +
        • +
      • +
        Optional maxConsequentFails?: number
        +

        Job will be considered as disabled when more than that count of runs fails consequently +unlimited if negative

        +
        • +
      • +
        Optional maxRetries?: number
        +

        Job will be retried right away this times. Job will be retried on next schedule run if this number is exceeded.

        +
        • +
      • +
        path: string
        +

        Path to js file (relative to root folder)

        +
        • +
      • +
        Optional props?: ((...args: any[]) => any) | ({})
        +

        Arbitrary props for job (can be a callback returning props or Promise)

        +
        • +
      • +
        schedule: ({ every: "minute"; interval: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "day"; interval: number; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "week"; interval: number; dayOfWeek: number[]; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "month"; interval: number; day: number | "last"; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; }) | ({ every: "year"; interval: number; day: number | "last"; month: number; hour?: number; minute?: number; startsOn?: Date; endsOn?: Date; maxOccurences?: number; skipFirst?: number; })
        +

        Job's schedule

        +
        • +
      • +
        Optional timeout?: number
        +

        Timeout for job (in milliseconds)

        +
    +

    Returns Promise<void>

+
+

addListener

+
    + +
  • +

    Alias for emitter.on(eventName, listener).

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

Protected checkForUpcomingJobs

+
+
+

emit

+
    + +
  • +

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments +to each.

    +

    Returns true if the event had listeners, false otherwise.

    +
    import { EventEmitter } from 'node:events';
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
+
    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      Rest ...args: any[]
    +

    Returns boolean

+
+

eventNames

+
    + +
  • +

    Returns an array listing the events for which the emitter has registered +listeners. The values in the array are strings or Symbols.

    +
    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
+
    + +

    Since

    v6.0.0

    +
    +

    Returns (string | symbol)[]

+
+

Protected getJobSchedule

+
+
+

getMaxListeners

+
    + +
  • +

    Returns the current max listener value for the EventEmitter which is either +set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    + +

    Since

    v1.0.0

    +
    +

    Returns number

+
+

jobExists

+
    + +
  • +

    Checks if job exists by id

    + +

    Returns

      +
    • true if job exists, false otherwise
      • +
    +
    +
    +

    Parameters

    +
      +
    • +
      jobId: string
      +

      id of the job

      +
    +

    Returns Promise<boolean>

+
+

listenerCount

+
    + +
  • +

    Returns the number of listeners listening for the event named eventName. +If listener is provided, it will return how many times the listener is found +in the list of the listeners of the event.

    + +

    Since

    v3.2.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event being listened for

      +
      • +
    • +
      Optional listener: Function
      +

      The event handler function

      +
    +

    Returns number

+
+

listeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
+
    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

+
+

off

+
    + +
  • +

    Alias for emitter.removeListener().

    + +

    Since

    v10.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

on

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      T extends keyof Events

    +
    +

    Parameters

    +
      +
    • +
      name: T
      • +
    • +
      callback: Events[T]
    +

    Returns JobScheduler

+
+

once

+
    + +
  • +

    Adds a one-timelistener function for the event named eventName. The +next time eventName is triggered, this listener is removed and then invoked.

    +
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    +

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the +event listener to the beginning of the listeners array.

    +
    import { EventEmitter } from 'node:events';
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
+
    + +

    Since

    v0.3.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

prependListener

+
    + +
  • +

    Adds the listener function to the beginning of the listeners array for the +event named eventName. No checks are made to see if the listener has +already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple +times.

    +
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v6.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

prependOnceListener

+
    + +
  • +

    Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +listener is removed, and then invoked.

    +
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v6.0.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      +

      The name of the event.

      +
      • +
    • +
      listener: ((...args: any[]) => void)
      +

      The callback function

      +
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

rawListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName, +including any wrappers (such as those created by .once()).

    +
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
+
    + +

    Since

    v9.4.0

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
    +

    Returns Function[]

+
+

removeAllListeners

+
    + +
  • +

    Removes all listeners, or those of the specified eventName.

    +

    It is bad practice to remove listeners added elsewhere in the code, +particularly when the EventEmitter instance was created by some other +component or module (e.g. sockets or file streams).

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional event: string | symbol
    +

    Returns JobScheduler

+
+

removeJob

+
    + +
  • +

    Removes job by its id

    + +

    Returns

    +
    +

    Parameters

    +
      +
    • +
      jobId: string
      +

      {string} - id of the job

      +
    +

    Returns Promise<void>

+
+

removeListener

+
    + +
  • +

    Removes the specified listener from the listener array for the event namedeventName.

    +
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
+
    +

    removeListener() will remove, at most, one instance of a listener from the +listener array. If any single listener has been added multiple times to the +listener array for the specified eventName, then removeListener() must be +called multiple times to remove each instance.

    +

    Once an event is emitted, all listeners attached to it at the +time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution +will not remove them fromemit() in progress. Subsequent events behave as expected.

    +
    import { EventEmitter } from 'node:events';
    class MyEmitter extends EventEmitter {}
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
+
    +

    Because listeners are managed using an internal array, calling this will +change the position indices of any listener registered after the listener +being removed. This will not impact the order in which listeners are called, +but it means that any copies of the listener array as returned by +the emitter.listeners() method will need to be recreated.

    +

    When a single function has been added as a handler multiple times for a single +event (as in the example below), removeListener() will remove the most +recently added instance. In the example the once('ping')listener is removed:

    +
    import { EventEmitter } from 'node:events';
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
+
    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.1.26

    +
    +
    +

    Parameters

    +
      +
    • +
      eventName: string | symbol
      • +
    • +
      listener: ((...args: any[]) => void)
      +
        +
      • +
          +
        • (...args: any[]): void
          • +
        • +
          +

          Parameters

          +
            +
          • +
            Rest ...args: any[]
          +

          Returns void

    +

    Returns JobScheduler

+
+

Protected runWorkerWithTimeout

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      file: string
      • +
    • +
      props: any
      • +
    • +
      timeout: number
    +

    Returns {
        promise: Promise<WorkerResult>;
        worker: Worker;
    }

    +
      +
    • +
      promise: Promise<WorkerResult>
      • +
    • +
      worker: Worker
+
+

Protected scheduleJobTo

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      job: Job
      • +
    • +
      date: Date
      • +
    • +
      index: number
    +

    Returns Promise<JobInstance>

+
+

setMaxListeners

+
    + +
  • +

    By default EventEmitters will print a warning if more than 10 listeners are +added for a particular event. This is a useful default that helps finding +memory leaks. The emitter.setMaxListeners() method allows the limit to be +modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    +

    Returns a reference to the EventEmitter, so that calls can be chained.

    + +

    Since

    v0.3.5

    +
    +
    +

    Parameters

    +
      +
    • +
      n: number
    +

    Returns JobScheduler

+
+

start

+
    + +
  • +

    Starts the scheduler (all jobs will be scheduled and executed when it's time).

    +
    +

    Returns Promise<void>

+
+

Protected startJobInstance

+
    + +
  • +

    Start a job instance. This will run the job and update the status of the instance.

    +
    +
    +

    Parameters

    +
      +
    • +
      instance: JobInstance
      +

      The job instance to start.

      +
    +

    Returns Promise<void>

+
+

stop

+
    + +
  • +

    Stops the scheduler (all jobs will be stopped and no new jobs will be scheduled).

    +
    +

    Returns void

+
+

Static getEventListeners

+
    + +
  • +

    Returns a copy of the array of listeners for the event named eventName.

    +

    For EventEmitters this behaves exactly the same as calling .listeners on +the emitter.

    +

    For EventTargets this is the only way to get the event listeners for the +event target. This is useful for debugging and diagnostic purposes.

    +
    import { getEventListeners, EventEmitter } from 'node:events';

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
    }
+
    + +

    Since

    v15.2.0, v14.17.0

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter | _DOMEventTarget
      • +
    • +
      name: string | symbol
    +

    Returns Function[]

+
+

Static listenerCount

+
    + +
  • +

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    +
    import { EventEmitter, listenerCount } from 'node:events';

    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
+
    + +

    Since

    v0.9.12

    + +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      +

      The emitter to query

      +
      • +
    • +
      eventName: string | symbol
      +

      The event name

      +
    +

    Returns number

+
+

Static on

+
    + +
  • +
    import { on, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
      ee.emit('foo', 'bar');
      ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo')) {
      // The execution of this inner block is synchronous and it
      // processes one event at a time (even with await). Do not use
      // if concurrent execution is required.
      console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
+
    +

    Returns an AsyncIterator that iterates eventName events. It will throw +if the EventEmitter emits 'error'. It removes all listeners when +exiting the loop. The value returned by each iteration is an array +composed of the emitted event arguments.

    +

    An AbortSignal can be used to cancel waiting on events:

    +
    import { on, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
+
    + +

    Since

    v13.6.0, v12.16.0

    + +

    Returns

    that iterates eventName events emitted by the emitter

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: EventEmitter
      • +
    • +
      eventName: string
      +

      The name of the event being listened for

      +
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns AsyncIterableIterator<any>

+
+

Static once

+
    + +
  • +

    Creates a Promise that is fulfilled when the EventEmitter emits the given +event or that is rejected if the EventEmitter emits 'error' while waiting. +The Promise will resolve with an array of all the arguments emitted to the +given event.

    +

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +semantics and does not listen to the 'error' event.

    +
    import { once, EventEmitter } from 'node:events';
    import process from 'node:process';

    const ee = new EventEmitter();

    process.nextTick(() => {
      ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
      ee.emit('error', err);
    });

    try {
      await once(ee, 'myevent');
    } catch (err) {
      console.error('error happened', err);
    }
+
    +

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the +'error' event itself, then it is treated as any other kind of event without +special handling:

    +
    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.error('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
+
    +

    An AbortSignal can be used to cancel waiting for the event:

    +
    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
+
    + +

    Since

    v11.13.0, v10.16.0

    +
    +
    +

    Parameters

    +
      +
    • +
      emitter: _NodeEventTarget
      • +
    • +
      eventName: string | symbol
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

    • + +
  • +
    +

    Parameters

    +
      +
    • +
      emitter: _DOMEventTarget
      • +
    • +
      eventName: string
      • +
    • +
      Optional options: StaticEventEmitterOptions
    +

    Returns Promise<any[]>

+
+

Static setMaxListeners

+
    + +
  • +
    import { setMaxListeners, EventEmitter } from 'node:events';

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);
+
    + +

    Since

    v15.4.0

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional n: number
      +

      A non-negative number. The maximum number of listeners per EventTarget event.

      +
      • +
    • +
      Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]
    +

    Returns void

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Job_Scheduler.ScheduleCalculator.html b/docs/v1.1.4/classes/Job_Scheduler.ScheduleCalculator.html new file mode 100644 index 0000000..ff756db --- /dev/null +++ b/docs/v1.1.4/classes/Job_Scheduler.ScheduleCalculator.html @@ -0,0 +1,115 @@ +ScheduleCalculator | Libraries
+
+ +
+
+
+
+ +

Class ScheduleCalculator

+
+

Hierarchy

+
    +
  • ScheduleCalculator
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Methods

+
hasNext +next +
+
+

Constructors

+
+

constructor

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      schedule: {
          endsOn?: Date;
          every: "minute";
          interval: number;
          maxOccurences?: number;
          skipFirst?: number;
          startsOn?: Date;
      } | {
          endsOn?: Date;
          every: "day";
          hour?: number;
          interval: number;
          maxOccurences?: number;
          minute?: number;
          skipFirst?: number;
          startsOn?: Date;
      } | {
          dayOfWeek: number[];
          endsOn?: Date;
          every: "week";
          hour?: number;
          interval: number;
          maxOccurences?: number;
          minute?: number;
          skipFirst?: number;
          startsOn?: Date;
      } | {
          day: number | "last";
          endsOn?: Date;
          every: "month";
          hour?: number;
          interval: number;
          maxOccurences?: number;
          minute?: number;
          skipFirst?: number;
          startsOn?: Date;
      } | {
          day: number | "last";
          endsOn?: Date;
          every: "year";
          hour?: number;
          interval: number;
          maxOccurences?: number;
          minute?: number;
          month: number;
          skipFirst?: number;
          startsOn?: Date;
      }
    +

    Returns ScheduleCalculator

+
+

Methods

+
+

hasNext

+
+
+

next

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.AnySchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.AnySchemaBuilder.html new file mode 100644 index 0000000..b1ebb71 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.AnySchemaBuilder.html @@ -0,0 +1,327 @@ +AnySchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class AnySchemaBuilder<TRequired, TExplicitType, TResult>

+
+

Any schema builder class. Similar to the any type +in TypeScript. Allows to define a schema for any value. +Use it when you don't know the type of the value.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use any() function instead.

+ +

Example

const schema = any();
const result = await schema.validate(123);
// result.valid === true
// result.object === 123
+
+
+
+

Type Parameters

+
    +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

    • +
  • +

    TResult = TExplicitType extends undefined ? any : TExplicitType

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearPreprocessors +clearValidators +createFromProps +introspect +preValidate +validate +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          isRequired: boolean;
          preprocessors: readonly Preprocessor<any>[];
          type: string;
          validators: readonly Validator<any>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns AnySchemaBuilder<TRequired, TExplicitType, TResult>

+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        isRequired: boolean;
        preprocessors: readonly Preprocessor<TResult>[];
        type: string;
        validators: readonly Validator<TResult>[];
    }

    +
      +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html new file mode 100644 index 0000000..b07a43a --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.ArraySchemaBuilder.html @@ -0,0 +1,423 @@ +ArraySchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class ArraySchemaBuilder<TElementSchema, TRequired, TExplicitType, TResult>

+
+

Similar to the Array type in TypeScript. It can be used to validate arrays of any type. +It can also be used to validate arrays of specific type. +For example, if you want to validate an array of numbers, +you can use array(number()) to create a schema builder. +If you want to validate an array of users, you can use +array().of(object({ name: string(), age: number() })) to create a schema builder. +If you want to validate an array of numbers or strings, +you can use array(union(number()).or(string())).

+

Also you can limit the length of the array by using minLength +and maxLength methods.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use array() function instead.

+ +

See

array

+
+
+

Type Parameters

+
    +
  • +

    TElementSchema extends SchemaBuilder<any, any>

    • +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

    • +
  • +

    TResult = TExplicitType extends undefined ? TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<infer T1, infer T2> ? InferType<SchemaBuilder<T1, T2>>[] : never : TExplicitType

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearMaxLength +clearMinLength +clearOf +clearPreprocessors +clearValidators +introspect +maxLength +minLength +of +preValidate +validate +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearMaxLength

+
    + +
  • +

    Clear max length of the valid array value for schema.

    +
    +

    Returns ArraySchemaBuilder<TElementSchema, TRequired, TExplicitType, TExplicitType extends undefined ? TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never : TExplicitType>

+
+

clearMinLength

+
    + +
  • +

    Clear minimal length of the valid array value for schema.

    +
    +

    Returns ArraySchemaBuilder<TElementSchema, TRequired, TExplicitType, TExplicitType extends undefined ? TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never : TExplicitType>

+
+

clearOf

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        elementSchema: undefined | TElementSchema;
        isRequired: boolean;
        maxLength: undefined | number;
        minLength: undefined | number;
        preprocessors: readonly Preprocessor<TResult>[];
        type: string;
        validators: readonly Validator<TResult>[];
    }

    +
      +
    • +
      elementSchema: undefined | TElementSchema
      +

      Schema of array item (if defined)

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      maxLength: undefined | number
      +

      Max length of a valid array

      +
      • +
    • +
      minLength: undefined | number
      +

      Min length of a valid array

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

maxLength

+
    + +
  • +

    Set max length of the valid array value for schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends number

    +
    +

    Parameters

    +
      +
    • +
      length: T
    +

    Returns ArraySchemaBuilder<TElementSchema, TRequired, TExplicitType, TExplicitType extends undefined ? TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never : TExplicitType>

+
+

minLength

+
    + +
  • +

    Set minimal length of the valid array value for schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends number

    +
    +

    Parameters

    +
      +
    • +
      length: T
    +

    Returns ArraySchemaBuilder<TElementSchema, TRequired, TExplicitType, TExplicitType extends undefined ? TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never : TExplicitType>

+
+

of

+
    + +
  • +

    Set a schema that every array item has to satisfy. If it is not set, +Item of any type is allowed.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      schema: TSchema
      +

      Schema that every array item has to satisfy

      +
    +

    Returns ArraySchemaBuilder<TSchema, TRequired, TExplicitType, TExplicitType extends undefined ? TSchema extends undefined ? any[] : TSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never : TExplicitType>

+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html new file mode 100644 index 0000000..5b2c8a9 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.BooleanSchemaBuilder.html @@ -0,0 +1,455 @@ +BooleanSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class BooleanSchemaBuilder<TResult, TRequired, TExplicitType, TFinalResult>

+
+

Similar to boolean type in TypeScript. +Allows to define a schema for a boolean value. It can be required or optional. +It can be restricted to be equal to a certain value.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use boolean() function instead.

+ +

Example

const schema = boolean().equals(true);
const result = await schema.validate(true);
// result.valid === true
// result.object === true
+
+ +

Example

const schema = boolean().equals(false);
const result = await schema.validate(true);
// result.valid === false
// result.errors[0].message === 'is expected to be equal to 'false''
+
+ +

Example

const schema = boolean().equals(true).optional();
const result = await schema.validate(undefined);
// result.valid === true
// result.object === undefined
+
+ +

See

boolean

+
+
+

Type Parameters

+
    +
  • +

    TResult = boolean

    • +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

    • +
  • +

    TFinalResult = TExplicitType extends undefined ? TResult : TExplicitType

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearEquals +clearHasType +clearPreprocessors +clearValidators +createFromProps +equals +hasType +introspect +optional +preValidate +required +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearEquals

+
+
+

clearHasType

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          equalsTo: undefined | boolean;
          isRequired: boolean;
          preprocessors: readonly Preprocessor<TReq>[];
          type: string;
          validators: readonly Validator<TReq>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns BooleanSchemaBuilder<TResult, TRequired, TExplicitType, TFinalResult>

+
+

equals

+
+
+

hasType

+
    + +
  • +

    Set type of schema explicitly. notUsed param is needed only for cas when JS is used. E.g. when you +can't call method like schema.hasType<Date>(), so instead you can call schema.hasType(new Date()) +with the same result.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      Optional notUsed: T
    +

    Returns BooleanSchemaBuilder<TResult, true, T, T extends undefined ? TResult : T>

+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        equalsTo: undefined | boolean;
        isRequired: boolean;
        preprocessors: readonly Preprocessor<TFinalResult>[];
        type: string;
        validators: readonly Validator<TFinalResult>[];
    }

    +
      +
    • +
      equalsTo: undefined | boolean
      +

      If set, restrict object to be equal to a certain value.

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TFinalResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TFinalResult>[]
      +

      Array of validator functions

      +
+
+

optional

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

required

+
+
+

validate

+
+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          equalsTo: undefined | boolean;
          isRequired: boolean;
          preprocessors: readonly Preprocessor<any>[];
          type: string;
          validators: readonly Validator<any>[];
      }>
    +

    Returns BooleanSchemaBuilder<boolean, any, undefined, boolean>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.DateSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.DateSchemaBuilder.html new file mode 100644 index 0000000..3f53e13 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.DateSchemaBuilder.html @@ -0,0 +1,543 @@ +DateSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class DateSchemaBuilder<TResult, TRequired>

+
+

Allows to create Date schema. It can be required or optional. +It can be restricted to be: equal to a certain value, in future, in past, in a certain range. +Supports parsing from JSON string and UNIX epoch (using preprocessors).

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use date() function instead.

+ +

Example

const date = new Date(2020, 0, 2);
const schema = date().min(new Date(2020, 0, 1));
const result = await schema.validate(date);
// result.valid === true
// result.object === date
+
+ +

Example

const schema = date();
const result = await schema.validate('2020-01-01');
// result.valid === false
// result.errors[0].message === 'is expected to be a date'
+
+ +

Example

const schema = date().parseFromJson();
const result = await schema.validate('2020-01-01T00:00:00.000Z');
// result.valid === true
// result.object is equal to corresponding Date object
+
+ +

Example

const schema = date().parseFromEpoch();
const result = await schema.validate(1577836800000);
// result.valid === true
// result.object is equal to corresponding Date object
+
+ +

See

date

+
+
+

Type Parameters

+
    +
  • +

    TResult = Date

    • +
  • +

    TRequired extends boolean = true

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
acceptEpoch +acceptJsonString +addPreprocessor +addValidator +clearEquals +clearIsInFuture +clearIsInPast +clearMax +clearMin +clearPreprocessors +clearValidators +doNotAcceptEpoch +doNotAcceptJsonString +equals +introspect +isInFuture +isInPast +max +min +preValidate +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

acceptEpoch

+
+
+

acceptJsonString

+
+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearEquals

+
+
+

clearIsInFuture

+
+
+

clearIsInPast

+
+
+

clearMax

+
+
+

clearMin

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

doNotAcceptEpoch

+
+
+

doNotAcceptJsonString

+
+
+

equals

+
+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        ensureIsInFuture: boolean;
        ensureIsInPast: boolean;
        equalsTo: undefined | Date;
        isRequired: boolean;
        max: undefined | Date;
        min: undefined | Date;
        parseFromEpoch: boolean;
        parseFromJson: boolean;
        preprocessors: Preprocessor<TResult>[];
        type: string;
        validators: Validator<TResult>[];
    }

    +
      +
    • +
      ensureIsInFuture: boolean
      +

      Make sure that date is in future. false by default.

      +
      • +
    • +
      ensureIsInPast: boolean
      +

      Make sure that date is in past. false by default.

      +
      • +
    • +
      equalsTo: undefined | Date
      +

      If set, restrict date to be equal to a certain value.

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      max: undefined | Date
      +

      Max valid value (if defined).

      +
      • +
    • +
      min: undefined | Date
      +

      Min valid value (if defined).

      +
      • +
    • +
      parseFromEpoch: boolean
      +

      If set, schema will try to parse date from the UNIX epoch (number). +false by default.

      +
      • +
    • +
      parseFromJson: boolean
      +

      If set, schema will try to parse date from JSON string. +false by default.

      +
      • +
    • +
      preprocessors: Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

isInFuture

+
+
+

isInPast

+
+
+

max

+
+
+

min

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          ensureIsInFuture: boolean;
          ensureIsInPast: boolean;
          equalsTo: undefined | Date;
          isRequired: boolean;
          max: undefined | Date;
          min: undefined | Date;
          parseFromEpoch: boolean;
          parseFromJson: boolean;
          preprocessors: Preprocessor<Date>[];
          type: string;
          validators: Validator<Date>[];
      }>
    +

    Returns DateSchemaBuilder<Date, true>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html new file mode 100644 index 0000000..fe61e4e --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.FunctionSchemaBuilder.html @@ -0,0 +1,346 @@ +FunctionSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class FunctionSchemaBuilder<TRequired, TExplicitType, TResult>

+
+

Schema builder for functions. Allows to define a schema for a function. +It can be: required or optional.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use func() function instead.

+ +

Example

const schema = func();
const result = await schema.validate(() => {});
// result.valid === true
// result.object === () => {}
+
+ +

Example

const schema = func().optional();
const result = await schema.validate(undefined);
// result.valid === true
// result.object === undefined
+
+ +

See

func

+
+
+

Type Parameters

+
    +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

    • +
  • +

    TResult = TExplicitType extends undefined ? ((...args: any[]) => any) : TExplicitType

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearPreprocessors +clearValidators +createFromProps +introspect +preValidate +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          isRequired: boolean;
          preprocessors: readonly Preprocessor<((...args: any[]) => any)>[];
          type: string;
          validators: readonly Validator<((...args: any[]) => any)>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns FunctionSchemaBuilder<TRequired, TExplicitType, TResult>

+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        isRequired: boolean;
        preprocessors: readonly Preprocessor<TResult>[];
        type: string;
        validators: readonly Validator<TResult>[];
    }

    +
      +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          isRequired: boolean;
          preprocessors: readonly Preprocessor<((...args: any[]) => any)>[];
          type: string;
          validators: readonly Validator<((...args: any[]) => any)>[];
      }>
    +

    Returns FunctionSchemaBuilder<true, undefined, ((...args: any[]) => any)>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html new file mode 100644 index 0000000..57907f7 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.NumberSchemaBuilder.html @@ -0,0 +1,541 @@ +NumberSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class NumberSchemaBuilder<TResult, TRequired>

+
+

Number schema builder class. Allows to create Number schemas. +Can be required or optional, can be restricted to be equal to a certain value, +can be restricted to be in a certain range, can be restricted to be integer.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use number() function instead.

+ +

Example

const schema = number().equals(42);
const result = await schema.validate(42);
// result.valid === true
// result.object === 42
+
+ +

Example

const schema = number();
const result = await schema.validate('42');
// result.valid === false
// result.errors[0].message === 'is expected to be a number'
+
+ +

Example

const schema = number().min(0).max(100);
const result = await schema.validate(42);
// result.valid === true
// result.object === 42
+
+ +

Example

const schema = number().min(0).max(100);
const result = await schema.validate(142.5);
// result.valid === false
// result.errors[0].message === 'is expected to be less than or equal to 100'
+
+ +

See

number

+
+
+

Type Parameters

+
    +
  • +

    TResult = number

    • +
  • +

    TRequired extends boolean = true

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +canBeInfinite +canBeNaN +clearEquals +clearMax +clearMin +clearPreprocessors +clearValidators +createFromProps +equals +introspect +isFinite +isFloat +isInteger +max +min +notNaN +preValidate +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

canBeInfinite

+
+
+

canBeNaN

+
+
+

clearEquals

+
+
+

clearMax

+
+
+

clearMin

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

      • +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          ensureIsFinite: boolean;
          ensureNotNaN: boolean;
          equalsTo: undefined | number;
          isInteger: boolean;
          isRequired: boolean;
          max: undefined | number;
          min: undefined | number;
          preprocessors: Preprocessor<T>[];
          type: string;
          validators: Validator<T>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns NumberSchemaBuilder<TResult, TRequired>

+
+

equals

+
+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        ensureIsFinite: boolean;
        ensureNotNaN: boolean;
        equalsTo: undefined | number;
        isInteger: boolean;
        isRequired: boolean;
        max: undefined | number;
        min: undefined | number;
        preprocessors: Preprocessor<TResult>[];
        type: string;
        validators: Validator<TResult>[];
    }

    +
      +
    • +
      ensureIsFinite: boolean
      +

      Make sure that object is not different kinds of infinity. true by default.

      +
      • +
    • +
      ensureNotNaN: boolean
      +

      Make sure that object is not NaN. true by default.

      +
      • +
    • +
      equalsTo: undefined | number
      +

      If set, restrict object to be equal to a certain value.

      +
      • +
    • +
      isInteger: boolean
      +

      Allow only integer values (floating point values will be rejected +as invalid)

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      max: undefined | number
      +

      Max valid value (if defined).

      +
      • +
    • +
      min: undefined | number
      +

      Min valid value (if defined).

      +
      • +
    • +
      preprocessors: Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

isFinite

+
+
+

isFloat

+
+
+

isInteger

+
+
+

max

+
+
+

min

+
+
+

notNaN

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          ensureIsFinite: boolean;
          ensureNotNaN: boolean;
          equalsTo: undefined | number;
          isInteger: boolean;
          isRequired: boolean;
          max: undefined | number;
          min: undefined | number;
          preprocessors: Preprocessor<number>[];
          type: string;
          validators: Validator<number>[];
      }>
    +

    Returns NumberSchemaBuilder<number, true>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html new file mode 100644 index 0000000..e68dc0a --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.ObjectSchemaBuilder.html @@ -0,0 +1,812 @@ +ObjectSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class ObjectSchemaBuilder<TProperties, TRequired, TExplicitType>

+
+

Object schema builder class. Similar to the object type +in JS. Allows to define a schema for object value. +Should be used to validate objects with specific properties. +Properties should be defined as their own schema builders. +You can use any SchemaBuilder e.g. string(), number(), +boolean(), array(), object(), etc. to define properties. +Which means that you can define nested objects and arrays of +any complexity.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use object() function instead.

+ +

Example

const schema = object({
   name: string(),
   age: number()
});

const result = await schema.validate({
  name: 'John',
  age: 30
});

// result.valid === true
// result.object === { name: 'John', age: 30 }
+
+ +

Example

const schema = object({
  name: string(),
  age: number().optional()
});

const result = await schema.validate({
 name: 'John'
});
// result.valid === true
// result.object === { name: 'John' }
+
+ +

Example

const schema = object({
 name: string(),
 age: number();
});
const result = await schema.validate({
 name: 'John'
});

// result.valid === false
// result.errors[0].message === "is expected to have property 'age'"
+
+ +

Example

const schema = object({
name: string(),
address: object({
    city: string(),
    country: string()
  })
});
const result = await schema.validate({
name: 'John',
address: {
   city: 'New York',
   country: 'USA'
 }
});
// result.valid === true
// result.object === {
//   name: 'John',
//   address: {
//     city: 'New York',
//     country: 'USA'
//   }
// }
+
+ +

See

object

+
+
+

Type Parameters

+
    +
  • +

    TProperties extends Record<string, SchemaBuilder<any, any>> = {}

    • +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

+
+

Hierarchy

+
    +
  • SchemaBuilder<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType, TRequired> +
      +
    • ObjectSchemaBuilder
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
acceptUnknownProps +addPreprocessor +addProp +addProps +addValidator +clearPreprocessors +clearValidators +createFromProps +intersect +introspect +makeAllPropsOptional +makeAllPropsRequired +makePropOptional +makePropRequired +modifyPropSchema +notAcceptUnknownProps +omit +partial +pick +preValidate +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

acceptUnknownProps

+
+
+

addPreprocessor

+
+
+

addProp

+
    + +
  • +

    Adds a new property to the object schema. The new property +will be validated according to the provided schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TType extends SchemaBuilder<any, any, TType>

      • +
    • +

      TName extends string

    +
    +

    Parameters

    +
      +
    • +
      propName: TName
      +

      name of the new property

      +
      • +
    • +
      schema: TType
      +

      schema builder of the new property

      +
    +

    Returns ObjectSchemaBuilder<TProperties & { [ k in string]: TType }, TRequired, TExplicitType>

+
+

addProps

+
+
+

addValidator

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends Record<string, SchemaBuilder<any, true>>

      • +
    • +

      R extends boolean = true

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          acceptUnknownProps: boolean;
          isRequired: boolean;
          preprocessors: readonly Preprocessor<RespectPropsOptionality<T>>[];
          properties: T;
          type: string;
          validators: readonly Validator<RespectPropsOptionality<T>>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns ObjectSchemaBuilder<TProperties, TRequired, TExplicitType>

+
+

intersect

+
+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        acceptUnknownProps: boolean;
        isRequired: boolean;
        preprocessors: readonly Preprocessor<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType>[];
        properties: TProperties;
        type: string;
        validators: readonly Validator<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType>[];
    }

    +
      +
    • +
      acceptUnknownProps: boolean
      +

      If set to true, schema validation will not +return errors if object contains fields which +are not defined in the schema properties. +Set to false by default

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      preprocessors: readonly Preprocessor<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      properties: TProperties
      +

      Properties defined in schema

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType>[]
      +

      Array of validator functions

      +
+
+

makeAllPropsOptional

+
+
+

makeAllPropsRequired

+
+
+

makePropOptional

+
+
+

makePropRequired

+
    + +
  • +

    Marks prop as required property. +If prop does not exists in the current schema, +an error will be thrown.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      prop: K
      +

      name of the property

      +
    +

    Returns ObjectSchemaBuilder<MakeChildRequired<TProperties, K>, TRequired, TExplicitType>

+
+

modifyPropSchema

+
    + +
  • +

    Modify schema for propName and return a new schema. +Could be useful if you want to leave all schema intact, but +change a type of one property.

    + +

    Returns

    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

      • +
    • +

      R extends SchemaBuilder<any, any, R>

    +
    +

    Parameters

    +
      +
    • +
      propName: K
      +

      name of the property (string)

      +
      • +
    • +
      callback: ((builder: TProperties[K]) => R)
      +

      callback function returning a new schema fo the propName. As a first parameter +you will receive an old schema for propName.

      +
      +
        +
      • +
          +
        • (builder: TProperties[K]): R
          • +
        • +
          +

          Parameters

          +
            +
          • +
            builder: TProperties[K]
          +

          Returns R

    +

    Returns ObjectSchemaBuilder<ModifyPropSchema<TProperties, K, R>, TRequired, TExplicitType>

+
+

notAcceptUnknownProps

+
+
+

omit

+
    + +
  • +

    Omits properties listed in properties from the schema. +Consider Omit<Type, 'prop1'|'prop2'...> as a good illustration +from the TS world.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      properties: K[]
      +

      array of property names (strings) to remove from the schema.

      +
    +

    Returns ObjectSchemaBuilder<Omit<TProperties, K>, TRequired, TExplicitType>

    • + +
  • +

    Removes propName from the list of properties.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TProperty extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      propName: TProperty
      +

      property name to remove. Schema should contain +this property. An error will be thrown otherwise.

      +
    +

    Returns ObjectSchemaBuilder<Omit<TProperties, TProperty>, TRequired, TExplicitType>

    • + +
  • +

    Removes all properties of schema from the current schema. +Omit<TSchema, keyof TAnotherSchema> as a good illustration +from the TS world.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      schema: T
      +

      schema builder to take properties from.

      +
    +

    Returns T extends ObjectSchemaBuilder<TProps, TRequired, TExplicitType> ? ObjectSchemaBuilder<Omit<TProperties, keyof TProps>, TRequired, TExplicitType> : never

+
+

partial

+
    + +
  • +

    Marks all properties in the current schema as optional. +It is the same as call .optional('propname') where propname is the name +of every property in the schema.

    +
    +

    Returns ObjectSchemaBuilder<MakeChildrenOptional<TProperties>, TRequired, TExplicitType>

    • + +
  • +

    Marks all properties from properties as optional in the schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      properties: K[]
      +

      list of property names (string) to make optional

      +
    +

    Returns ObjectSchemaBuilder<Omit<TProperties, K> & Pick<MakeChildrenOptional<TProperties>, K>, TRequired, TExplicitType>

    • + +
  • +

    Marks property propName as optional in the schema.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      TProperty extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      propName: TProperty
      +

      the name of the property (string).

      +
    +

    Returns ObjectSchemaBuilder<Omit<TProperties, TProperty> & Pick<MakeChildrenOptional<TProperties>, TProperty>, TRequired, TExplicitType>

+
+

pick

+
    + +
  • +

    Returns a new schema containing only properties listed in +properties array.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      properties: K[]
      +

      array of property names (strings)

      +
    +

    Returns ObjectSchemaBuilder<Pick<TProperties, K>, TRequired, undefined>

    • + +
  • +

    Returns new schema based on the current schema. This new schema +will consists only from properties which names are taken from the +schema object schema.

    +
    +
    +

    Type Parameters

    +
    +
    +

    Parameters

    +
      +
    • +
      schema: K
      +

      schema to take property names list from

      +
    +

    Returns K extends ObjectSchemaBuilder<TProps, T1, T2> ? ObjectSchemaBuilder<Omit<TProperties, Exclude<keyof TProperties, keyof TProps>>, TRequired, undefined> : never

    • + +
  • +

    Returns a new schema consisting of only one property +(taken from the property property name). If the property +does not exists in the current schema, an error will be thrown.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      K extends string | number | symbol

    +
    +

    Parameters

    +
      +
    • +
      property: K
      +

      the name of the property (string).

      +
    +

    Returns ObjectSchemaBuilder<Pick<TProperties, K>, TRequired, undefined>

+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

validate

+
    + +
  • +

    Performs validion of object schema over the object.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType
      • +
    • +
      Optional context: ValidationContext
      +

      Optional ValidationContext settings.

      +
    +

    Returns Promise<ValidationResult<undefined extends TExplicitType ? RespectPropsOptionality<TProperties> : TExplicitType>>

+
+

Static create

+
    + +
  • +
    +

    Type Parameters

    +
      +
    • +

      P extends Record<string, SchemaBuilder<any, true>>

      • +
    • +

      R extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          acceptUnknownProps: boolean;
          isRequired: boolean;
          preprocessors: readonly Preprocessor<RespectPropsOptionality<P>>[];
          properties: P;
          type: string;
          validators: readonly Validator<RespectPropsOptionality<P>>[];
      }>
    +

    Returns ObjectSchemaBuilder<{}, true, undefined>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.SchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.SchemaBuilder.html new file mode 100644 index 0000000..0691af9 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.SchemaBuilder.html @@ -0,0 +1,400 @@ +SchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class SchemaBuilder<TResult, TRequired>Abstract

+
+

Base class for all schema builders. Provides basic functionality for schema building.

+

Note: this class is not intended to be used directly, use one of the subclasses instead.

+ +

Typeparam

TResult Type of the object that will be returned by validate() method.

+ +

Typeparam

TRequired If true, object will be required. If false, object will be optional.

+
+
+

Type Parameters

+
    +
  • +

    TResult = any

    • +
  • +

    TRequired extends boolean = true

+
+

Hierarchy

+
+
+
+
+ +
+
+

Constructors

+
constructor +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearHasType +clearPreprocessors +clearValidators +createFromProps +hasType +introspect +optional +preValidate +required +validate +
+
+

Constructors

+
+

Protected constructor

+
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
+
+

Protected type

+
+
+

Protected validators

+
+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

Abstract clearHasType

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected Abstract createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Parameters

    +
      +
    • +
      props: any
      +

      arbitrary props object

      +
    +

    Returns SchemaBuilder<TResult, TRequired>

+
+

Abstract hasType

+
    + +
  • +

    Set type of schema explicitly. notUsed param is needed only for cas when JS is used. E.g. when you +can't call method like schema.hasType<Date>(), so instead you can call schema.hasType(new Date()) +with the same result.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

    +
    +

    Parameters

    +
      +
    • +
      Optional notUsed: T
    +

    Returns any

+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        isRequired: boolean;
        preprocessors: readonly Preprocessor<TResult>[];
        type: string;
        validators: readonly Validator<TResult>[];
    }

    +
      +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

optional

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

required

+
+
+

Abstract validate

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.StringSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.StringSchemaBuilder.html new file mode 100644 index 0000000..ac0fcb2 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.StringSchemaBuilder.html @@ -0,0 +1,564 @@ +StringSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class StringSchemaBuilder<TResult, TRequired>

+
+

Allows to define a schema for a string. It can be: required or optional, +restricted to be equal to a certain value, restricted to have a certain +length, restricted to start with a certain value, restricted to end with +a certain value, restricted to match a certain regular expression.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use string() function instead.

+ +

Example

const schema = string().equals('hello');
const result = await schema.validate('hello');
// result.valid === true
// result.object === 'hello'
+
+ +

Example

const schema = string().equals('hello');
const result = await schema.validate('world');
// result.valid === false
// result.errors[0].message === "is expected to be equal to 'hello'"
+
+ +

Example

const schema = string().minLength(5);
const result = await schema.validate('hello');
// result.valid === true
// result.object === 'hello'
+
+ +

Example

const schema = string().minLength(5);
const result = await schema.validate('hi');
// result.valid === false
// result.errors[0].message === 'is expected to have a length of at least 5'
+
+ +

Example

const schema = string().minLength(2).maxLength(5);
const result = await schema.validate('yes');
// result.valid === true
// result.object === 'yes'
+
+ +

Example

const schema = string('no');
const result = await schema.validate('yes');
// result.valid === false
// result.errors[0].message === "is expected to be equal to 'no'"
+
+ +

See

string

+
+
+

Type Parameters

+
    +
  • +

    TResult = string

    • +
  • +

    TRequired extends boolean = true

+
+

Hierarchy

+
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearEndsWith +clearEquals +clearMatches +clearMaxLength +clearMinLength +clearPreprocessors +clearStartsWith +clearValidators +createFromProps +endsWith +equals +introspect +matches +maxLength +minLength +preValidate +startsWith +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearEndsWith

+
+
+

clearEquals

+
+
+

clearMatches

+
+
+

clearMaxLength

+
+
+

clearMinLength

+
+
+

clearPreprocessors

+
+
+

clearStartsWith

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T

      • +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          endsWith: undefined | string;
          equalsTo: undefined | string;
          isRequired: boolean;
          matches: undefined | RegExp;
          maxLength: undefined | number;
          minLength: undefined | number;
          preprocessors: Preprocessor<T>[];
          startsWith: undefined | string;
          type: string;
          validators: Validator<T>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns StringSchemaBuilder<TResult, TRequired>

+
+

endsWith

+
+
+

equals

+
+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        endsWith: undefined | string;
        equalsTo: undefined | string;
        isRequired: boolean;
        matches: undefined | RegExp;
        maxLength: undefined | number;
        minLength: undefined | number;
        preprocessors: Preprocessor<TResult>[];
        startsWith: undefined | string;
        type: string;
        validators: Validator<TResult>[];
    }

    +
      +
    • +
      endsWith: undefined | string
      +

      If set, restrict string to end with a certain value.

      +
      • +
    • +
      equalsTo: undefined | string
      +

      If set, restrict object to be equal to a certain value.

      +
      • +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      matches: undefined | RegExp
      +

      If set, restrict string to match a certain regular expression.

      +
      • +
    • +
      maxLength: undefined | number
      +

      Max length of the string (if defined).

      +
      • +
    • +
      minLength: undefined | number
      +

      Min length of the string (if defined).

      +
      • +
    • +
      preprocessors: Preprocessor<TResult>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      startsWith: undefined | string
      +

      If set, restrict string to start with a certain value.

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: Validator<TResult>[]
      +

      Array of validator functions

      +
+
+

matches

+
+
+

maxLength

+
+
+

minLength

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

startsWith

+
+
+

validate

+
+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          endsWith: undefined | string;
          equalsTo: undefined | string;
          isRequired: boolean;
          matches: undefined | RegExp;
          maxLength: undefined | number;
          minLength: undefined | number;
          preprocessors: Preprocessor<string>[];
          startsWith: undefined | string;
          type: string;
          validators: Validator<string>[];
      }>
    +

    Returns StringSchemaBuilder<string, true>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html b/docs/v1.1.4/classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html new file mode 100644 index 0000000..811ac21 --- /dev/null +++ b/docs/v1.1.4/classes/Schema_Definition_And_Validation.UnionSchemaBuilder.html @@ -0,0 +1,447 @@ +UnionSchemaBuilder | Libraries
+
+ +
+
+
+
+ +

Class UnionSchemaBuilder<TOptions, TRequired, TExplicitType>

+
+

Union schema builder class. Allows to create schemas +containing alternatives. E.g. string | number | Date. +Use it when you want to define a schema for a value +that can be of different types. The type of the value +will be determined by the first schema that succeeds +validation. Any schema type can be supplied as variant. +Which means that you are not limited to primitive types and +can construct complex types as well, e.g. object | array.

+

NOTE this class is exported only to give opportunity to extend it +by inheriting. It is not recommended to create an instance of this class +directly. Use union() function instead.

+ +

Example

const schema = union(string('foo')).or(string('bar'));
const result = await schema.validate('foo');
// result.valid === true
// result.object === 'foo'
+
+ +

Example

const schema = union(string('foo')).or(string('bar'));
const result = await schema.validate('baz');
// result.valid === false
+
+ +

Example

const schema = union(string('yes')).or(string('no')).or(number(0)).or(number(1));
// equals to 'yes' | 'no' | 0 | 1 in TS
const result = await schema.validate('yes');
// result.valid === true
// result.object === 'yes'

const result2 = await schema.validate(0);
// result2.valid === true
// result2.object === 0

const result3 = await schema.validate('baz');
// result3.valid === false

const result4 = await schema.validate(2);
// result4.valid === false
+
+ +

See

union

+
+
+

Type Parameters

+
    +
  • +

    TOptions extends readonly SchemaBuilder<any, any>[]

    • +
  • +

    TRequired extends boolean = true

    • +
  • +

    TExplicitType = undefined

+
+

Hierarchy

+
    +
  • SchemaBuilder<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType, TRequired> +
      +
    • UnionSchemaBuilder
+
+
+
+ +
+
+

Accessors

+
isRequired +preprocessors +type +validators +
+
+

Methods

+
addPreprocessor +addValidator +clearPreprocessors +clearValidators +createFromProps +introspect +or +preValidate +removeFirstOption +removeOption +reset +validate +create +
+
+

Accessors

+
+

Protected isRequired

+
+
+

Protected preprocessors

+
    +
  • get preprocessors(): Preprocessor<TResult>[]
    • +
  • +

    A list of preprocessors associated with +the Builder

    +
    +

    Returns Preprocessor<TResult>[]

+
+

Protected type

+
+
+

Protected validators

+
    +
  • get validators(): Validator<TResult>[]
    • +
  • +

    A list of validators associated with +the Builder

    +
    +

    Returns Validator<TResult>[]

+
+

Methods

+
+

addPreprocessor

+
+
+

addValidator

+
+
+

clearPreprocessors

+
+
+

clearValidators

+
+
+

Protected createFromProps

+
    + +
  • +

    Protected method used to create an new instance of the Builder +defined by the props object. Should be used to instanticate new +builders to keep builder's immutability.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends readonly SchemaBuilder<any, any>[]

      • +
    • +

      TReq extends boolean

    +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          isRequired: boolean;
          options: T;
          preprocessors: readonly Preprocessor<SchemaArrayToUnion<T>>[];
          type: string;
          validators: readonly Validator<SchemaArrayToUnion<T>>[];
      }>
      +

      arbitrary props object

      +
    +

    Returns UnionSchemaBuilder<TOptions, TRequired, TExplicitType>

+
+

introspect

+
    + +
  • +

    Generates a serializable object describing the defined schema

    +
    +

    Returns {
        isRequired: boolean;
        options: TOptions;
        preprocessors: readonly Preprocessor<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType>[];
        type: string;
        validators: readonly Validator<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType>[];
    }

    +
      +
    • +
      isRequired: boolean
      +

      If set to false, schema will be optional (null or undefined values +will be considered as valid).

      +
      • +
    • +
      options: TOptions
      +

      Array of schemas participating in the union.

      +
      • +
    • +
      preprocessors: readonly Preprocessor<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType>[]
      +

      Array of preprocessor functions

      +
      • +
    • +
      type: string
      +

      String id of schema type, e.g. string', numberorobject`.

      +
      • +
    • +
      validators: readonly Validator<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType>[]
      +

      Array of validator functions

      +
+
+

or

+
+
+

Protected preValidate

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      object: any
      +

      Object to validate

      +
      • +
    • +
      Optional context: ValidationContext
    +

    Returns Promise<PreValidationResult<any, {
        validatedObject: any;
    }>>

+
+

removeFirstOption

+
+
+

removeOption

+
    + +
  • +

    Removes option by its index. If index is out of bounds, +an error is thrown.

    +
    +
    +

    Type Parameters

    +
      +
    • +

      T extends number

    +
    +

    Parameters

    +
      +
    • +
      index: T
      +

      index of the option, starting from 0.

      +
    +

    Returns UnionSchemaBuilder<[...TakeBeforeIndex<TOptions, T>[], ...TakeAfterIndex<TOptions, T, []>[]], TRequired, TExplicitType>

+
+

reset

+
+
+

validate

+
    + +
  • +

    Performs validion of the union schema over object.

    +
    +
    +

    Parameters

    +
      +
    • +
      object: TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType
      • +
    • +
      Optional context: ValidationContext
      +

      Optional ValidationContext settings.

      +
    +

    Returns Promise<ValidationResult<TExplicitType extends undefined ? SchemaArrayToUnion<TOptions> : TExplicitType>>

+
+

Static create

+
    + +
  • +
    +

    Parameters

    +
      +
    • +
      props: Partial<{
          isRequired: boolean;
          options: any;
          preprocessors: readonly Preprocessor<any>[];
          type: string;
          validators: readonly Validator<any>[];
      }>
    +

    Returns UnionSchemaBuilder<any, true, undefined>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Deep_operations_on_objects.deepEqual.html b/docs/v1.1.4/functions/Deep_operations_on_objects.deepEqual.html new file mode 100644 index 0000000..5c45cea --- /dev/null +++ b/docs/v1.1.4/functions/Deep_operations_on_objects.deepEqual.html @@ -0,0 +1,87 @@ +deepEqual | Libraries
+
+ +
+
+
+
+ +

Function deepEqual

+
+
    + +
  • +

    Compares two objects and returns true if they +have the same structure and values. Can work +with arrays and objects, nested objects, +recursive objects, dates, etc.

    + +

    Returns

    true if the objects are equal, false otherwise

    +
    +
    +

    Parameters

    +
      +
    • +
      p1: any
      +

      first object

      +
      • +
    • +
      p2: any
      +

      second object

      +
      • +
    • +
      Optional options: {
          disregardArrayOrder?: boolean;
      }
      +

      additional options

      +
      +
        +
      • +
        Optional disregardArrayOrder?: boolean
        +

        if true, the order of the elements in the array will be disregarded +e.g. [1, 2] and [2, 1] will be considered equal

        +
    +

    Returns boolean

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Deep_operations_on_objects.deepExtend.html b/docs/v1.1.4/functions/Deep_operations_on_objects.deepExtend.html new file mode 100644 index 0000000..2bd310a --- /dev/null +++ b/docs/v1.1.4/functions/Deep_operations_on_objects.deepExtend.html @@ -0,0 +1,69 @@ +deepExtend | Libraries
+
+ +
+
+
+
+ +

Function deepExtend

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.any.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.any.html new file mode 100644 index 0000000..7203e7c --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.any.html @@ -0,0 +1,85 @@ +any | Libraries
+
+ +
+
+
+
+ +

Function any

+
+
    + +
  • +

    Creates a any schema.

    + +

    Example

     const anyObject = any();

    // null - invalid
    // undefined - invalid
    // string - valid
    // {} - valid
    // Date -valid
    // { someProp: 123 } - valid
    // etc
+
    + +

    Example

     const anyObject = any().optional();
     // null - valid
     // undefined - valid
     // string - valid
     // {} - valid
     // Date -valid
     // { someProp: 123 } - valid
+
    +
    +

    Returns AnySchemaBuilder<true, undefined, any>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.array.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.array.html new file mode 100644 index 0000000..6c39a74 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.array.html @@ -0,0 +1,92 @@ +array | Libraries
+
+ +
+
+
+
+ +

Function array

+
+
    + +
  • +

    Creates a Array schema.

    + +

    Example

     const schema = array().minLength(2).maxLength(5).of(string());
     // [] - invalid
     // ['a', 'b'] - valid
     // ['a', 'b', 'c', 'd', 'e', 'f'] - invalid
     // ['a', 'b', 'c', 'd', 'e'] - valid
     // ['a', 'b', 'c', 'd', 1] - invalid
     // ['a', 'b', null] - invalid
     // null - invalid
     // undefined - invalid
+
    +
    +
    +

    Type Parameters

    +
      +
    • +

      TElementSchema extends SchemaBuilder<any, any, TElementSchema>

    +
    +

    Parameters

    +
      +
    • +
      Optional elementSchema: TElementSchema
    +

    Returns ArraySchemaBuilder<TElementSchema, true, undefined, TElementSchema extends undefined ? any[] : TElementSchema extends SchemaBuilder<T1, T2> ? (T2 extends true ? T1 : undefined | T1)[] : never>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.boolean.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.boolean.html new file mode 100644 index 0000000..ca530b8 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.boolean.html @@ -0,0 +1,79 @@ +boolean | Libraries
+
+ +
+
+
+
+ +

Function boolean

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.date.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.date.html new file mode 100644 index 0000000..5ccb441 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.date.html @@ -0,0 +1,79 @@ +date | Libraries
+
+ +
+
+
+
+ +

Function date

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.func.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.func.html new file mode 100644 index 0000000..a5767e8 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.func.html @@ -0,0 +1,81 @@ +func | Libraries
+
+ +
+
+
+
+ +

Function func

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.number.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.number.html new file mode 100644 index 0000000..0186e72 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.number.html @@ -0,0 +1,98 @@ +number | Libraries
+
+ +
+
+
+
+ +

Function number

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.object.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.object.html new file mode 100644 index 0000000..d313fe7 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.object.html @@ -0,0 +1,98 @@ +object | Libraries
+
+ +
+
+
+
+ +

Function object

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.string.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.string.html new file mode 100644 index 0000000..1fdeeb3 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.string.html @@ -0,0 +1,98 @@ +string | Libraries
+
+ +
+
+
+
+ +

Function string

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/functions/Schema_Definition_And_Validation.union.html b/docs/v1.1.4/functions/Schema_Definition_And_Validation.union.html new file mode 100644 index 0000000..125bb42 --- /dev/null +++ b/docs/v1.1.4/functions/Schema_Definition_And_Validation.union.html @@ -0,0 +1,91 @@ +union | Libraries
+
+ +
+
+
+
+ +

Function union

+
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/index.html b/docs/v1.1.4/index.html new file mode 100644 index 0000000..9859860 --- /dev/null +++ b/docs/v1.1.4/index.html @@ -0,0 +1,47 @@ +Libraries
+
+ +
+
+
+
+

Libraries

+

This repository contains utility libraries used by Cleverbrush Online Vector Editor.

+

All of these packages are Open-Source and free to use.

+

Libraries are written in TypeScript and distributed as ES6 modules. You can use them with any bundler or transpiler.

+

All libraries are covered with unit tests, if you going to create a pull request, please make sure that your changes are covered with tests and doesn't break existing ones. We use Jest as a test runner.

+

All libraries are located under libs directory. Each library has its own README.md file with detailed description and usage examples. Apart from that there is a documentation website which is generated by TypeDoc. So if you add a new feature or fix a bug, please update the documentation as well, usually it's just a matter of editing JS Doc comments.

+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/modules.html b/docs/v1.1.4/modules.html new file mode 100644 index 0000000..b899066 --- /dev/null +++ b/docs/v1.1.4/modules.html @@ -0,0 +1,51 @@ +Libraries
+
+ +
+
+
+
+

Libraries

+
+
+

Index

+
+

Modules

+
Async utilities +Deep operations on objects +Job Scheduler +Schema Definition And Validation +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/modules/Async_utilities.html b/docs/v1.1.4/modules/Async_utilities.html new file mode 100644 index 0000000..3ce233b --- /dev/null +++ b/docs/v1.1.4/modules/Async_utilities.html @@ -0,0 +1,90 @@ +Async utilities | Libraries
+
+ +
+
+
+
+ +

Module Async utilities

+
+
+ +

Async utilities

+ +

This package contains the set of simple utilities to work with Async abstractions.

+ + +

Installation

+ +
    npm install @cleverbrush/async
+
+ + +

Usage

+ +
import { Collector } from '@cleverbrush/async';
+
+ + +

Classes

+ + + +

Collector

+ +

Takes the list of parameters to collect and waits until all items are collected. Extends EventEmitter. +Constructor supports a second optional parameter to define a timeout ('timeout' event will be emited).

+
type Person = {
    firstName: string;
    lastName: string;
};
const collector = new Collector<Person>(['firstName', 'lastName'], 10000);

collector.on('end', (collectedObject: Person) => {
    console.log(collectedObject);
});

collector.on('timeout', (collectedData: Partial<Person>) => {
    // timeout happened
});

// .........

collector.collect('firstName', 'John');
collector.collect('lastName', 'Smith');
+
+

Another way to use it with Promise approach:

+
const collector = new Collector<Person>(['firstName', 'lastName'], 10000);
const promise = c.toPromise();

c.collect('firstName', 'John').collect('lastName', 'Smith');

try {
    const person: Person = await promise;
} catch (e) {
    // timeout or error occured
}
+
+
+
+
+

Index

+
+

Classes

+
Collector +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/modules/Deep_operations_on_objects.html b/docs/v1.1.4/modules/Deep_operations_on_objects.html new file mode 100644 index 0000000..ecb3e98 --- /dev/null +++ b/docs/v1.1.4/modules/Deep_operations_on_objects.html @@ -0,0 +1,129 @@ +Deep operations on objects | Libraries
+
+ +
+
+
+
+ +

Module Deep operations on objects

+
+
+ +

Deep operations on objects

+ +

This is yet another library which provides operations over JavaScript objects, like deep compare and deep merge.

+ + +

Installation

+ +
npm install @cleverbrush/deep
+
+ + +

Usage

+ +
import deep from '@cleverbrush/deep';
// or import functions individually
import { deepEqual, deepExtend } from '@cleverbrush/deep';
+
+ + +

Functions

+ + + +

deepEqual

+ +

Takes two objects as parameters, compares it recursively and returns true if they are equal or false in other case.

+
import { deepEqual } from '@cleverbrush/deep';

const equal1 = deepEqual({ a: { b: 1 } }, { a: { b: 1 } });
// equal1 === true

const equal2 = deepEqual({ a: { b: 1 } }, { a: { b: 20 } });
// equal2 === false

const equal3 = deepEqual({ a: { b: 1, c: 2 } }, { a: { b: 20 } });
// equal3 === false
+
+ + +

deepExtend

+ +

Works similary to Object.extend, but respects the deep structure of objects.

+
import { deepExtend } from '@cleverbrush/deep';

deepExtend(
    {},
    {
        a: 'something',
        name: {
            first: 'Ivan'
        }
    },
    {
        name: {
            last: 'Ivanov'
        }
    }
);
+
+

will return the following object:

+
    {
        a: 'something',
        name: {
            first: 'Ivan',
            last: 'Ivanov'
        }
    }
+
+ + +

deepFlatten

+ +

Flattens an object to a single level. Accepts an optional separator as a second parameter. +If no separator is provided, the default separator is .. +Supports only objects with string keys. Supports nested objects of any depth. +Throws an error if the object contains circular references.

+
import { deepFlatten } from '@cleverbrush/deep';

deepFlatten({
    a: {
        b: 1,
        c: 2
    },
    d: 3
});

// => { 'a.b': 1, 'a.c': 2, d: 3 }

deepFlatten(
    {
        a: {
            b: 1,
            c: 2
        },
        d: {
            e: {
                f: 3
            }
        }
    },
    '-'
);

// => { 'a-b': 1, 'a-c': 2, 'd-e-f': 3 }
+
+
+
+
+
+ +
+
+

References

+
deepFlatten +
+
+

Type Aliases

+
Merge +
+
+

Variables

+
default +
+
+

Functions

+
deepEqual +deepExtend +
+
+

References

+
+

deepFlatten

Renames and re-exports __type
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/modules/Job_Scheduler.html b/docs/v1.1.4/modules/Job_Scheduler.html new file mode 100644 index 0000000..419766d --- /dev/null +++ b/docs/v1.1.4/modules/Job_Scheduler.html @@ -0,0 +1,89 @@ +Job Scheduler | Libraries
+
+ +
+
+
+
+ +

Module Job Scheduler

+
+
+ +

Task scheduler for NodeJS

+ +

To install the scheduler, run:

+
    npm install @cleverbrush/scheduler
+
+

This library makes use of Node.js worker_threads module to run tasks in parallel. It's tested +on Node.js v16, but should work on older versions as well.

+ + +

An example:

+ +
    import { JobScheduler } from '@cleverbrush/scheduler';

    const scheduler = new JobScheduler({
        rootFolder: '/some/path/to/your/tasks/root/folder'
    });

    scheduler.addJob({
        id: 'my-job-1',
        path: 'path/to/file/under/rootFolder/job1.js',
        schedule: {
            every: 'minute',
            // every 5 minutes
            interval: 5,
            timeout: 1000 * 60 * 4,
            maxRetries: 3
        }
    });

    scheduler.addJob({
        id: 'my-job-2',
        path: 'another/path/to/file/under/rootFolder/job2.js',
        schedule: {
            every: 'week',
            // every second week
            interval: 2,
            // at Monday, Wednesday and Friday
            dayOfWeek: [1, 3, 5],
            // at 9:30 AM (UTC)
            hour: 9,
            minute 30,
            timeout: 1000 * 60 * 4,
            maxRetries: 3
        }
    });

    scheduler.start();
+
+

This will run job1.js and job2.js according to the schedules defined in the code above. +You can subscribe to several events to get notified about the job status:

+
scheduler.on(
    'job:start',
    ({ jobId, instanceId, stdout, stderr, startDate, endDate }) => {
        console.log(`Job ${jobId} started`);
    }
);

// other possible events are 'job:end', 'job:error', 'job:timeout', 'job:message'
// passing the same parameters to callback as above
+
+
+
+
+

Index

+
+

Classes

+
JobScheduler +ScheduleCalculator +
+
+

Type Aliases

+
TaskSchedule +
+
+

Variables

+
Schemas +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/modules/Schema_Definition_And_Validation.html b/docs/v1.1.4/modules/Schema_Definition_And_Validation.html new file mode 100644 index 0000000..c4e16a6 --- /dev/null +++ b/docs/v1.1.4/modules/Schema_Definition_And_Validation.html @@ -0,0 +1,197 @@ +Schema Definition And Validation | Libraries
+
+ +
+
+
+
+ +

Module Schema Definition And Validation

+
+

This package resides in @cleverbrush/schema and contains utilities to define object schemas. Once created a Schema can be used to infer type and validate objects for satisfaction of the Schema.

+

The library is covered with unit-tests to make sure it works correctly.

+ + +

Installation

+ +
    npm install @cleverbrush/schema
+
+ + +

An example:

+ +
import { InferType, object, number, string, date } from '@cleverbrush/schema';

const UserSchema = object({
    id: number(),
    name: string(),
    dateOfBirth: date().optional()
});

// user has { id: number; name: string; dateOfBirth?: Date } type
const user: InferType<typeof UserSchema> = {
    //...
};

const { valid, object: result, errors } = await UserSchema.validate(user);
+
+

Type inference can be used even on clean JavaScript (without TypeScript):

+
const { valid, object, errors } = await UserSchema.validate(someObject);

if (valid) {
    // someObject satisfies UserSchema.
    // And `object` has { id: number; name: string; dateOfBirth: Date; } type.
} else {
    // someObject does not satisfy UserSchema which means that
    // `errors` contains a list of errors.
}
+
+

Another way to have types using just Javascript is to make use of JSDoc:

+
/**
 * @type {import('@cleverbrush/schema').InferType<typeof UserSchema>}
 */
const user = {
    // inferred type is { id: number; name: string; dateOfBirth?: Date }
};
+
+

See Documentation or docs folder for more information.

+ + +

Schema Types

+ +

There are several schema types available out of the box:

+
    +
  • any - any object. Similar to the any type in TypeScript.
    • +
  • string - string value.
    • +
  • number - number value.
    • +
  • boolean - boolean value.
    • +
  • func - function value.
    • +
  • object - object schema (you can define list of properties, along with schemas for every property).
    • +
  • date - defines object of JavaScript Date class.
    • +
  • array - defines array, you can define a schema for Array emelement.
    • +
  • union - allows to define unions. e.g. string | number types (or any combination off schema types from this list).
    • +
  • custom schema types. You just need to inherit SchemaBuilder abstract class to implement your own schema type.
    • +
+ + +

What is exported from the library?

+ +

Library exports several functions used to define schemas:

+
    +
  • any
    • +
  • string
    • +
  • number
    • +
  • boolean
    • +
  • func
    • +
  • object
    • +
  • date
    • +
  • array
    • +
  • union
    • +
+

All these functions returns so called schema builders. +Schema builder classes are also exported (in case if you want to develop your own schema builder based on it):

+
    +
  • AnySchemaBuilder
    • +
  • ArraySchemaBuilder
    • +
  • BooleanSchemaBuilder
    • +
  • DateSchemaBuilder
    • +
  • FunctionSchemaBuilder
    • +
  • ObjectSchemaBuilder
    • +
  • NumberSchemaBuilder
    • +
  • SchemaBuilder - abstract class.
    • +
  • StringSchemaBuilder
    • +
  • UnionSchemaBuilder
    • +
+ + +

Schema Builders Are Immutable

+ +

All schema builders listed above are immutable, which means that every call of it's methods should return a new Schema builder. +For example in the example below call to the .optional() method will not affect UserSchema or any other schemas using it. Instead it will return a new schema builder:

+
const UserSchema = object({
    id: number(),
    email: string()
});

const OrderSchema = object({
    id: number(),
    createdByUser: UserSchema.optional()
});
+
+

By combining immutable schema builders with TypeScript type inference you can create very powerful schemas +which can be used to validate objects and infer their types.

+

Every schema is built using a chain/superposition of calls to the schema builder methods. For example:

+
const UserSchema = object({
    id: number(),
    email: string()
})
    .optional()
    .addProps({
        name: string()
    });
+
+

In the example above UserSchema is an object schema with two properties: id and email. It is also optional and has an additional property name.

+

There is also a way to define union schemas. For example example below defines an array of strings or numbers +having at least two elements, but not more than 5:

+
const StringOrNumberArraySchema = array()
    .minLength(2)
    .maxLength(5)
    .of(union(string()).or(number()));
+
+

You can go further and restrict number to be in the range of 0 to 100 by adding more constraints:

+
const StringOrNumberArraySchema = array()
    .minLength(2)
    .maxLength(5)
    .of(union(string()).or(number().min(0).max(100)));
+
+
+
+
+

Index

+
+

Classes

+
AnySchemaBuilder +ArraySchemaBuilder +BooleanSchemaBuilder +DateSchemaBuilder +FunctionSchemaBuilder +NumberSchemaBuilder +ObjectSchemaBuilder +SchemaBuilder +StringSchemaBuilder +UnionSchemaBuilder +
+
+

Type Aliases

+
InferType +MakeOptional +ValidationError +ValidationResult +
+
+

Functions

+
any +array +boolean +date +func +number +object +string +union +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Deep_operations_on_objects.Merge.html b/docs/v1.1.4/types/Deep_operations_on_objects.Merge.html new file mode 100644 index 0000000..603d87b --- /dev/null +++ b/docs/v1.1.4/types/Deep_operations_on_objects.Merge.html @@ -0,0 +1,60 @@ +Merge | Libraries
+
+ +
+
+
+
+ +

Type alias Merge<T>

+
Merge<T>: T["length"] extends 3 ? MergeTwo<T[0], MergeTwo<T[1], T[2]>> : T["length"] extends 2 ? MergeTwo<T[0], T[1]> : T["length"] extends 1 ? T[0] : T extends [...(infer K), infer PL, infer L] ? Merge<[Merge<[...K]>, MergeTwo<PL, L>]> : never
+
+

Type Parameters

+
    +
  • +

    T extends unknown[]

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Job_Scheduler.TaskSchedule.html b/docs/v1.1.4/types/Job_Scheduler.TaskSchedule.html new file mode 100644 index 0000000..6343ce0 --- /dev/null +++ b/docs/v1.1.4/types/Job_Scheduler.TaskSchedule.html @@ -0,0 +1,67 @@ +TaskSchedule | Libraries
+
+ +
+
+
+
+ +

Type alias TaskSchedule

+
TaskSchedule: InferType<typeof ScheduleSchema>
+

Schedule for job. Can be one of:

+
    +
  • every N minutes
    • +
  • every N days
    • +
  • every N weeks
    • +
  • every N months
    • +
  • every N years
    • +
  • every N days of week
    • +
  • every N months on N day
    • +
  • every N years on N day of N month
    • +
  • every N years on last day of N month
    • +
+
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Schema_Definition_And_Validation.InferType.html b/docs/v1.1.4/types/Schema_Definition_And_Validation.InferType.html new file mode 100644 index 0000000..31e99d4 --- /dev/null +++ b/docs/v1.1.4/types/Schema_Definition_And_Validation.InferType.html @@ -0,0 +1,78 @@ +InferType | Libraries
+
+ +
+
+
+
+ +

Type alias InferType<T>

+
InferType<T>: T extends SchemaBuilder<infer TResult, infer TRequired> ? T extends {
    optimize: ((...args: any[]) => SchemaBuilder<infer TOptimizedType, infer TOptimizedRequired>);
} ? TOptimizedRequired extends true ? TOptimizedType : MakeOptional<TOptimizedType> : TRequired extends true ? TResult : MakeOptional<TResult> : T
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Schema_Definition_And_Validation.MakeOptional.html b/docs/v1.1.4/types/Schema_Definition_And_Validation.MakeOptional.html new file mode 100644 index 0000000..adfe929 --- /dev/null +++ b/docs/v1.1.4/types/Schema_Definition_And_Validation.MakeOptional.html @@ -0,0 +1,78 @@ +MakeOptional | Libraries
+
+ +
+
+
+
+ +

Type alias MakeOptional<T>

+
MakeOptional<T>: {
    prop?: T;
}["prop"]
+
+

Type Parameters

+
    +
  • +

    T

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationError.html b/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationError.html new file mode 100644 index 0000000..be114e2 --- /dev/null +++ b/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationError.html @@ -0,0 +1,80 @@ +ValidationError | Libraries
+
+ +
+
+
+
+ +

Type alias ValidationError

+
ValidationError: {
    message: string;
    path: string;
}
+
+

Type declaration

+
    +
  • +
    message: string
    • +
  • +
    path: string
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationResult.html b/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationResult.html new file mode 100644 index 0000000..e23c7a1 --- /dev/null +++ b/docs/v1.1.4/types/Schema_Definition_And_Validation.ValidationResult.html @@ -0,0 +1,92 @@ +ValidationResult | Libraries
+
+ +
+
+
+
+ +

Type alias ValidationResult<T>

+
ValidationResult<T>: {
    errors?: ValidationError[];
    object?: T;
    valid: boolean;
}
+
+

Type Parameters

+
    +
  • +

    T

+
+

Type declaration

+
    +
  • +
    Optional errors?: ValidationError[]
    • +
  • +
    Optional object?: T
    +

    Contains validated object. Can be different (if there are any preprocessors in the schema) from object +passed to the validate method of the SchemaBuilder class.

    +
    • +
  • +
    valid: boolean
    +

    If true - object satisfies schema

    +
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/variables/Deep_operations_on_objects.default.html b/docs/v1.1.4/variables/Deep_operations_on_objects.default.html new file mode 100644 index 0000000..b8205d8 --- /dev/null +++ b/docs/v1.1.4/variables/Deep_operations_on_objects.default.html @@ -0,0 +1,132 @@ +default | Libraries
+
+ +
+
+
+
+ +

Variable default

+
default: {
    deepEqual: ((p1: any, p2: any, options?: {
        disregardArrayOrder?: boolean;
    }) => boolean);
    deepExtend: (<T>(...args: T) => Merge<T>);
    deepFlatten: ((obj: Record<string, any>, delimiter??: string) => Record<string, any>);
}
+
+

Type declaration

+
    +
  • +
    deepEqual: ((p1: any, p2: any, options?: {
        disregardArrayOrder?: boolean;
    }) => boolean)
    +
      +
    • +
        +
      • (p1: any, p2: any, options?: {
            disregardArrayOrder?: boolean;
        }): boolean
        • +
      • +

        Compares two objects and returns true if they +have the same structure and values. Can work +with arrays and objects, nested objects, +recursive objects, dates, etc.

        + +

        Returns

        true if the objects are equal, false otherwise

        +
        +
        +

        Parameters

        +
          +
        • +
          p1: any
          +

          first object

          +
          • +
        • +
          p2: any
          +

          second object

          +
          • +
        • +
          Optional options: {
              disregardArrayOrder?: boolean;
          }
          +

          additional options

          +
          +
            +
          • +
            Optional disregardArrayOrder?: boolean
            +

            if true, the order of the elements in the array will be disregarded +e.g. [1, 2] and [2, 1] will be considered equal

            +
        +

        Returns boolean

    • +
  • +
    deepExtend: (<T>(...args: T) => Merge<T>)
    +
      +
    • +
        +
      • <T>(...args: T): Merge<T>
        • +
      • +
        +

        Type Parameters

        +
          +
        • +

          T extends unknown[]

        +
        +

        Parameters

        +
          +
        • +
          Rest ...args: T
        +

        Returns Merge<T>

    • +
  • +
    deepFlatten: ((obj: Record<string, any>, delimiter??: string) => Record<string, any>)
    +
      +
    • +
        +
      • (obj: Record<string, any>, delimiter??: string): Record<string, any>
        • +
      • +

        Flattens an object to a single level, with the nested keys separated by a delimiter.

        + +

        Example

        deepFlatten({ a: { b: 1, c: 2 } });
        // => { 'a.b': 1, 'a.c': 2 }

        deepFlatten({ a: { b: 1, c: 2 } }, '/');
        // => { 'a/b': 1, 'a/c': 2 }

        deepFlatten({ a: { b: 1, c: { d: 'some val' } }, d: 3 });
        // => { 'a.b': 1, 'a.c.d': 'some val', d: 3 }
        
+
        +
        +
        +

        Parameters

        +
          +
        • +
          obj: Record<string, any>
          • +
        • +
          Optional delimiter: string = '.'
        +

        Returns Record<string, any>

+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/docs/v1.1.4/variables/Job_Scheduler.Schemas.html b/docs/v1.1.4/variables/Job_Scheduler.Schemas.html new file mode 100644 index 0000000..7a0b53e --- /dev/null +++ b/docs/v1.1.4/variables/Job_Scheduler.Schemas.html @@ -0,0 +1,73 @@ +Schemas | Libraries
+
+ +
+
+
+
+ +

Variable SchemasConst

+
Schemas: {
    CreateJobRequestSchema: ObjectSchemaBuilder<{
        id: StringSchemaBuilder<string, true>;
        maxConsequentFails: NumberSchemaBuilder<number, false>;
        maxRetries: NumberSchemaBuilder<number, false>;
        path: StringSchemaBuilder<string, true>;
        props: UnionSchemaBuilder<[ObjectSchemaBuilder<{}, true, undefined>, FunctionSchemaBuilder<true, undefined, ((...args: any[]) => any)>], false, undefined>;
        schedule: UnionSchemaBuilder<[ObjectSchemaBuilder<Omit<Omit<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        }, "hour">, "minute"> & {
            every: StringSchemaBuilder<"minute", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            every: StringSchemaBuilder<"day", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
            every: StringSchemaBuilder<"week", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
            every: StringSchemaBuilder<"month", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
            every: StringSchemaBuilder<"year", true>;
            month: NumberSchemaBuilder<number, true>;
        }, true, undefined>], true, undefined>;
        timeout: NumberSchemaBuilder<number, false>;
    }, true, undefined>;
    ScheduleDaySchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        every: StringSchemaBuilder<"day", true>;
    }, true, undefined>;
    ScheduleMinuteSchema: ObjectSchemaBuilder<Omit<Omit<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, "hour">, "minute"> & {
        every: StringSchemaBuilder<"minute", true>;
    }, true, undefined>;
    ScheduleMonthSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"month", true>;
    }, true, undefined>;
    ScheduleSchema: UnionSchemaBuilder<[ObjectSchemaBuilder<Omit<Omit<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, "hour">, "minute"> & {
        every: StringSchemaBuilder<"minute", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        every: StringSchemaBuilder<"day", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
        every: StringSchemaBuilder<"week", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"month", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"year", true>;
        month: NumberSchemaBuilder<number, true>;
    }, true, undefined>], true, undefined>;
    ScheduleSchemaBase: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, true, undefined>;
    ScheduleWeekSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
        every: StringSchemaBuilder<"week", true>;
    }, true, undefined>;
    ScheduleYearSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"year", true>;
        month: NumberSchemaBuilder<number, true>;
    }, true, undefined>;
} = ...
+
+

Type declaration

+
    +
  • +
    CreateJobRequestSchema: ObjectSchemaBuilder<{
        id: StringSchemaBuilder<string, true>;
        maxConsequentFails: NumberSchemaBuilder<number, false>;
        maxRetries: NumberSchemaBuilder<number, false>;
        path: StringSchemaBuilder<string, true>;
        props: UnionSchemaBuilder<[ObjectSchemaBuilder<{}, true, undefined>, FunctionSchemaBuilder<true, undefined, ((...args: any[]) => any)>], false, undefined>;
        schedule: UnionSchemaBuilder<[ObjectSchemaBuilder<Omit<Omit<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        }, "hour">, "minute"> & {
            every: StringSchemaBuilder<"minute", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            every: StringSchemaBuilder<"day", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
            every: StringSchemaBuilder<"week", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
            every: StringSchemaBuilder<"month", true>;
        }, true, undefined>, ObjectSchemaBuilder<{
            endsOn: DateSchemaBuilder<Date, false>;
            hour: NumberSchemaBuilder<number, false>;
            interval: NumberSchemaBuilder<number, true>;
            maxOccurences: NumberSchemaBuilder<number, false>;
            minute: NumberSchemaBuilder<number, false>;
            skipFirst: NumberSchemaBuilder<number, false>;
            startsOn: DateSchemaBuilder<Date, false>;
        } & {
            day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
            every: StringSchemaBuilder<"year", true>;
            month: NumberSchemaBuilder<number, true>;
        }, true, undefined>], true, undefined>;
        timeout: NumberSchemaBuilder<number, false>;
    }, true, undefined>
    • +
  • +
    ScheduleDaySchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        every: StringSchemaBuilder<"day", true>;
    }, true, undefined>
    • +
  • +
    ScheduleMinuteSchema: ObjectSchemaBuilder<Omit<Omit<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, "hour">, "minute"> & {
        every: StringSchemaBuilder<"minute", true>;
    }, true, undefined>
    • +
  • +
    ScheduleMonthSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"month", true>;
    }, true, undefined>
    • +
  • +
    ScheduleSchema: UnionSchemaBuilder<[ObjectSchemaBuilder<Omit<Omit<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, "hour">, "minute"> & {
        every: StringSchemaBuilder<"minute", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        every: StringSchemaBuilder<"day", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
        every: StringSchemaBuilder<"week", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"month", true>;
    }, true, undefined>, ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"year", true>;
        month: NumberSchemaBuilder<number, true>;
    }, true, undefined>], true, undefined>
    • +
  • +
    ScheduleSchemaBase: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    }, true, undefined>
    • +
  • +
    ScheduleWeekSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        dayOfWeek: ArraySchemaBuilder<NumberSchemaBuilder<number, true>, true, undefined, number[]>;
        every: StringSchemaBuilder<"week", true>;
    }, true, undefined>
    • +
  • +
    ScheduleYearSchema: ObjectSchemaBuilder<{
        endsOn: DateSchemaBuilder<Date, false>;
        hour: NumberSchemaBuilder<number, false>;
        interval: NumberSchemaBuilder<number, true>;
        maxOccurences: NumberSchemaBuilder<number, false>;
        minute: NumberSchemaBuilder<number, false>;
        skipFirst: NumberSchemaBuilder<number, false>;
        startsOn: DateSchemaBuilder<Date, false>;
    } & {
        day: UnionSchemaBuilder<[StringSchemaBuilder<"last", true>, NumberSchemaBuilder<number, true>], true, undefined>;
        every: StringSchemaBuilder<"year", true>;
        month: NumberSchemaBuilder<number, true>;
    }, true, undefined>
+
+
+
+

Settings

 +
+
+

Member Visibility

+
    +
    • +
    • +
+
+

Theme

+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file