Field Validation

Introduction

Installation

npm i field-validation

Examples

import { FV } from 'field-validation';
const v = new FV({ EMAIL_DOMAINS: ['@mail.ru'], MAX_LENGTH: 30, MIN_LENGTH: 20 });

v.pipe(v.notEmpty, v.email)({ value: ' ' });
// {value: ' ', message: 'Поле не заполнено', status: false}
v.pipe(v.notEmpty, v.email)({ value: 'vadimkamail.ru' });
// {value: 'vadimkamail.ru', message: 'Email должен содержать символы @ и ".". Допускается ввод только латиницы', status: false}
v.pipe(v.notEmpty, v.email)({ value: 'vadimk [email protected]' });
// {value: 'vadimk [email protected]', message: 'Пробелов быть не должно', status: false}
v.pipe(v.notEmpty, v.email)({ value: ' [email protected] ' });
// {value: ' [email protected] ', message: 'Поле заполнено не правильно', status: false}
v.pipe(v.notEmpty, v.email)({ value: '[email protected]' });
// '[email protected]', message: '', status: true}
v.pipe(v.notEmpty, v.email, v.withMaxLength)({ value: '[email protected]' });
// {value: '[email protected]', message: 'Максимальное количество символов 30', status: false}
v.pipe(v.notEmpty, v.email, v.withMaxLength, v.withMinLength)({ value: '[email protected]' });
// {value: '[email protected]', message: 'Минимальное количество символов 20', status: false}
v.pipe(v.notEmpty, v.email, v.withMaxLength)({ value: '[email protected]' });
// {value: '[email protected]', message: '', status: true}

Example of setting custom errors

import { FV } from 'field-validation';

const v = new FV({ 
  LANG: 'CUSTOM', 
  CUSTOM_ERRORS: {
    notEmpty: "フィールドが入力されていません",
    onlyRus: "キーボード レイアウトを確認する",
    onlyEng: "キーボード レイアウトを確認する",
    withMaxLength: `最大文字数 [MAX_LENGTH]`,
    withMinLength: `最小文字数 [MIN_LENGTH]`,
    email: {
      spaces: "スペースがあってはならない",
      missingDogOrDot: `メールには @ と "." 文字を含める必要があります。 ラテン文字のみ使用できます`,
      notFromAvailable: `ご提供いただいたメールアドレスは受け付けておりません。`,
    }
  }
});

More examples in test folder

Documentation

| Method/Property | Description | Default value | |------------------|-----------------------------------------|------------------------------------------| | EMAIL_DOMAINS | available emails domains | [] | | MAX_LENGTH | max length | null | | MIN_LENGTH | min length | null | | LANG | language for errors | "RU" ("EN", "RU", "CUSTOM" ) | | CUSTOM_ERRORS | custom phrases for errors | null | | pipe() | combine functions | - | | setMaxLength() | setter for MAX_LENGTH prop | - | | setMinLength() | setter for MIN_LENGTH prop | - | | setCustomErrors()| setter for CUSTOM_ERRORS prop | - | | setEmailDomains()| setter for EMAIL_DOMAINS prop | - | | notEmpty() | checking value for empty | - | | onlyRus() | checking value for only russian letters | - | | onlyEng() | checking value for only english letters | - | | withMaxLength() | checking value for max length | - | | withMinLength() | checking value for min length | - | | email() | checking value for email | - |