${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass ArrayParser<T>
Type Parameters
- T
Implements
Constructors
constructor
- new ArrayParser<T>(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<T[]>,
negate?: boolean,
): ArrayParser<T>Type Parameters
- T
Parameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<T[]>
- negate: boolean = false
Returns ArrayParser<T>
Accessors
not
Returns ArrayParser<T>
Methods
Readonlyeach
Readonlymax
Parameters
- maxValue: number
- exclusive: boolean = false
Returns ArrayParser<T>
Readonlymin
Parameters
- minValue: number
- exclusive: boolean = false
Returns ArrayParser<T>
Readonlyof
Type Parameters
- U
Returns ArrayParser<U>
Readonlyunique
Class BooleanParser
Fluent builder for parsing booleans
+Implements
Index
Constructors
constructor
- new BooleanParser(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<boolean>,
negate?: boolean,
): BooleanParserParameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<boolean>
- negate: boolean = false
Returns BooleanParser
Accessors
not
Returns BooleanParser
Methods
Readonlyequals
Parameters
- equalToValue: boolean
Returns BooleanParser
Class ComplexParser<T>
A parser
+Type Parameters
- T
Implements
Index
Constructors
constructor
- new ComplexParser<T>(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<T>,
negate?: boolean,
): ComplexParser<T>Type Parameters
- T
Parameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<T>
- negate: boolean = false
Returns ComplexParser<T>
Accessors
not
Returns ComplexParser<T>
Methods
Readonlyequals
Parameters
- equalToValue: T
Returns ComplexParser<T>
Class DateParser
Fluent builder for parsing dates
+Implements
Index
Constructors
constructor
- new DateParser(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<Date>,
negate?: boolean,
): DateParserParameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<Date>
- negate: boolean = false
Returns DateParser
Accessors
not
Returns DateParser
Methods
Readonlyany
Parameters
- values: DateParsableTypes[]
Returns DateParser
Readonlyequals
Parameters
- value: DateParsableTypes
Returns DateParser
Readonlymax
Parameters
- value: DateParsableTypes
- exclusive: boolean = false
Returns DateParser
Readonlymin
Parameters
- value: DateParsableTypes
- exclusive: boolean = false
Returns DateParser
Class DictionaryParser<T>
A parser
+Type Parameters
- T
Implements
Constructors
constructor
- new DictionaryParser<T>(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<Dictionary<T>>,
negate?: boolean,
): DictionaryParser<T>Type Parameters
- T
Parameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<Dictionary<T>>
- negate: boolean = false
Returns DictionaryParser<T>
Accessors
not
Returns DictionaryParser<T>
Methods
Readonlyeach
Readonlymax
Parameters
- maxValue: number
- exclusive: boolean = false
Returns DictionaryParser<T>
Readonlymin
Parameters
- minValue: number
- exclusive: boolean = false
Returns DictionaryParser<T>
Readonlyof
Type Parameters
- U
Returns DictionaryParser<U>
Class FloatParser
Fluent builder for parsing floats
+Implements
Constructors
constructor
- new FloatParser(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<number>,
negate?: boolean,
): FloatParserParameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<number>
- negate: boolean = false
Returns FloatParser
Accessors
not
Returns FloatParser
Methods
Readonlyany
Parameters
- values: NumberParsableTypes[]
Returns FloatParser
Readonlyequals
Parameters
- value: NumberParsableTypes
Returns FloatParser
Readonlymax
Parameters
- value: NumberParsableTypes
- exclusive: boolean = false
Returns FloatParser
Readonlymin
Parameters
- value: NumberParsableTypes
- exclusive: boolean = false
Returns FloatParser
Class IntParser
Fluent builder for parsing ints
+Implements
Constructors
constructor
- new IntParser(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<number>,
radix?: number,
negate?: boolean,
): IntParserParameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<number>
- radix: number = undefined
- negate: boolean = false
Returns IntParser
Methods
Readonlyany
Parameters
- values: NumberEnumMap | NumberParsableTypes[]
Returns IntParser
Readonlyequals
Parameters
- value: NumberParsableTypes
Returns IntParser
Readonlymax
Parameters
- value: NumberParsableTypes
- exclusive: boolean = false
Returns IntParser
Readonlymin
Parameters
- value: NumberParsableTypes
- exclusive: boolean = false
Returns IntParser
Readonlywith
Parameters
Optionalvalue: number
Returns IntParser
Class Is
Starting point for a new parsing and validating
+Class JsonParser<T>
A parser
+Type Parameters
- T
Implements
Index
Constructors
constructor
- new JsonParser<T>(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<T>,
negate?: boolean,
): JsonParser<T>Type Parameters
- T
Parameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<T>
- negate: boolean = false
Returns JsonParser<T>
Class ParseErrors
Creates error objects
+Constructors
constructor
Returns ParseErrors
Properties
Static Readonlyarray
array: { array: boolean } = ...
value should be an array
+Static Readonlyboolean
boolean: { boolean: boolean } = ...
value should be a boolean
+Static Readonlycomplex
complex: { object: boolean } = ...
value should be a complex object
+Static Readonlydate
date: { date: boolean } = ...
value should be a date
+Static Readonlydictionary
dictionary: { dictionary: boolean } = ...
value should be a array
+Static Readonlyempty
empty: {} = {}
not an error
+Static Readonlyfloat
float: { float: boolean } = ...
value should be a float
+Static Readonlyint
int: { int: boolean } = ...
value should be an int
+Static Readonlyjson
json: { json: boolean } = ...
value should be a json
+Static Readonlyrequired
required: { required: boolean } = ...
required
+Static Readonlystring
string: { string: boolean } = ...
value should be a string
+Static Readonlyunique
unique: { unique: boolean } = ...
values unique
+Methods
Static Readonlyany
- anyOf<T>(
values: NumberEnumMap | T[],
ignoreCase?: boolean,
): { anyOf: { ignoreCase: boolean; value: (string | number)[] | T[] } }value should be equal to any of the values, ignoreCase only valid for string
+Type Parameters
- T
Parameters
- values: NumberEnumMap | T[]
OptionalignoreCase: boolean
Returns { anyOf: { ignoreCase: boolean; value: (string | number)[] | T[] } }
Static Readonlyends
Static Readonlyequals
Static Readonlyincludes
Static Readonlymatches
Static Readonlymax
Static Readonlymax
Static Readonlymin
Static Readonlymin
Static Readonlynot
Static Readonlystarts
Class RootParser
A parser
+Implements
Constructors
constructor
Parameters
- parseCurrent: ICurrentParser<unknown>
- negate: boolean = false
Returns RootParser
Properties
Readonlyarray
Readonlyboolean
Readonlydate
Readonlydictionary
Readonlyfloat
Readonlyint
Readonlyjson
Readonlyparse
Readonlystring
Accessors
not
Returns RootParser
required
Returns RootParser
Class StringParser
Fluent builder for parsing strings
+Implements
Constructors
constructor
- new StringParser(
parent: IParser<unknown>,
parseCurrent: ICurrentParser<string>,
negate?: boolean,
): StringParserParameters
- parent: IParser<unknown>
- parseCurrent: ICurrentParser<string>
- negate: boolean = false
Returns StringParser
Accessors
not
Returns StringParser
Methods
Readonlyany
Parameters
- values: string[]
- ignoreCase: boolean = false
Returns StringParser
Readonlyends
Parameters
- value: string
- ignoreCase: boolean = false
Returns StringParser
Readonlyequals
Parameters
- value: string
- ignoreCase: boolean = false
Returns StringParser
Readonlyincludes
Parameters
- value: string
- ignoreCase: boolean = false
Returns StringParser
Readonlymatches
Parameters
- value: string | RegExp
- name: string = null
Returns StringParser
Readonlymax
Parameters
- value: number
- exclusive: boolean = false
Returns StringParser
Readonlymin
Parameters
- value: number
- exclusive: boolean = false
Returns StringParser
Readonlystarts
Parameters
- value: string
- ignoreCase: boolean = false
Returns StringParser
Function asCurrent
Creates a wrap around a parse function
+Allows the result to be negated. +The parse function should return errors for every result +to allow negation
+Type Parameters
- T
Parameters
- parse: (value: unknown) => IParseResult<T>
parse function that is negatable
+ - negate: boolean = false
negate the result
+
Returns ICurrentParser<T>
a current parser
+
Function createParseResult
creates a normalised parse result
+Type Parameters
- T
Parameters
- value: T
parsed value
+ - errors: IParseErrors = ParseErrors.empty
errors, success is true if empty
+
Returns IParseResult<T>
Function ensureDateArray
Parameters
- values: DateParsableTypes[]
Returns Date[]
Function ensureNumberArray
get values array if not already
+Parameters
- valuesOrEnum: NumberEnumMap | NumberParsableTypes[]
Returns (string | number)[]
Function getNumberEnumValues
diff --git a/docs/functions/isDate.html b/docs/functions/isDate.html
new file mode 100644
index 0000000..9d61738
--- /dev/null
+++ b/docs/functions/isDate.html
@@ -0,0 +1,2 @@
+
Function isDate
diff --git a/docs/functions/isEqual.html b/docs/functions/isEqual.html
new file mode 100644
index 0000000..0841b19
--- /dev/null
+++ b/docs/functions/isEqual.html
@@ -0,0 +1,3 @@
+
diff --git a/docs/functions/isFloat.html b/docs/functions/isFloat.html
new file mode 100644
index 0000000..d0d84b6
--- /dev/null
+++ b/docs/functions/isFloat.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/isInt.html b/docs/functions/isInt.html
new file mode 100644
index 0000000..8b7ad54
--- /dev/null
+++ b/docs/functions/isInt.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/isNullOrEmpty.html b/docs/functions/isNullOrEmpty.html
new file mode 100644
index 0000000..25f1486
--- /dev/null
+++ b/docs/functions/isNullOrEmpty.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/isNumberType.html b/docs/functions/isNumberType.html
new file mode 100644
index 0000000..f7bb28d
--- /dev/null
+++ b/docs/functions/isNumberType.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/isStringType.html b/docs/functions/isStringType.html
new file mode 100644
index 0000000..a32fb46
--- /dev/null
+++ b/docs/functions/isStringType.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/parseCast.html b/docs/functions/parseCast.html
new file mode 100644
index 0000000..5abcea0
--- /dev/null
+++ b/docs/functions/parseCast.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/parseChain.html b/docs/functions/parseChain.html
new file mode 100644
index 0000000..3cfa4e6
--- /dev/null
+++ b/docs/functions/parseChain.html
@@ -0,0 +1,6 @@
+
Function parseChain
- parseChain<T>(
parent: IParser<unknown>,
current: ICurrentParser<T>,
_parserName: string,
): IParse<T>Gets a chained, parent and current parser
+Type Parameters
- T
Parameters
- parent: IParser<unknown>
parent parser
+ - current: ICurrentParser<T>
current parser
+ - _parserName: string
name for debugging
+
Returns IParse<T>
a chained parse function
+
Function parseDate
Parse a date, throw if not a date
+Parameters
- value: DateParsableTypes
to be parsed
+
Returns Date
a date or null
+- value: DateParsableTypes
Function parseFloat
Parameters
- value: NumberParsableTypes
Returns number
Function parseInt
Parse the value passed
+Parameters
- value: NumberParsableTypes
a parsable number type
+ - radix: number = 10
base (2-36) defaults to 10 for decimal
+
Returns number
number or throws if not
+- value: NumberParsableTypes
diff --git a/docs/functions/provideAnyOfString.html b/docs/functions/provideAnyOfString.html
new file mode 100644
index 0000000..2994077
--- /dev/null
+++ b/docs/functions/provideAnyOfString.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/functions/provideDictionaryValues.html b/docs/functions/provideDictionaryValues.html
new file mode 100644
index 0000000..99c3bbb
--- /dev/null
+++ b/docs/functions/provideDictionaryValues.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/provideEndsWithString.html b/docs/functions/provideEndsWithString.html
new file mode 100644
index 0000000..ba1c41d
--- /dev/null
+++ b/docs/functions/provideEndsWithString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideEquals.html b/docs/functions/provideEquals.html
new file mode 100644
index 0000000..8ec98e2
--- /dev/null
+++ b/docs/functions/provideEquals.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideEqualsString.html b/docs/functions/provideEqualsString.html
new file mode 100644
index 0000000..74d03fd
--- /dev/null
+++ b/docs/functions/provideEqualsString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideIncludesString.html b/docs/functions/provideIncludesString.html
new file mode 100644
index 0000000..9679b29
--- /dev/null
+++ b/docs/functions/provideIncludesString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideMatchesString.html b/docs/functions/provideMatchesString.html
new file mode 100644
index 0000000..9e048b7
--- /dev/null
+++ b/docs/functions/provideMatchesString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideMax.html b/docs/functions/provideMax.html
new file mode 100644
index 0000000..b50ef3b
--- /dev/null
+++ b/docs/functions/provideMax.html
@@ -0,0 +1,2 @@
+
Function provideMax
Validate a value is a maximum
+Type Parameters
- T extends RelationalValidatorTypes
Parameters
- maxValue: T
- exclusive: boolean
Returns IParse<T>
Function provideMaxLength
Function provideMin
Validate a value is a minimum
+Type Parameters
- T extends RelationalValidatorTypes
Parameters
- minValue: T
- exclusive: boolean
Returns IParse<T>
Function provideMinLength
diff --git a/docs/functions/provideParseArrayValues.html b/docs/functions/provideParseArrayValues.html
new file mode 100644
index 0000000..6de2aa6
--- /dev/null
+++ b/docs/functions/provideParseArrayValues.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/provideParseBoolean.html b/docs/functions/provideParseBoolean.html
new file mode 100644
index 0000000..3229202
--- /dev/null
+++ b/docs/functions/provideParseBoolean.html
@@ -0,0 +1 @@
+
Function provideParseComplex
provides a parse method for object typed as T
+Type Parameters
- T
Parameters
- schema: ComplexSchema<T>
a complex schema
+
Returns IParse<T>
parser
+
diff --git a/docs/functions/provideParseDictionary.html b/docs/functions/provideParseDictionary.html
new file mode 100644
index 0000000..2a4fdeb
--- /dev/null
+++ b/docs/functions/provideParseDictionary.html
@@ -0,0 +1 @@
+
Function provideParseDictionary
Type Parameters
- T
Returns IParse<Dictionary<T>>
diff --git a/docs/functions/provideParseFloat.html b/docs/functions/provideParseFloat.html
new file mode 100644
index 0000000..bfd8c78
--- /dev/null
+++ b/docs/functions/provideParseFloat.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/provideParseInt.html b/docs/functions/provideParseInt.html
new file mode 100644
index 0000000..ec12527
--- /dev/null
+++ b/docs/functions/provideParseInt.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/provideParseJson.html b/docs/functions/provideParseJson.html
new file mode 100644
index 0000000..a940159
--- /dev/null
+++ b/docs/functions/provideParseJson.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideParseString.html b/docs/functions/provideParseString.html
new file mode 100644
index 0000000..e273215
--- /dev/null
+++ b/docs/functions/provideParseString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/provideStartsWithString.html b/docs/functions/provideStartsWithString.html
new file mode 100644
index 0000000..5d5f6bd
--- /dev/null
+++ b/docs/functions/provideStartsWithString.html
@@ -0,0 +1 @@
+
diff --git a/docs/functions/tryParseBoolean.html b/docs/functions/tryParseBoolean.html
new file mode 100644
index 0000000..f491cdd
--- /dev/null
+++ b/docs/functions/tryParseBoolean.html
@@ -0,0 +1,4 @@
+
diff --git a/docs/functions/tryParseDate.html b/docs/functions/tryParseDate.html
new file mode 100644
index 0000000..562d7f2
--- /dev/null
+++ b/docs/functions/tryParseDate.html
@@ -0,0 +1,4 @@
+
Function tryParseDate
Attempt to parse a value to a date
+Parameters
- value: DateParsableTypes
to be parsed
+
Returns Date
a date or null
+- value: DateParsableTypes
Function tryParseFloat
Parameters
- value: NumberParsableTypes
Returns number
Function tryParseInt
Attempt to parse an integer value
+Parameters
- value: NumberParsableTypes
value
+ Optionalradix: number = undefinedwill default to 10
+
Returns number
number or null
+- value: NumberParsableTypes
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
new file mode 100644
index 0000000..3a0bfd6
--- /dev/null
+++ b/docs/hierarchy.html
@@ -0,0 +1 @@
+
diff --git a/docs/index.html b/docs/index.html
index 18a772a..2ac5f54 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -1,16 +1,8 @@
-
-
-
-
-
-
-
Temp
- - - \ No newline at end of file +@ntix/parsing
+
+
For examples see the tests
+this is a good start /src/parsing/required.spec.ts
diff --git a/docs/interfaces/IArray.Parser.html b/docs/interfaces/IArray.Parser.html
new file mode 100644
index 0000000..9a04074
--- /dev/null
+++ b/docs/interfaces/IArray.Parser.html
@@ -0,0 +1,14 @@
+
Interface Parser<T>
A parser
+interface Parser<T = unknown> {
each: <U = T>(
parser: IParser<U>,
) => NextBuilder<IArray.Parser<U>, "each" | "of">;
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "maxLength" | "of" | "each">;
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "minLength" | "of" | "each">;
not: NextBuilder<IArray.Parser<T>, "not" | "parse">;
of: <U = T>() => NextBuilder<IArray.Parser<U>, "of" | "each">;
parse: IParse<T[]>;
unique: <U = T>(
distinctor: (item: U) => unknown,
) => NextBuilder<IArray.Parser<U>, "unique" | "of" | "each">;
}
each: <U = T>(
parser: IParser<U>,
) => NextBuilder<IArray.Parser<U>, "each" | "of">;
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "maxLength" | "of" | "each">;
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "minLength" | "of" | "each">;
not: NextBuilder<IArray.Parser<T>, "not" | "parse">;
of: <U = T>() => NextBuilder<IArray.Parser<U>, "of" | "each">;
parse: IParse<T[]>;
unique: <U = T>(
distinctor: (item: U) => unknown,
) => NextBuilder<IArray.Parser<U>, "unique" | "of" | "each">;
}
Type Parameters
- T = unknown
Hierarchy (View Summary)
Implemented by
Properties
Readonlyeach
parse each item with a parser
+Readonlymax
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "maxLength" | "of" | "each">
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "maxLength" | "of" | "each">
maximum length of the array
+Readonlymin
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "minLength" | "of" | "each">
value: number,
exclusive?: boolean,
) => NextBuilder<IArray.Parser<T>, "minLength" | "of" | "each">
minimum length of the array
+Readonlynot
Readonlyof
declare the type of each item
+parse
Readonlyunique
unique: <U = T>(
distinctor: (item: U) => unknown,
) => NextBuilder<IArray.Parser<U>, "unique" | "of" | "each">
distinctor: (item: U) => unknown,
) => NextBuilder<IArray.Parser<U>, "unique" | "of" | "each">
check for uniqueness by a given distintor
+Interface Parser
A parser
+interface Parser {
not: NextBuilder<IBoolean.Parser, "not" | "parse">;
parse: IParse<boolean>;
equals(
value: boolean,
): NextBuilder<IBoolean.Parser, "equals", "parse" | "not">;
}
not: NextBuilder<IBoolean.Parser, "not" | "parse">;
parse: IParse<boolean>;
equals(
value: boolean,
): NextBuilder<IBoolean.Parser, "equals", "parse" | "not">;
}
Hierarchy (View Summary)
- IParser<boolean>
- Parser
Implemented by
Methods
equals
Parameters
- value: boolean
Returns NextBuilder<IBoolean.Parser, "equals", "parse" | "not">
Interface Parser<T>
A parser
+interface Parser<T = unknown> {
not: NextBuilder<IComplex.Parser<T>, "not" | "parse">;
parse: IParse<T>;
equals(
value: T,
): NextBuilder<IComplex.Parser<T>, "equals", "parse" | "not">;
}
not: NextBuilder<IComplex.Parser<T>, "not" | "parse">;
parse: IParse<T>;
equals(
value: T,
): NextBuilder<IComplex.Parser<T>, "equals", "parse" | "not">;
}
Type Parameters
- T = unknown
Hierarchy (View Summary)
Implemented by
Methods
equals
Parameters
- value: T
Returns NextBuilder<IComplex.Parser<T>, "equals", "parse" | "not">
Interface ICurrentParser<T>
A parser function and negate value
+The parse function should return a negatable (non-normal) result +ie, it should return errors on success and failure to parse +so the result can be negated
+Type Parameters
- T
Hierarchy (View Summary)
Interface Parser
A parser
+interface Parser {
not: NextBuilder<IDate.Parser, "not" | "parse">;
parse: IParse<Date>;
anyOf(
values: DateParsableTypes[],
): NextBuilder<IDate.Parser, "anyOf", "not" | "parse">;
equals(
value: DateParsableTypes,
): NextBuilder<IDate.Parser, "equals", "not" | "parse">;
max(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "max", "not" | "parse">;
min(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "min", "not" | "parse">;
}
not: NextBuilder<IDate.Parser, "not" | "parse">;
parse: IParse<Date>;
anyOf(
values: DateParsableTypes[],
): NextBuilder<IDate.Parser, "anyOf", "not" | "parse">;
equals(
value: DateParsableTypes,
): NextBuilder<IDate.Parser, "equals", "not" | "parse">;
max(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "max", "not" | "parse">;
min(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "min", "not" | "parse">;
}
Hierarchy (View Summary)
- IParser<Date>
- Parser
Implemented by
Methods
any
Parameters
- values: DateParsableTypes[]
Returns NextBuilder<IDate.Parser, "anyOf", "not" | "parse">
equals
Parameters
- value: DateParsableTypes
Returns NextBuilder<IDate.Parser, "equals", "not" | "parse">
max
- max(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "max", "not" | "parse">Parameters
- value: DateParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IDate.Parser, "max", "not" | "parse">
min
- min(
value: DateParsableTypes,
exclusive?: boolean,
): NextBuilder<IDate.Parser, "min", "not" | "parse">Parameters
- value: DateParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IDate.Parser, "min", "not" | "parse">
Interface Parser<T>
A parser
+interface Parser<T = unknown> {
each: <U = T>(
parser: IParser<U>,
) => NextBuilder<IDictionary.Parser<U>, "of" | "each">;
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "maxLength",
"not" | "parse",
>;
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "minLength",
"not" | "parse",
>;
not: NextBuilder<IDictionary.Parser<T>, "of" | "each" | "not">;
of: <U>() => NextBuilder<IDictionary.Parser<U>, "of" | "each">;
parse: IParse<Dictionary<T>>;
}
each: <U = T>(
parser: IParser<U>,
) => NextBuilder<IDictionary.Parser<U>, "of" | "each">;
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "maxLength",
"not" | "parse",
>;
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "minLength",
"not" | "parse",
>;
not: NextBuilder<IDictionary.Parser<T>, "of" | "each" | "not">;
of: <U>() => NextBuilder<IDictionary.Parser<U>, "of" | "each">;
parse: IParse<Dictionary<T>>;
}
Type Parameters
- T = unknown
Hierarchy (View Summary)
- IParser<Dictionary<T>>
- Parser
Implemented by
Properties
Readonlyeach
parse each item with a parser
+Readonlymax
maxLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "maxLength",
"not" | "parse",
>
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "maxLength",
"not" | "parse",
>
maximum length of the array
+Readonlymin
minLength: (
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "minLength",
"not" | "parse",
>
value: number,
exclusive?: boolean,
) => NextBuilder<
IDictionary.Parser<T>,
"of" | "each" | "minLength",
"not" | "parse",
>
minimum length of the array
+Readonlynot
Readonlyof
declare the type of each item
+parse
Interface Parser
A parser
+interface Parser {
not: NextBuilder<IFloat.Parser, "not" | "parse">;
parse: IParse<number>;
anyOf(
values: NumberParsableTypes[],
): NextBuilder<IFloat.Parser, "anyOf", "not" | "parse">;
equals(
value: NumberParsableTypes,
): NextBuilder<IFloat.Parser, "equals", "not" | "parse">;
max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "max", "not" | "parse">;
min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "min", "not" | "parse">;
}
not: NextBuilder<IFloat.Parser, "not" | "parse">;
parse: IParse<number>;
anyOf(
values: NumberParsableTypes[],
): NextBuilder<IFloat.Parser, "anyOf", "not" | "parse">;
equals(
value: NumberParsableTypes,
): NextBuilder<IFloat.Parser, "equals", "not" | "parse">;
max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "max", "not" | "parse">;
min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "min", "not" | "parse">;
}
Hierarchy (View Summary)
- IParser<number>
- Parser
Implemented by
Methods
any
Parameters
- values: NumberParsableTypes[]
Returns NextBuilder<IFloat.Parser, "anyOf", "not" | "parse">
equals
Parameters
- value: NumberParsableTypes
Returns NextBuilder<IFloat.Parser, "equals", "not" | "parse">
max
- max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "max", "not" | "parse">Parameters
- value: NumberParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IFloat.Parser, "max", "not" | "parse">
min
- min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IFloat.Parser, "min", "not" | "parse">Parameters
- value: NumberParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IFloat.Parser, "min", "not" | "parse">
diff --git a/docs/interfaces/IInt.Parser.html b/docs/interfaces/IInt.Parser.html
new file mode 100644
index 0000000..a3717ed
--- /dev/null
+++ b/docs/interfaces/IInt.Parser.html
@@ -0,0 +1,9 @@
+
Interface Parser
A parser
+interface Parser {
not: NextBuilder<IInt.Parser, "not" | "parse">;
parse: IParse<number>;
withRadix: (
value?: number,
) => NextBuilder<IInt.Parser, "withRadix", "parse">;
anyOf(
values: NumberEnumMap | NumberParsableTypes[],
): NextBuilder<IInt.Parser, "anyOf", "not" | "parse">;
equals(
value: NumberParsableTypes,
): NextBuilder<IInt.Parser, "equals", "not" | "parse">;
max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "max", "not" | "parse">;
min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "min", "not" | "parse">;
}
not: NextBuilder<IInt.Parser, "not" | "parse">;
parse: IParse<number>;
withRadix: (
value?: number,
) => NextBuilder<IInt.Parser, "withRadix", "parse">;
anyOf(
values: NumberEnumMap | NumberParsableTypes[],
): NextBuilder<IInt.Parser, "anyOf", "not" | "parse">;
equals(
value: NumberParsableTypes,
): NextBuilder<IInt.Parser, "equals", "not" | "parse">;
max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "max", "not" | "parse">;
min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "min", "not" | "parse">;
}
Hierarchy (View Summary)
- IParser<number>
- Parser
Implemented by
Methods
any
- anyOf(
values: NumberEnumMap | NumberParsableTypes[],
): NextBuilder<IInt.Parser, "anyOf", "not" | "parse">Parameters
- values: NumberEnumMap | NumberParsableTypes[]
Returns NextBuilder<IInt.Parser, "anyOf", "not" | "parse">
equals
Parameters
- value: NumberParsableTypes
Returns NextBuilder<IInt.Parser, "equals", "not" | "parse">
max
- max(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "max", "not" | "parse">Parameters
- value: NumberParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IInt.Parser, "max", "not" | "parse">
min
- min(
value: NumberParsableTypes,
exclusive?: boolean,
): NextBuilder<IInt.Parser, "min", "not" | "parse">Parameters
- value: NumberParsableTypes
Optionalexclusive: boolean
Returns NextBuilder<IInt.Parser, "min", "not" | "parse">
Interface Parser<T>
A parser
+interface Parser<T = unknown> {
for: <U>(schema: ComplexSchema<U>) => IComplex.Parser<U>;
parse: IParse<T>;
use: <U>(parser: ICurrentParser<U>) => IParser<U>;
}
for: <U>(schema: ComplexSchema<U>) => IComplex.Parser<U>;
parse: IParse<T>;
use: <U>(parser: ICurrentParser<U>) => IParser<U>;
}
Type Parameters
- T = unknown
Hierarchy (View Summary)
Implemented by
Interface IParse<T>
A parse function
+Type Parameters
- T
Parameters
- value: unknown
Returns IParseResult<T>
Interface IParseErrors
Indexable
- [k: string]: unknown
diff --git a/docs/interfaces/IParser.html b/docs/interfaces/IParser.html
new file mode 100644
index 0000000..497d363
--- /dev/null
+++ b/docs/interfaces/IParser.html
@@ -0,0 +1,3 @@
+
diff --git a/docs/interfaces/IRoot.Parser.html b/docs/interfaces/IRoot.Parser.html
new file mode 100644
index 0000000..1b07157
--- /dev/null
+++ b/docs/interfaces/IRoot.Parser.html
@@ -0,0 +1,17 @@
+
Interface Parser
A parser
+interface Parser {
array: NextBuilder<IArray.Parser, never, "of">;
boolean: IBoolean.Parser;
date: IDate.Parser;
dictionary: IDictionary.Parser;
float: IFloat.Parser;
for: <T>(schema: ComplexSchema<T>) => IComplex.Parser<T>;
int: IInt.Parser;
json: IJson.Parser;
not: NextBuilder<IRoot.Parser, "not" | "parse">;
parse: IParse<unknown>;
required: NextBuilder<IRoot.Parser, "required">;
string: IString.Parser;
use: <T>(parser: IParser<T>) => IParser<T>;
}
array: NextBuilder<IArray.Parser, never, "of">;
boolean: IBoolean.Parser;
date: IDate.Parser;
dictionary: IDictionary.Parser;
float: IFloat.Parser;
for: <T>(schema: ComplexSchema<T>) => IComplex.Parser<T>;
int: IInt.Parser;
json: IJson.Parser;
not: NextBuilder<IRoot.Parser, "not" | "parse">;
parse: IParse<unknown>;
required: NextBuilder<IRoot.Parser, "required">;
string: IString.Parser;
use: <T>(parser: IParser<T>) => IParser<T>;
}
Hierarchy (View Summary)
- IParser<unknown>
- Parser
Implemented by
Interface Parser
A parser
+interface Parser {
not: NextBuilder<IString.Parser, "not" | "parse">;
parse: IParse<string>;
anyOf(
values: string[],
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "anyOf", "not" | "parse">;
endsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "endsWith" | "matches", "not" | "parse">;
equals(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "equals", "not" | "parse">;
includes(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "includes" | "matches", "not" | "parse">;
matches(
value: string | RegExp,
name?: string,
): NextBuilder<
IString.Parser,
"matches"
| "includes"
| "startsWith"
| "endsWith",
"not" | "parse",
>;
maxLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "maxLength", "not" | "parse">;
minLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "minLength", "not" | "parse">;
startsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "startsWith" | "matches", "not" | "parse">;
}
not: NextBuilder<IString.Parser, "not" | "parse">;
parse: IParse<string>;
anyOf(
values: string[],
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "anyOf", "not" | "parse">;
endsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "endsWith" | "matches", "not" | "parse">;
equals(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "equals", "not" | "parse">;
includes(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "includes" | "matches", "not" | "parse">;
matches(
value: string | RegExp,
name?: string,
): NextBuilder<
IString.Parser,
"matches"
| "includes"
| "startsWith"
| "endsWith",
"not" | "parse",
>;
maxLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "maxLength", "not" | "parse">;
minLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "minLength", "not" | "parse">;
startsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "startsWith" | "matches", "not" | "parse">;
}
Hierarchy (View Summary)
- IParser<string>
- Parser
Implemented by
Methods
any
- anyOf(
values: string[],
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "anyOf", "not" | "parse">Parameters
- values: string[]
OptionalignoreCase: boolean
Returns NextBuilder<IString.Parser, "anyOf", "not" | "parse">
ends
- endsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "endsWith" | "matches", "not" | "parse">Parameters
- value: string
OptionalignoreCase: boolean
Returns NextBuilder<IString.Parser, "endsWith" | "matches", "not" | "parse">
equals
- equals(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "equals", "not" | "parse">Parameters
- value: string
OptionalignoreCase: boolean
Returns NextBuilder<IString.Parser, "equals", "not" | "parse">
includes
- includes(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "includes" | "matches", "not" | "parse">Parameters
- value: string
OptionalignoreCase: boolean
Returns NextBuilder<IString.Parser, "includes" | "matches", "not" | "parse">
matches
- matches(
value: string | RegExp,
name?: string,
): NextBuilder<
IString.Parser,
"matches"
| "includes"
| "startsWith"
| "endsWith",
"not" | "parse",
>Parameters
- value: string | RegExp
Optionalname: string
Returns NextBuilder<
IString.Parser,
"matches"
| "includes"
| "startsWith"
| "endsWith",
"not" | "parse",
>
max
- maxLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "maxLength", "not" | "parse">Parameters
- value: number
Optionalexclusive: boolean
Returns NextBuilder<IString.Parser, "maxLength", "not" | "parse">
min
- minLength(
value: number,
exclusive?: boolean,
): NextBuilder<IString.Parser, "minLength", "not" | "parse">Parameters
- value: number
Optionalexclusive: boolean
Returns NextBuilder<IString.Parser, "minLength", "not" | "parse">
starts
- startsWith(
value: string,
ignoreCase?: boolean,
): NextBuilder<IString.Parser, "startsWith" | "matches", "not" | "parse">Parameters
- value: string
OptionalignoreCase: boolean
Returns NextBuilder<IString.Parser, "startsWith" | "matches", "not" | "parse">
Interface NumberEnumMap
A number enum map object
+Indexable
- [n: string]: string | number
@ntix/parsing
Classes
Functions
- asCurrent
- createParseResult
- ensureDateArray
- ensureNumberArray
- getNumberEnumValues
- isBooleanType
- isDate
- isDateType
- isEqual
- isFloat
- isInt
- isNullOrEmpty
- isNumberType
- isStringType
- parseCast
- parseChain
- parseDate
- parseFloat
- parseInt
- provideAnyOf
- provideAnyOfString
- provideDictionaryValues
- provideEndsWithString
- provideEquals
- provideEqualsString
- provideIncludesString
- provideMatchesString
- provideMax
- provideMaxLength
- provideMin
- provideMinLength
- provideParseArray
- provideParseArrayValues
- provideParseBoolean
- provideParseComplex
- provideParseDate
- provideParseDictionary
- provideParseDictionaryValues
- provideParseFloat
- provideParseInt
- provideParseJson
- provideParseRoot
- provideParseString
- provideParseUniqueArray
- provideStartsWithString
- tryParseBoolean
- tryParseDate
- tryParseFloat
- tryParseInt
- tryParseJson
diff --git a/docs/modules/IBoolean.html b/docs/modules/IBoolean.html
new file mode 100644
index 0000000..a4ea188
--- /dev/null
+++ b/docs/modules/IBoolean.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/modules/IComplex.html b/docs/modules/IComplex.html
new file mode 100644
index 0000000..3438598
--- /dev/null
+++ b/docs/modules/IComplex.html
@@ -0,0 +1 @@
+
Namespace IComplex
Interfaces
diff --git a/docs/modules/IDictionary.html b/docs/modules/IDictionary.html
new file mode 100644
index 0000000..0402958
--- /dev/null
+++ b/docs/modules/IDictionary.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/modules/IFloat.html b/docs/modules/IFloat.html
new file mode 100644
index 0000000..8cbae72
--- /dev/null
+++ b/docs/modules/IFloat.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/modules/IInt.html b/docs/modules/IInt.html
new file mode 100644
index 0000000..cbc3e8f
--- /dev/null
+++ b/docs/modules/IInt.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/modules/IJson.html b/docs/modules/IJson.html
new file mode 100644
index 0000000..44c3460
--- /dev/null
+++ b/docs/modules/IJson.html
@@ -0,0 +1,2 @@
+
diff --git a/docs/modules/IRoot.html b/docs/modules/IRoot.html
new file mode 100644
index 0000000..c350fce
--- /dev/null
+++ b/docs/modules/IRoot.html
@@ -0,0 +1 @@
+
Namespace IRoot
Interfaces
diff --git a/docs/types/ComplexSchema.html b/docs/types/ComplexSchema.html
new file mode 100644
index 0000000..56562df
--- /dev/null
+++ b/docs/types/ComplexSchema.html
@@ -0,0 +1 @@
+
Type Alias DateParsableTypes
DateParsableTypes: Date | string | number
Types which can be parsed to a date
+
diff --git a/docs/types/NumberParsableTypes.html b/docs/types/NumberParsableTypes.html
new file mode 100644
index 0000000..e654307
--- /dev/null
+++ b/docs/types/NumberParsableTypes.html
@@ -0,0 +1 @@
+
Type Alias NumberParsableTypes
NumberParsableTypes: string | number
Type Alias RelationalValidatorTypes
RelationalValidatorTypes: number | Date
can compare with > < etc
+Variable BOOLEANS_FALSEConst
BOOLEANS_FALSE: (string | number)[] = ...
values considered to be a boolean false
+Variable BOOLEANS_TRUEConst
BOOLEANS_TRUE: (string | number)[] = ...
values considered to be a boolean true
+Variable DATE_SETTINGSConst
DATE_SETTINGS: {
formatDayFirst: boolean;
parseDayFirst: boolean;
shortRE: RegExp;
} = ...
formatDayFirst: boolean;
parseDayFirst: boolean;
shortRE: RegExp;
} = ...
Global date parsing settings
+Type Declaration
formatDayFirst: boolean
parseDayFirst: boolean
shortRE: RegExp
Variable isObjectConst
isObject: (value: unknown) => boolean = ...
check a value is an object
+Type Declaration
- (value: unknown): boolean
Parameters
- value: unknown
value to check
+
Returns boolean
true if value is an object
+- value: unknown
Variable stringOfLengthConst
stringOfLength: (length: number) => string = ...
Type Declaration
- (length: number): string
Parameters
- length: number
Returns string
A parser
+