Class UnsignedIntegerValidator

The UnsignedIntegerValidator class is a validator that ensures a string contains a valid unsigned integer within a specified range.

Hierarchy

NumberValidator
- UnsignedIntegerValidator

Index

Constructors

Properties

m_maximum m_minimum

Accessors

maximum minimum pattern

Methods

fixup toValue validate

Constructors

constructor

new UnsignedIntegerValidator(minimum?, maximum?): UnsignedIntegerValidator
Constructs an unsigned integer validator with a minimum and a maximum.
Parameters
- minimum: number = 0
- maximum: number = Number.POSITIVE_INFINITY
Returns UnsignedIntegerValidator
Overrides NumberValidator.constructor
- Defined in validator/unsignedinteger.ts:11

Properties

`Protected` m_maximum

m_maximum: number = Number.POSITIVE_INFINITY

`Protected` m_minimum

m_minimum: number = Number.NEGATIVE_INFINITY

Accessors

maximum

get maximum(): number
Returns the number validator's maximum value.

Returns number
Inherited from NumberValidator.maximum
- Defined in validator/number.ts:72
set maximum(maximum): void
Sets the number validator's maximum value to maximum.
Parameters
- maximum: number
Returns void
Inherited from NumberValidator.maximum
- Defined in validator/number.ts:79

minimum

get minimum(): number
Returns the number validator's minimum value.

Returns number
Inherited from NumberValidator.minimum
- Defined in validator/number.ts:58
set minimum(minimum): void
Sets the number validator's minimum value to minimum.
Parameters
- minimum: number
Returns void
Inherited from NumberValidator.minimum
- Defined in validator/number.ts:65

pattern

get pattern(): RegExp
Returns the regular expression of this validator.

Returns RegExp
Inherited from NumberValidator.pattern
- Defined in validator/validator.ts:36
set pattern(pattern): void
Sets the regular expression of this validator to pattern.
Parameters
- pattern: RegExp
Returns void
Inherited from NumberValidator.pattern
- Defined in validator/validator.ts:43

Methods

fixup

fixup(input): string
This function attempts to modify the input to make it valid based on the rules defined by this validator.
Parameters
- input: string
Returns string
Inherited from NumberValidator.fixup
- Defined in validator/number.ts:39

`Protected` toValue

toValue(input): number
Converts the string to an unsigned integer.
Parameters
- input: string
Returns number
Overrides NumberValidator.toValue
- Defined in validator/unsignedinteger.ts:18

validate

validate(input): ValidatorState
Returns Invalid if input is invalid according to this validator's rules. Returns Intermediate if input is likely that a little more editing will make the input acceptable. Returns Acceptable if the input is valid.
Parameters
- input: string
Returns ValidatorState
Inherited from NumberValidator.validate
- Defined in validator/number.ts:25

Generated using TypeDoc