Validator<'E>Type

PackageFCQRS.Model

Specification

Kind

Type

Members

Examples

``.ctor``Signature

Validator(all)

DefaultOfErrorSignature

this.DefaultOfError

DefaultOfNoneSignature

this.DefaultOfNone

EndSignature

this.End

EndAsyncSignature

this.EndAsync

Summary

Name	Signature	Synopsis
``.ctor``	Validator(all)	No description available.
DefaultOfError	this.DefaultOfError	Defaults of Error value, it won't collect error
DefaultOfNone	this.DefaultOfNone	Defaults of None value, it won't collect error
End	this.End	No description available.
EndAsync	this.EndAsync	No description available.
Enum	this.Enum	No description available.
Gt	this.Gt	Greater then a value, if err is a string, it can contains `{min}` to reuse first param
Gte	this.Gte	Greater and equal then a value, if err is a string, it can contains `{min}` to reuse first param
IsDigit	this.IsDigit	No description available.
IsMail	this.IsMail	No description available.
IsOk	this.IsOk	Test a Result value is Ok and unwrap it it will collect error
IsSome	this.IsSome	Test an option value is some and unwrap it it will collect error
IsUrl	this.IsUrl	No description available.
IsValid	this.IsValid	Validate with a custom tester, return bool
IsValidAsync	this.IsValidAsync	No description available.
IsValidOpt	this.IsValidOpt	Validate with a custom tester, return ValidateResult DU to modify input value
IsValidOptAsync	this.IsValidOptAsync	No description available.
Lt	this.Lt	Less then a value, if err is a string, it can contains `{max}` to reuse first param
Lte	this.Lte	Less and equal then a value, if err is a string, it can contains `{max}` to reuse first param
Map	this.Map	Map a function or constructor to the value, aka lift fn shouldn't throw error, if it would, please using `t.To fn error`
Match	this.Match	No description available.
MaxLen	this.MaxLen	Max length, if err is a string, it can contains `{len}` to reuse first param
MinLen	this.MinLen	Min length, if err is a string, it can contains `{len}` to reuse first param
NotBlank	this.NotBlank	Validate with `String.IsNullOrWhiteSpace`
PushError	this.PushError	No description available.
Test	this.Test	No description available.
TestAsync	this.TestAsync	No description available.
TestOne	this.TestOne	No description available.
TestOneOnlyOk	this.TestOneOnlyOk	No description available.
TestOneOnlyOkAsync	this.TestOneOnlyOkAsync	No description available.
TestOneOnlySome	this.TestOneOnlySome	No description available.
TestOneOnlySomeAsync	this.TestOneOnlySomeAsync	No description available.
TestOnlyOk	this.TestOnlyOk	Test rules only if value is Ok, it won't collect error if value is Error
TestOnlyOkAsync	this.TestOnlyOkAsync	Test rules only if value is Ok, it won't collect error if value is Error
TestOnlySome	this.TestOnlySome	Test rules only if value is Some, it won't collect error if value is None
TestOnlySomeAsync	this.TestOnlySomeAsync	Test rules only if value is Some, it won't collect error if value is None
To	this.To	Convert the input value by fn if fn throws error then it will collect error
ToAsync	this.ToAsync	Convert a synchronize validate pipe to asynchronize
Trim	this.Trim	No description available.
Errors	this.Errors	No description available.
HasError	this.HasError	No description available.

``.ctor``

Validator(all)

Member

Parameters

Name	Type	Description
all	bool

Returns

Validator<'E>

DefaultOfError

this.DefaultOfError

Member

Defaults of Error value, it won't collect error

Parameters

Name	Type	Description
defaults	'T0
input	FieldInfo<'T, Result<'T0, 'TError>, 'E>

Returns

FieldInfo<'T, 'T0, 'E>

DefaultOfNone

this.DefaultOfNone

Member

Defaults of None value, it won't collect error

Parameters

Name	Type	Description
defaults	'T0
input	FieldInfo<'T, 'T0 option, 'E>

Returns

FieldInfo<'T, 'T0, 'E>

End

this.End

Member

Parameters

Name	Type	Description
input	FieldInfo<'T, 'T0, 'E>

Returns

'T0

EndAsync

this.EndAsync

Member

Parameters

Name	Type	Description
input	Async<FieldInfo<'T, 'T0, 'E>>

