Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@lemoncode/fonk-positive-number-validator

1.1.0 • Public • Published

fonk-positive-number-validator

CircleCI NPM Version bundle-size

This is a fonk microlibrary that brings validation capabilities to:

  • Validate if a field of a form is a positive number

How to install it:

npm install @lemoncode/fonk-positive-number-validator --save

How to add it to an existing form validation schema:

We have the following form model:

const myFormValues = {
  product: 'shoes',
  price: 20,
}

We can add a positiveNumber validation to the myFormValues

import { positiveNumber } from '@lemoncode/fonk-positive-number-validator';
 
const validationSchema = {
  field: {
    price: [positiveNumber.validator],
  },
};

The validator must be configured with the following required arguments:

export interface CustomValidatorArgs {
  strictTypes?: boolean;
  allowZero?: boolean;
}

These are the default arguments:

let defaultCustomArgs: CustomValidatorArgs = {
  strictTypes: false,
  allowZero: true,
};

You can specify the custom arguments in two ways:

  • Locally just customize the arguments for this validationSchema (e.g. We can specify if the validator allows zero):
import { positiveNumber } from '@lemoncode/fonk-positive-number-validator';
 
const validationSchema = {
  field: {
    price: [
      {
        validator: positiveNumber.validator,
        customArgs: { allowZero: true },
      },
    ],
  },
};
  • Globally, replace the default custom arguments in all validationSchemas (e.g. enable strict types):
import { positiveNumber } from '@lemoncode/fonk-positive-number-validator';
 
positiveNumber.setCustomArgs({ strictTypes: true });

You can customize the error message displayed in two ways:

  • Globally, replace the default error message in all validationSchemas (e.g. porting to spanish):
import { positiveNumber } from '@lemoncode/fonk-positive-number-validator';
 
positiveNumber.setErrorMessage('El campo debe de ser un número positivo');
  • Locally just override the error message for this validationSchema:
import { positiveNumber } from '@lemoncode/fonk-positive-number-validator';
 
const validationSchema = {
  field: {
    price: [
      {
        validator: positiveNumber.validator,
        message: 'Error message only updated for the validation schema',
      },
    ],
  },
};

Please, refer to fonk to know more.

License

MIT

About Basefactor + Lemoncode

We are an innovating team of Javascript experts, passionate about turning your ideas into robust products.

Basefactor, consultancy by Lemoncode provides consultancy and coaching services.

Lemoncode provides training services.

For the LATAM/Spanish audience we are running an Online Front End Master degree, more info: http://lemoncode.net/master-frontend

Install

npm i @lemoncode/fonk-positive-number-validator

DownloadsWeekly Downloads

1

Version

1.1.0

License

MIT

Unpacked Size

14.8 kB

Total Files

8

Last publish

Collaborators

  • avatar