Header menu logo arc-validate

Param Type

Validation functions to perform on any type implementing the `IParam` interface.

Static members

Static member Description

Param.TermIsEqualTo(expectedTerm) (param)

Full Usage: Param.TermIsEqualTo(expectedTerm) (param)

Parameters:
    expectedTerm : CvTerm - The expected term to validate against
    param : 'a - The param to validate

Validates if the term of the given Param is equal to the expected term.

expectedTerm : CvTerm

The expected term to validate against

param : 'a

The param to validate

Param.ValueIsEqualTo(targetValue) (param)

Full Usage: Param.ValueIsEqualTo(targetValue) (param)

Parameters:
    targetValue : IConvertible
    param : 'a - The param to validate

Validates if the value of the given Param is equal to the expected value.

targetValue : IConvertible
param : 'a

The param to validate

Param.ValueIsNotEmpty(param)

Full Usage: Param.ValueIsNotEmpty(param)

Parameters:
    param : 'a - The param to validate

Validates that the value of the given Param is not empty (meaning it is not an empty string: "").

param : 'a

The param to validate

Param.ValueMatchesPattern(pattern) (param)

Full Usage: Param.ValueMatchesPattern(pattern) (param)

Parameters:
    pattern : string - The regex pattern that the value should match
    param : 'a - The param to validate

Validates if the value of the given Param matches a regex pattern.

pattern : string

The regex pattern that the value should match

param : 'a

The param to validate

Param.ValueMatchesRegex(regex) (param)

Full Usage: Param.ValueMatchesRegex(regex) (param)

Parameters:
    regex : Regex
    param : 'a - The param to validate

Validates if the value of the given Param matches a regex.

regex : Regex
param : 'a

The param to validate

Param.ValueSatisfiesPredicate(predicate) (param)

Full Usage: Param.ValueSatisfiesPredicate(predicate) (param)

Parameters:
    predicate : IConvertible -> bool - The predicate that the Param should satisfy
    param : 'a - The param to validate

Validates if the value of the given Param satisfies a predicate (meaning a function that for a given Param returns either true or false)

predicate : IConvertible -> bool

The predicate that the Param should satisfy

param : 'a

The param to validate

Type something to start searching.