Header menu logo FCQRS

Validation Module

Types and nested modules

Type/Module Description

ValidateRegexes

FieldInfo<'T, 'T0, 'E>

ValidateResult<'T>

Validator<'E>

Functions and values

Function or value Description

all tester

Full Usage: all tester

Parameters:
Returns: Result<'T, Map<string, 'E list>>
Modifiers: inline
Type parameters: 'E, 'T

validate all fields and return a custom type,

tester : Validator<'E> -> 'T
Returns: Result<'T, Map<string, 'E list>>

allAsync tester

Full Usage: allAsync tester

Parameters:
Returns: Async<Result<'T, Map<string, 'E list>>>
Modifiers: inline
Type parameters: 'E, 'T
tester : Validator<'E> -> Async<'T>
Returns: Async<Result<'T, Map<string, 'E list>>>

fast tester

Full Usage: fast tester

Parameters:
Returns: Result<'T, Map<string, 'E list>>
Modifiers: inline
Type parameters: 'E, 'T

Exit after first error occurred and return a custom type

tester : Validator<'E> -> 'T
Returns: Result<'T, Map<string, 'E list>>

fastAsync tester

Full Usage: fastAsync tester

Parameters:
Returns: Async<Result<'T, Map<string, 'E list>>>
Modifiers: inline
Type parameters: 'E, 'T
tester : Validator<'E> -> Async<'T>
Returns: Async<Result<'T, Map<string, 'E list>>>

isValid

Full Usage: isValid

Returns: ('T0 -> bool) -> 'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T0, 'E>

IsValid helper from Validator method for custom rule functions, you can also extend Validator class directly.

Returns: ('T0 -> bool) -> 'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T0, 'E>

isValidAsync

Full Usage: isValidAsync

Returns: ('T -> Async<bool>) -> 'E -> Async<FieldInfo<'T0, 'T, 'E>> -> Async<FieldInfo<'T0, 'T, 'E>>

IsValidAsync helper from Validator method for custom rule functions, you can also extend Validator class directly.

Returns: ('T -> Async<bool>) -> 'E -> Async<FieldInfo<'T0, 'T, 'E>> -> Async<FieldInfo<'T0, 'T, 'E>>

isValidOpt

Full Usage: isValidOpt

Returns: ('T0 -> ValidateResult<'T1>) -> 'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T1, 'E>

IsValidOpt helper from Validator method for custom rule functions, you can also extend Validator class directly.

Returns: ('T0 -> ValidateResult<'T1>) -> 'E -> FieldInfo<'T, 'T0, 'E> -> FieldInfo<'T, 'T1, 'E>

isValidOptAsync

Full Usage: isValidOptAsync

Returns: ('T0 -> Async<ValidateResult<'T1>>) -> 'E -> Async<FieldInfo<'T, 'T0, 'E>> -> Async<FieldInfo<'T, 'T1, 'E>>

IsValidOptAsync helper from Validator method for custom rule functions, you can also extend Validator class directly.

Returns: ('T0 -> Async<ValidateResult<'T1>>) -> 'E -> Async<FieldInfo<'T, 'T0, 'E>> -> Async<FieldInfo<'T, 'T1, 'E>>

single tester

Full Usage: single tester

Parameters:
Returns: Result<'T, 'E list>

Validate single value

tester : Validator<'E> -> 'T
Returns: Result<'T, 'E list>

singleAsync tester

Full Usage: singleAsync tester

Parameters:
Returns: Async<Result<'T, 'E list>>

Validate single value asynchronize

tester : Validator<'E> -> Async<'T>
Returns: Async<Result<'T, 'E list>>

validateAsync all tester

Full Usage: validateAsync all tester

Parameters:
Returns: Async<Result<'T, Map<string, 'E list>>>
all : bool
tester : Validator<'E> -> Async<'T>
Returns: Async<Result<'T, Map<string, 'E list>>>

validateSync all tester

Full Usage: validateSync all tester

Parameters:
Returns: Result<'T, Map<string, 'E list>>
all : bool
tester : Validator<'E> -> 'T
Returns: Result<'T, Map<string, 'E list>>

Type something to start searching.