TypeScript validation utils
npm install meta-validate@MetaValidate. и заканчивается на .make()
{
errors: {
%ПОЛЕ%: {
%КЛЮЧ_ОШИБКИ_1%: boolean,
%КЛЮЧ_ОШИБКИ_2%: boolean,
},
%ПОЛЕ_КОМПОЗИЦИЯ%: {
%ПОЛЕ_КЛАССА_КОМПОЗИЦИИ_1%: {
%КЛЮЧ_ОШИБКИ_1%: boolean
...
}
}
}
}
#### 3 - есть пренастроенные классы валидаторов и можно будет регистрировать свои(скоро)
Это значит, что сам по себе просто хранилище всяких классов с валидаторами. Сейчас их несколько:
- Number - класс с частыми валидаторами чисел
- String - класс с частыми валидаторами строк
- Trigger - класс-триггер, нужен для связывания полей
- Nested - класс, обозначающий что поле содержит сложный экземпляр, который тоже умеет валидироваться
- Base - класс с базовыми методами, предполагающий использование только кастомных валидаторов
Дженерики принимают класс, поля которого вы валидируете.#### 4 - ваши классы должны реализовывать интерфейс ReceiveValidity
В вашем классе обязательно должно быть поле
validity$: Subject, в который будут валиться ошибки.#### 5 - семантика валидаторов.
Валидаторы возвращают false, если значение валидно. true - если есть ошибка. Т.е. валидатор отвечает на вопрос - есть-ли ошибка?
Это сделано для того, чтобы использовать объект с ошибками в шаблонах без всяких плясок вокруг ng-if. Пишем
Ошибочка min, маловато ввели#### 6 - преднастроенные валидаторы умеют принимать как значение, так и функцию от экземпляра
#### 7 - валидаторы запускаются на каждый чих над полем или связанными полями
$3
Пример
class Foo {
validity$: BehaviorSubject = new BehaviorSubject(); @MetaValidate.MVString().required().make()
bar: number = null;
}
Здесь
- @MetaValidate - тот самый базовый декоратор
- MVString - один из преднастроенных классов с валидаторами
- .make() - метод, делающий декорацию$3
Базовый класс валидаторов - от него наследуются все конкретные классы с валидаторами.Содержит общие методы, которые нужны всем.
Список методов
-
- делает поле обязательным к проверке. Ключ ошибки: required
- - метод, который можно повесить после валидатора, он запустит переданную функцию-условие с экземпляром вашего класса в качестве аргумента, и в зависимости от этого запустит или нет валидатор для предыдущего поля. В случае, если функция-условие вернет true - валидатор не будет запущен, ошибка будет false для него.
- skip(condition: (instance) => boolean) - метод, который обычно стоит вешать первым в цепочке, по условию определяет - запускать все валидаторы на поле или игнорировать его. В случае, если функция-условие вернет true - ни один валидатор для поля не будет запущен, во всех ключах ошибок будет false.
- with(fields: Array - список полей, с изменением которых будут вызваны проверки данного поля. Эти зависимые поля должны быть либо так же валидируемы, либо если они не требуют специальной валидации - декорированы специальным классом Trigger
- - кастомный валидатор, который можно повесть на поле. Обязательно должен возвращать boolean, в любом случае.
- make() - конечный метод цепочки, декорирует свойство$3
Использование
`
@MetaValidate.String()...make()
field: string = null;
Валидаторы:
- - минимальная длина значения должна быть len. Ключ ошибки - minLength
- - максимальная длина значения должна быть len. Ключ ошибки - maxLength
- - Длина значения должна быть строго len. Ключ ошибки - length
- - Значение должно соответствовать регулярке. Рекомендуется не забывать в регулярке ^$. Ключ ошибки - переданный name
- alphanum - Поле должно содержать только цифры и буквы. Ключ ошибки - alphanum
- - Поле должно содержать только цифры, буквы, тире и подчеркивание. Ключ ошибки - token$3
Использование
@MetaValidate.Number()...make()
Преднастроенные валидаторы пытаются привести значение к числу. Т.е. например ng-model инпута может быть забито на поле с этими валидаторами, и они будут приовдить значение к числу. Но только для проверки. Приведение для хранения - пока ваша задача. Скоро будет метод в цепочке валидаторов, он будет отвечать за приведениеВалидаторы:
-
min(len: number | (instance) => number) - число должно быть строго больше переданного значения
- greater(len: number | (instance) => number) - число должно быть больше или равно переданного значения
- max(len: number | (instance) => number) - число должно быть строго меньше переданныого значения
- less(len: number | (instance) => number) - число должно быть меньше или равно переданного значения
- integer() - число должно быть без знаков после запятой
- negative() - число должно быть отрицательным
- positive() - число должно быть положительным
- divideBy(arg: number | (instance) => number) - число делится на переданный аргумент$3
Вид объекта представлен выше в документации. У него есть дополнительный метод .isFullValid(ignoreFields: Array - вернет true, если все поля валидны. Исключает поля из списка ignoreFields. Они могут быть вложенными, например: document.number###Пример использования
import { MetaValidate, ReceiveValidity, Validity } from 'meta-validate';class Document implements ReceiveValidity {
validity$: BehaviorSubject = new BehaviorSubject(null);
@MetaValidate.Trigger().make()
docType: string = null;
@MetaValidate.String()
.with(['docType'])
.required().skipIf(instance => instance.docType === 'dumb')
.alphanum()
.custom('length', (value, instance) => instance.docType === 'pass_rf' ? !value || value.length !== 4 : !value || value.length === 0)
.make()
docNumber: string = null;
@MetaValidate.String()
.with(['docType'])
.required()
.minLength(2)
.maxLength(4)
.make()
docSeries: string = null;
@MetaValidate.String()
.skip(instance => instance.docType !== 'zagranpasport')
.length(9)
.make()
additionalDocumentNumber: string = null;
}
class Customer implements ReceiveValidity {
validity$: BehaviorSubject = new BehaviorSubject();
@MetaValidate.Nested().make()
document: Document = new Document();
@MetaValidate.String().required().make()
name: string = null;
}
Объект ошибок будет следующим:
customerErrors = {
errors: {
document: {
docNumber: {
required: true,
alphanum: true,
length: true
},
docSeried: {
required: true,
minLength: true,
maxLength: true
},
additionalDocumentNumber: {
length: true
}
}
name: {
required: true
}
}
}
Пользоваться следующим образом:
const customer = new Customer();
customer.validity$.subscribe((validity: Validity) => {
this.errors = validity.errors;
this.isFullValid = validity.isFullValid();
});