Returns

Async<'T0>

Enum

this.Enum

Member

Parameters

Name	Type	Description
enums	'T0 list

Returns

'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T0, 'E>

Gt

this.Gt

Member

Greater then a value, if err is a string, it can contains `{min}` to reuse first param

Parameters

Name	Type	Description
min	'a
err	'E

Returns

FieldInfo<'a0, 'a, 'E> -> FieldInfo<'a0, 'a, 'E>

Gte

this.Gte

Member

Greater and equal then a value, if err is a string, it can contains `{min}` to reuse first param

Parameters

Name	Type	Description
min	'a
err	'E

Returns

FieldInfo<'a0, 'a, 'E> -> FieldInfo<'a0, 'a, 'E>

IsDigit

this.IsDigit

Member

Parameters

Name	Type	Description
error	'E
input	FieldInfo<'T, string, 'E>

Returns

FieldInfo<'T, string, 'E>

IsMail

this.IsMail

Member

Parameters

Name	Type	Description
error	'E
input	FieldInfo<'T, string, 'E>

Returns

FieldInfo<'T, string, 'E>

IsOk

this.IsOk

Member

Test a Result value is Ok and unwrap it it will collect error

Parameters

Name	Type	Description
error	'E

Returns

FieldInfo<'T, Result<'T0, 'TError>, 'E> -> FieldInfo<'T, 'T0, 'E>

IsSome

this.IsSome

Member

Test an option value is some and unwrap it it will collect error

Parameters

Name	Type	Description
error	'E

Returns

FieldInfo<'T, 'T0 option, 'E> -> FieldInfo<'T, 'T0, 'E>

IsUrl

this.IsUrl

Member

Parameters

Name	Type	Description
error	'E
input	FieldInfo<'T, string, 'E>

Returns

FieldInfo<'T, string, 'E>

IsValid

this.IsValid

Member

Validate with a custom tester, return bool

Parameters

Name	Type	Description
tester	'T0 -> bool

Returns

'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T0, 'E>

IsValidAsync

this.IsValidAsync

Member

Parameters

Name	Type	Description
tester	'T0 -> Async<bool>

Returns

'E -> Async<FieldInfo<'T, 'T0, 'E>> -> Async<FieldInfo<'T, 'T0, 'E>>

IsValidOpt

this.IsValidOpt

Member

Validate with a custom tester, return ValidateResult DU to modify input value

Parameters

Name	Type	Description
tester	'T0 -> ValidateResult<'T1>
error	'E
input	FieldInfo<'T, 'T0, 'E>

Returns

FieldInfo<'T, 'T1, 'E>

IsValidOptAsync

this.IsValidOptAsync

Member

Parameters

Name	Type	Description
tester	'T0 -> Async<ValidateResult<'T1>>
error	'E
input	Async<FieldInfo<'T, 'T0, 'E>>

Returns

Async<FieldInfo<'T, 'T1, 'E>>

Lt

this.Lt

Member

Less then a value, if err is a string, it can contains `{max}` to reuse first param

Parameters

Name	Type	Description
max	'a
err	'E

Returns

FieldInfo<'a0, 'a, 'E> -> FieldInfo<'a0, 'a, 'E>

Lte

this.Lte

Member

Less and equal then a value, if err is a string, it can contains `{max}` to reuse first param

Parameters

Name	Type	Description
max	'a
err	'E

Returns

FieldInfo<'a0, 'a, 'E> -> FieldInfo<'a0, 'a, 'E>

Map

this.Map

Member

Map a function or constructor to the value, aka lift fn shouldn't throw error, if it would, please using `t.To fn error`

Parameters

Name	Type	Description
fn	'T0 -> 'T1

Returns

FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T1, 'E>

Match

this.Match

Member

Parameters

Name	Type	Description
regex	Regex
error	'E
input	FieldInfo<'T, string, 'E>

Returns

FieldInfo<'T, string, 'E>

MaxLen

this.MaxLen

Member

Max length, if err is a string, it can contains `{len}` to reuse first param

Parameters

Name	Type	Description
len	int
err	'E
input	FieldInfo<'T, 'T0, 'E>

Returns

FieldInfo<'T, 'T0, 'E>

MinLen

this.MinLen

Member

Min length, if err is a string, it can contains `{len}` to reuse first param

