@dwp/govuk-casa
Version:
A framework for building GOVUK Collect-And-Submit-Applications
36 lines (35 loc) • 1.05 kB
TypeScript
/**
* @typedef {import("../../casa").ErrorMessageConfig} ErrorMessageConfig
* @access private
*/
/**
* @typedef {object} RequiredConfigOptions
* @property {ErrorMessageConfig} errorMsg Error message config
*/
/**
* Test if value is present.
*
* Value is required. The following values will fail this rule: (all values that
* satisfy `isEmpty()`) plus '\s'
*
* See {@link RequiredConfigOptions} for `make()` options.
*
* @memberof Validators
* @augments ValidatorFactory
*/
export default class Required extends ValidatorFactory {
name: string;
validate(value: any, dataContext?: {}): ValidationError[];
sanitise(value: any): string | (string | undefined)[] | {
[k: string]: string | undefined;
} | undefined;
}
export type ErrorMessageConfig = import("../../casa").ErrorMessageConfig;
export type RequiredConfigOptions = {
/**
* Error message config
*/
errorMsg: ErrorMessageConfig;
};
import ValidatorFactory from "../ValidatorFactory.js";
import ValidationError from "../ValidationError.js";