Skip to main content

index/variables/commonValidators.md

const commonValidators: object

Common field validators for reuse across validation functions

These validators can be used with createOptionsValidator or directly.

Type Declaration​

NameTypeDescription
enumValue()<T>(field, validValues) => (value) => string | undefinedCreates a validator for enum values
isoDate()(field) => (value) => string | undefinedCreates a validator for ISO date strings
maxLength()(field, max) => (value) => string | undefinedCreates a validator for max length string fields
positiveInteger()(field) => (value) => string | undefinedCreates a validator for positive integer fields
requiredEnumValue()<T>(field, validValues) => (value) => string | undefinedCreates a validator for required enum values
requiredPositiveInteger()(field) => (value) => string | undefinedCreates a validator for required positive integer fields
requiredString()(field) => (value) => string | undefinedCreates a validator for required non-empty string fields
walletAddress()(field, required?) => (value) => string | undefinedCreates a validator for wallet addresses

Since​

6.12.0