Parameters

Name	Type	Description
len	int
err	'E
input	FieldInfo<'T, 'T0, 'E>

Returns

FieldInfo<'T, 'T0, 'E>

NotBlank

this.NotBlank

Member

Validate with `String.IsNullOrWhiteSpace`

Parameters

Name	Type	Description
err	'E

Returns

FieldInfo<'T, string, 'E> -> FieldInfo<'T, string, 'E>

PushError

this.PushError

Member

Parameters

Name	Type	Description
name	string
error	'E

Returns

unit

Test

this.Test

Member

Parameters

Name	Type	Description
name	string
value	'T

Returns

FieldInfo<'T, 'T, 'E>

TestAsync

this.TestAsync

Member

Parameters

Name	Type	Description
name	string
value	'T

Returns

Async<FieldInfo<'T, 'T, 'E>>

TestOne

this.TestOne

Member

Parameters

Name	Type	Description
value	'T

Returns

FieldInfo<'T, 'T, 'E>

TestOneOnlyOk

this.TestOneOnlyOk

Member

Parameters

Name	Type	Description
value	Result<'T, 'TError>

Returns

(FieldInfo<'T, 'T, 'E> -> FieldInfo<'T, 'T, 'E>) list -> Result<'T, 'TError>

TestOneOnlyOkAsync

this.TestOneOnlyOkAsync

Member

Parameters

Name	Type	Description
value	Result<'T, 'TError>

Returns

(Async<FieldInfo<'T, 'T, 'E>> -> Async<FieldInfo<'T, 'T, 'E>>) list -> Async<Result<'T, 'TError>>

TestOneOnlySome

this.TestOneOnlySome

Member

Parameters

Name	Type	Description
value	'T option

Returns

(FieldInfo<'T, 'T, 'E> -> FieldInfo<'T, 'T, 'E>) list -> 'T option

TestOneOnlySomeAsync

this.TestOneOnlySomeAsync

Member

Parameters

Name	Type	Description
value	'T option

Returns

(Async<FieldInfo<'T, 'T, 'E>> -> Async<FieldInfo<'T, 'T, 'E>>) list -> Async<'T option>

TestOnlyOk

this.TestOnlyOk

Member

Test rules only if value is Ok, it won't collect error if value is Error

Parameters

Name	Type	Description
name	string
value	Result<'T, 'TError>
rules	(FieldInfo<'T, 'T, 'E> -> FieldInfo<'T, 'T, 'E>) list

Returns

Result<'T, 'TError>

TestOnlyOkAsync

this.TestOnlyOkAsync

Member

Test rules only if value is Ok, it won't collect error if value is Error

Parameters

Name	Type	Description
name	string
value	Result<'T, 'TError>
rules	(Async<FieldInfo<'T, 'T, 'E>> -> Async<FieldInfo<'T, 'T, 'E>>) list

Returns

Async<Result<'T, 'TError>>

TestOnlySome

this.TestOnlySome

Member

Test rules only if value is Some, it won't collect error if value is None

Parameters

Name	Type	Description
name	string
value	'T option
rules	(FieldInfo<'T, 'T, 'E> -> FieldInfo<'T, 'T, 'E>) list

Returns

'T option

TestOnlySomeAsync

this.TestOnlySomeAsync

Member

Test rules only if value is Some, it won't collect error if value is None

Parameters

Name	Type	Description
name	string
value	'T option
rules	(Async<FieldInfo<'T, 'T, 'E>> -> Async<FieldInfo<'T, 'T, 'E>>) list

Returns

Async<'T option>

To

this.To

Member

Convert the input value by fn if fn throws error then it will collect error

Parameters

Name	Type	Description
fn	'T0 -> 'T1

Returns

'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T1, 'E>

ToAsync

this.ToAsync

Member

Convert a synchronize validate pipe to asynchronize

Parameters

Name	Type	Description
input	FieldInfo<'T, 'T0, 'E>

Returns

Async<FieldInfo<'T, 'T0, 'E>>

Trim

this.Trim

Member

Parameters

Name	Type	Description
input	FieldInfo<'T, string, string>

Returns

FieldInfo<'T, string, string>

Errors

this.Errors

Member

Returns

Map<string, 'E list>

HasError

this.HasError

Member

Returns

bool