@dwp/govuk-casa
Version:
A framework for building GOVUK Collect-And-Submit-Applications
50 lines (49 loc) • 1.33 kB
TypeScript
/**
* @typedef {import("../../casa").ErrorMessageConfig} ErrorMessageConfig
* @access private
*/
/**
* @typedef {object} RangeConfigOptions
* @property {ErrorMessageConfig} errorMsgMax Error message to use on max
* failure
* @property {ErrorMessageConfig} errorMsgMin Error message to use on min
* failure
* @property {number} max Maximum integer value
* @property {number} min Minimum integer value
*/
/**
* Test if an integer is within a provided range.
*
* See {@link RangeConfigOptions} for `make()` options.
*
* @memberof Validators
* @augments ValidatorFactory
*/
export default class Range extends ValidatorFactory {
name: string;
validate(inputValue: any, dataContext?: {}): ValidationError[];
sanitise(value: any): string | undefined;
}
export type ErrorMessageConfig = import("../../casa").ErrorMessageConfig;
export type RangeConfigOptions = {
/**
* Error message to use on max
* failure
*/
errorMsgMax: ErrorMessageConfig;
/**
* Error message to use on min
* failure
*/
errorMsgMin: ErrorMessageConfig;
/**
* Maximum integer value
*/
max: number;
/**
* Minimum integer value
*/
min: number;
};
import ValidatorFactory from "../ValidatorFactory.js";
import ValidationError from "../ValidationError.js";