Number schema

A function which creates a parsing rule to ensure that a given value is a number.

Arguments

1. modifiers? - A list of modifiers
   • min: Learn more
   • max: Learn more
   • enumerator: Learn more
   • custom: Learn more
2. message? - A custom object with error messages to be displayed when validation fails or there are type errors

Examples

import { number } from '@nordic-ui/validathor';
 
const numberRule = number();
 
try {
  const parsedValue = numberRule.parse(123);
  console.log('Parsed value:', parsedValue);
} catch (error) {
  console.error('Parsing failed:', error.message);
}

TypeScript

To get the type of a schema, you can do the following:

const numberRule = number();
 
type NumberSchema = ReturnType<typeof numberRule.parse>; // number