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

@lemoncode/fonk-chars-not-black-list-validator

1.0.0 • Public • Published

fonk-chars-not-black-list-validator

CircleCI NPM Version bundle-size

This is a fonk microlibrary that brings validation capabilities to:

  • Validate if a field of a form only contains valid characters.

How to install it:

npm install @lemoncode/fonk-chars-not-black-list-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 charsNotBlackList validation to the myFormValues. CustomArgs are required:

import { charsNotBlackList } from '@lemoncode/fonk-chars-not-black-list-validator';
 
const validationSchema = {
  field: {
    product: [
      {
        validator: charsNotBlackList.validator,
        customArgs: { blackListChars: 'nw5' },
      },
    ],
  },
};

Some characters will need to be escaped on the blacklist because they are used in a RegExp. For example, if you want to include backslash (\) or simple quote(') as blacklist characters you will need to escape them:

import { charsNotBlackList } from '@lemoncode/fonk-chars-not-black-list-validator';
 
const validationSchema = {
  field: {
    product: [
      {
        validator: charsNotBlackList.validator,
        customArgs: { blackListChars: 'n\'w\\5' },
      },
    ],
  },
};

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 { charsNotBlackList } from '@lemoncode/fonk-chars-not-black-list-validator';
 
charsNotBlackList.setErrorMessage('El campo contiene caracteres no válidos.');
  • Locally just override the error message for this validationSchema:
import { charsNotBlackList } from '@lemoncode/fonk-chars-not-black-list-validator';
 
const validationSchema = {
  field: {
    price: [
      {
        validator: charsNotBlackList.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-chars-not-black-list-validator

DownloadsWeekly Downloads

1

Version

1.0.0

License

MIT

Unpacked Size

13.5 kB

Total Files

8

Last publish

Collaborators

  • avatar