ConstraintDSLModule

PackageReified.Constraint

Constraint constructors usable without the Constraint. prefix inside a module that declares value rules.

Summary

Name	Signature	Synopsis
Operations
present	present	Alias for .
blank	blank	Alias for .
optional	optional inner	Alias for .
minLength	minLength minimum	Alias for .
maxLength	maxLength maximum	Alias for .
lengthBetween	lengthBetween minimum maximum	Alias for .
email	email	Alias for .
trimmed	trimmed	Alias for .
numeric	numeric	Alias for .
alphanumeric	alphanumeric	Alias for .
pattern	pattern	Alias for .
oneOf	oneOf	Alias for .
noneOf	noneOf	Alias for .
equalTo	equalTo	Alias for .
notEqualTo	notEqualTo	Alias for .
greaterThan	greaterThan	Alias for .
lessThan	lessThan	Alias for .
atLeast	atLeast	Alias for .
atMost	atMost	Alias for .
positive	positive	Alias for .
nonNegative	nonNegative	Alias for .
negative	negative	Alias for .
nonPositive	nonPositive	Alias for .
single	single	Alias for .
atLeastOne	atLeastOne	Alias for .
atMostOne	atMostOne	Alias for .
moreThanOne	moreThanOne	Alias for .
notContains	notContains expected	Alias for .
multipleOf	multipleOf divisor	Alias for .
finite	finite	Alias for .
finite32	finite32	Alias for .
notWith	notWith	Alias for .
custom	custom	Alias for .
customLocalized	customLocalized	Alias for .
customWith	customWith	Alias for .
contramap	contramap	Alias for .
describe	describe	Alias for .
orError	orError failure result	Replaces a failed constraint's violation with the supplied error.
mapError	mapError mapper result	Maps a failed constraint's violation with the supplied function.

Operations

kind:member

present

Member

Alias for present.

Returns

Constraint<^value>

kind:member

blank

Member

Alias for blank.

Returns

Constraint<^value>

kind:member

optional

optional inner

Member

Alias for optional.

Parameters

Name	Type	Description
inner	Constraint<'a>

Returns

Constraint<^b>

kind:member

minLength

minLength minimum

Member

Alias for minLength.

Parameters

Name	Type	Description
minimum	int

Returns

Constraint<^value>

kind:member

maxLength

maxLength maximum

Member

Alias for maxLength.

Parameters

Name	Type	Description
maximum	int

Returns

Constraint<^value>

kind:member

lengthBetween

lengthBetween minimum maximum

Member

Alias for lengthBetween.

Parameters

Name	Type	Description
minimum	int
maximum	int

Returns

Constraint<^value>

kind:member

email

Member

Alias for email.

Returns

Constraint<string>

kind:member

trimmed

Member

Alias for trimmed.

Returns

Constraint<string>

kind:member

numeric

Member

Alias for numeric.

Returns

Constraint<string>

kind:member

alphanumeric

Member

Alias for alphanumeric.

Returns

Constraint<string>

kind:member

pattern

Member

Alias for pattern.

Returns

string -> Constraint<string>

kind:member

oneOf

Member

Alias for oneOf.

Returns

'a seq -> Constraint<'a>

kind:member

noneOf

Member

Alias for noneOf.

Returns

'a seq -> Constraint<'a>

kind:member

equalTo

Member

Alias for equalTo.

Returns

'a -> Constraint<'a>

kind:member

notEqualTo

Member

Alias for notEqualTo.

Returns

'a -> Constraint<'a>

kind:member

greaterThan

Member

Alias for greaterThan.

Returns

'a -> Constraint<'a>

kind:member

lessThan

Member

Alias for lessThan.

Returns

'a -> Constraint<'a>

kind:member

atLeast

Member

Alias for atLeast.

Returns

'a -> Constraint<'a>

kind:member

atMost

Member

Alias for atMost.

Returns

'a -> Constraint<'a>

kind:member

positive

Member

Alias for positive.

Returns

Constraint<^value>

kind:member

nonNegative

Member

Alias for nonNegative.

Returns

Constraint<^value>

kind:member

negative

Member

Alias for negative.

Returns

Constraint<^value>

kind:member

nonPositive

Member

Alias for nonPositive.

Returns

Constraint<^value>

kind:member

single

Member

Alias for single.

Returns

Constraint<^value>

kind:member

atLeastOne

Member

Alias for atLeastOne.

Returns

Constraint<^value>

kind:member

atMostOne

Member

Alias for atMostOne.

Returns

Constraint<^value>

kind:member

moreThanOne

Member

Alias for moreThanOne.

Returns

Constraint<^value>

kind:member

notContains

notContains expected

Member

Alias for notContains.

Parameters

Name	Type	Description
expected	'value

Returns

Constraint<^container>

kind:member

multipleOf

multipleOf divisor

Member

Alias for multipleOf.

Parameters

Name	Type	Description
divisor	^a

Returns

Constraint<^a>

kind:member

finite

Member

Alias for finite.

Returns

Constraint<float>

kind:member

finite32

Member

Alias for finite32.

Returns

Constraint<float32>

kind:member

notWith

Member

Alias for notWith.

Returns

string -> Constraint<'a> -> Constraint<'a>

kind:member

custom

Member

Alias for custom.

Returns

string -> ('a -> bool) -> Constraint<'a>

kind:member

customLocalized

Member

Alias for customLocalized.

Returns

string -> string -> ('a -> bool) -> Constraint<'a>

kind:member

customWith

Member

Alias for customWith.

Returns

string -> ('a -> Result<unit, Violation>) -> Constraint<'a>

kind:member

contramap

Member

Alias for contramap.

Returns

('a -> 'b) -> Constraint<'b> -> Constraint<'a>

kind:member

describe

Member

Alias for describe.

Returns

string -> Constraint<'a> -> Constraint<'a>

kind:member

orError

orError failure result

Member

Replaces a failed constraint's violation with the supplied error.

Parameters

Name	Type	Description
failure	'a
result	Result<'b, 'c>

Returns

Result<'b, 'a>

Verification Examples

value |> Constraint.guard present |> orError NameRequired

kind:member

mapError

mapError mapper result

Member

Maps a failed constraint's violation with the supplied function.

Parameters

Name	Type	Description
mapper	'a -> 'b
result	Result<'c, 'a>

Returns

Result<'c, 'b>

Verification Examples

value |> Constraint.guard (greaterThan 0) |> mapError InvalidQuantity

Examples

module SignupRules =
    open Reified.ConstraintDSL

    let age : Constraint<int> = atLeast 13
    let contact : Constraint<string> = Constraint.all [ present; email ]
    let requireContact value = value |> Constraint.guard contact |> orError EmailRequired