Final Class: NumberRangeValidator

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 0.7.0
Module:
  • ojvalidator-numberrange

QuickNav

Methods

Type Definitions

Description

Constructs a NumberRangeValidator that ensures the value provided is within a given range.


Usage

Signature:

final class NumberRangeValidator implements Validator<string|number>

Typescript Import Format
//This class is exported directly as module. To import it
import NumberRangeValidator= require("ojs/ojvalidator-numberrange");

For additional information visit:


Final classes in JET

Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.


See:
  • oj.AsyncNumberRangeValidator

Constructor

new NumberRangeValidator(options)

Constructs a NumberRangeValidator that ensures the value provided is within a given range.
Parameters:
Name Type Argument Description
options oj.NumberRangeValidator.ValidatorOptions <optional>
 an object literal used to provide the following properties
See:
  • oj.AsyncNumberRangeValidator

Methods

getHint : {string|null}

Returns:

a hint message or null if no hint is available in the options. A hint message may be like "Enter a value between {min} and {max}" or "Enter a number greater than or equal to {min}"

Type
string | null

validate(value) : {void}

Validates the minimum + maximum conditions
Parameters:
Name Type Description
value string | number that is being validated
Throws:
when value is out of range
Type
Error
Returns:
Type
void

Type Definitions

ValidatorOptions

Properties:
Name Type Argument Description
converter oj.NumberConverter <optional>
 an instance implementation of oj.NumberConverter. It is used to format the value in error message. It is optional for the validator that a converter is passed in.
hint Object <optional>
 an optional object literal of hints to be used. If not set, defaults will be used for the validator hint. See the individual hint properties below for details.

The hint strings (e.g., hint.min) are passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Properties
Name Type Argument Description
exact string <optional>
 a hint used to indicate the allowed value. This is used when min and max are non-null and are equal to each other. When not present, the default hint is the resource defined with the key oj-validator.range.number.hint.exact.

Tokens:
{num} the number allowed
Usage:
Enter the number {num}

inRange string <optional>
 a hint used to indicate the allowed range. When not present, the default hint is the resource defined with the key oj-validator.range.number.hint.inRange.

Tokens:
{min} the minimum
{max} the maximum

Usage:
Enter a number between {min} and {max}

max string <optional>
 a hint used to indicate the allowed maximum. When not present, the default hint is the resource defined with the key oj-validator.range.number.hint.max.

Tokens:
{max} - the maximum

Usage:
Enter a number less than or equal to {max}

min string <optional>
 a hint used to indicate the allowed minimum. When not present, the default hint is the resource defined with the key oj-validator.range.number.hint.min.

Tokens:
{min} the minimum

Usage:
Enter a number greater than or equal to {min}

max number <optional>
 the maximum number value of the entered value.
messageDetail Object <optional>
 an optional object literal of custom error messages to be used.

The messageDetail strings (e.g., messageDetail.rangeUnderflow) are passed as the 'pattern' parameter to oj.Translations.html#applyParameters. As stated in that documentation, if you are using a reserved character, you need to escape it with a dollar character ('$').

Properties
Name Type Argument Description
exact string <optional>
 the detail error message to be used when the input value is not between min and max when min and max are both non-null and equal. When not present, the default detail message is the resource defined with the key oj-validator.range.number.messageDetail.exact.

Tokens:
{num} - the allowed value

Usage:
The number must be {num}.

rangeOverflow string <optional>
 the detail error message to be used when input value exceeds the maximum value set. When not present, the default detail message is the resource defined with the key oj-validator.range.number.messageDetail.rangeOverflow.

Tokens:
{value} - value entered by the user
{max} - the maximum allowed value

Usage:
The number must be less than or equal to {max}.

rangeUnderflow string <optional>
 the detail error message to be used when input value is less than the set minimum value. When not present, the default detail message is the resource defined with the key oj-validator.range.number.messageDetail.rangeUnderflow.

Tokens:
{value} - value entered by the user
{min} - the minimum allowed value

Usage:
The number must be greater than or equal to {min}.

messageSummary Object <optional>
 optional object literal of custom error summary message to be used.
Properties
Name Type Argument Description
rangeOverflow string <optional>
 the summary of the error message when input value exceeds the maximum value set. When not present, the default message summary is the resource defined with the key oj-validator.range.number.messageSummary.rangeOverflow.
rangeUnderflow string <optional>
 the summary of the error message when input value is less than the set minimum value. When not present, the default message summary is the resource defined with the key oj-validator.range.number.messageSummary.rangeUnderflow.
min number <optional>
 the minimum number value of the entered value.
Since:
  • 3.0.0