decimal
Creates a pipeline validation action that validates a decimal.
const Validation = decimal<TInput>(message);
Generics
TInputextends string
Parameters
messageErrorMessage | undefined
Explanation
With decimal you can validate the formatting of a string. If the input is not a decimal, you can use message to customize the error message.
Returns
ValidationDecimalValidation<TInput>
Examples
The following examples show how decimal can be used.
Decimal schema
Schema to validate a decimal.
const DecimalSchema = string([decimal('The decimal is badly formatted.')]);
Related
The following APIs can be combined with decimal.