GroupNode
Defined in: core/nodes/group-node.ts:77
GroupNode - узел для группы полей
Создаётся из FormSchema (дерево field-конфигов). Обычно строится через createForm
(M1: createForm({ model, schema })); валидация/behavior живут на слое модели
(validateFormModel, computeFrom/enableWhen/…), а не на ноде.
Example
const form = new GroupNode({
email: { valueSignal: model.$.email, component: Input },
password: { valueSignal: model.$.password, component: Input },
});
// Прямой доступ к полям через Proxy
const proxy = form.getProxy();
proxy.email.setValue('test@mail.com');
await proxy.validate();
console.log(proxy.valid.value);
Extends
FormNode<T>
Type Parameters
T
T
Accessors
fields
Get Signature
get fields(): Map<keyof T, FormNode<FormValue>>;
Defined in: core/nodes/group-node.ts:377
Получить Map всех полей формы (для совместимости)
Returns
Map<keyof T, FormNode<FormValue>>
Constructors
Constructor
new GroupNode<T>(schema): GroupNode<T>;
Defined in: core/nodes/group-node.ts:159
Создать GroupNode только со схемой формы (обратная совместимость)
Parameters
schema
FormSchema<T>
Returns
GroupNode<T>
Overrides
Constructor
new GroupNode<T>(config): GroupNode<T>;
Defined in: core/nodes/group-node.ts:164
Создать GroupNode с полной конфигурацией (form, behavior, validation)
Parameters
config
Returns
GroupNode<T>
Overrides
FormNode<T>.constructor
Methods
clearErrors()
clearErrors(): void;
Defined in: core/nodes/group-node.ts:361
Очистить все errors (form-level + field-level)
Returns
void
Overrides
disable()
disable(): void;
Defined in: core/nodes/form-node.ts:380
Отключить узел
Template Method: обновляет статус в базовом классе, вызывает hook для кастомной логики в наследниках
Отключенные узлы не проходят валидацию и не включаются в getValue()
Returns
void
Inherited from
dispose()
dispose(): void;
Defined in: core/nodes/group-node.ts:721
Очистить все ресурсы узла
Returns
void
Overrides
enable()
enable(): void;
Defined in: core/nodes/form-node.ts:391
Включить узел
Template Method: обновляет статус в базовом классе, вызывает hook для кастомной логики в наследниках
Returns
void
Inherited from
getAllFields()
getAllFields(): IterableIterator<FormNode<FormValue>>;
Defined in: core/nodes/group-node.ts:416
Получить все поля формы как итератор
Returns
IterableIterator<FormNode<FormValue>>
getErrors()
getErrors(options?): ValidationError[];
Defined in: core/nodes/form-node.ts:241
Получить ошибки валидации с фильтрацией
Позволяет фильтровать ошибки по различным критериям:
- По коду ошибки
- По сообщению (частичное совпадение)
- По параметрам
- Через кастомный предикат
Без параметров возвращает все ошибки (эквивалент errors.value)
Parameters
options?
Опции фильтрации ошибок
Returns
Отфильтрованный массив ошибок валидации
Example
// Все ошибки
const allErrors = form.getErrors();
// Ошибки с конкретным кодом
const requiredErrors = form.getErrors({ code: 'required' });
// Ошибки с несколькими кодами
const errors = form.getErrors({ code: ['required', 'email'] });
// Ошибки по сообщению
const passwordErrors = form.getErrors({ message: 'Password' });
// Ошибки по параметрам
const minLengthErrors = form.getErrors({
params: { minLength: 8 }
});
// Кастомная фильтрация
const customErrors = form.getErrors({
predicate: (err) => err.code.startsWith('custom_')
});
Inherited from
getField()
getField<K>(key): FormNode<T[K]> | undefined;
Defined in: core/nodes/group-node.ts:369
Получить поле по ключу
Type Parameters
K
K extends string | number | symbol
Parameters
key
K
Returns
FormNode<T[K]> | undefined
getFieldByPath()
getFieldByPath(path):
| FormNode<FormValue>
| undefined;
Defined in: core/nodes/group-node.ts:506
Получить вложенное поле по пути
Поддерживаемые форматы путей:
- Simple: "email" - получить поле верхнего уровня
- Nested: "address.city" - получить вложенное поле
- Array index: "items[0]" - получить элемент массива по индексу
- Combined: "items[0].name" - получить поле элемента массива
Parameters
path
string
Путь к полю
Returns
| FormNode<FormValue>
| undefined
FormNode если найдено, undefined если путь не существует
Example
const form = new GroupNode({
email: { value: '', component: Input },
address: {
city: { value: '', component: Input }
},
items: [{ name: { value: '', component: Input } }]
});
form.getFieldByPath('email'); // FieldNode
form.getFieldByPath('address.city'); // FieldNode
form.getFieldByPath('items[0]'); // GroupNode
form.getFieldByPath('items[0].name'); // FieldNode
form.getFieldByPath('invalid.path'); // undefined
getProxy()
getProxy(): FormProxy<T>;
Defined in: core/nodes/group-node.ts:405
Получить Proxy-инстанс для прямого доступа к полям
Proxy позволяет обращаться к полям формы напрямую через точечную нотацию:
- form.email вместо form.fields.get('email')
- form.address.city вместо form.fields.get('address').fields.get('city')
Используется в:
- BehaviorApplicator для доступа к полям в behavior functions
- ValidationApplicator для доступа к форме в tree validators
Returns
FormProxy<T>
Proxy-инстанс с типобезопасным доступом к полям или сама форма, если proxy не доступен
Example
const form = new GroupNode({
email: { value: '', component: Input },
name: { value: '', component: Input },
});
const proxy = form.getProxy();
console.log(proxy.email.value.value); // Прямой доступ к полю
getValue()
getValue(): T;
Defined in: core/nodes/group-node.ts:246
Получить значение узла (non-reactive) Использует .peek() для получения значения без создания зависимости
Returns
T
Overrides
linkFields()
linkFields<K1, K2>(
sourceKey,
targetKey,
transform?): () => void;
Defined in: core/nodes/group-node.ts:582
Связывает два поля: при изменении source автоматически обновляется target
Type Parameters
K1
K1 extends string | number | symbol
K2
K2 extends string | number | symbol
Parameters
sourceKey
K1
targetKey
K2
transform?
(value) => T[K2]
Returns
(): void;
Returns
void
markAsDirty()
markAsDirty(): void;
Defined in: core/nodes/form-node.ts:323
Отметить узел как dirty (значение изменено)
Template Method: обновляет signal в базовом классе, вызывает hook для кастомной логики в наследниках
Returns
void
Inherited from
markAsPristine()
markAsPristine(): void;
Defined in: core/nodes/form-node.ts:334
Отметить узел как pristine (значение не изменено)
Template Method: обновляет signal в базовом классе, вызывает hook для кастомной логики в наследниках
Returns
void
Inherited from
markAsTouched()
markAsTouched(): void;
Defined in: core/nodes/form-node.ts:301
Отметить узел как touched (пользователь взаимодействовал)
Template Method: обновляет signal в базовом классе, вызывает hook для кастомной логики в наследниках
Returns
void
Inherited from
markAsUntouched()
markAsUntouched(): void;
Defined in: core/nodes/form-node.ts:312
Отметить узел как untouched
Template Method: обновляет signal в базовом классе, вызывает hook для кастомной логики в наследниках
Returns
void
Inherited from
onDisable()
protected onDisable(): void;
Defined in: core/nodes/group-node.ts:677
Hook: вызывается после disable()
Returns
void
Overrides
onEnable()
protected onEnable(): void;
Defined in: core/nodes/group-node.ts:685
Hook: вызывается после enable()
Returns
void
Overrides
onMarkAsDirty()
protected onMarkAsDirty(): void;
Defined in: core/nodes/group-node.ts:432
Hook: вызывается после markAsDirty()
Переопределите в наследниках для дополнительной логики:
- GroupNode: может обновить родительскую форму
- ArrayNode: может обновить родительскую форму
- FieldNode: пустая реализация
Returns
void
Overrides
onMarkAsPristine()
protected onMarkAsPristine(): void;
Defined in: core/nodes/group-node.ts:436
Hook: вызывается после markAsPristine()
Переопределите в наследниках для дополнительной логики:
- GroupNode: пометить все дочерние узлы как pristine
- ArrayNode: пометить все элементы массива как pristine
- FieldNode: пустая реализация
Returns
void
Overrides
onMarkAsTouched()
protected onMarkAsTouched(): void;
Defined in: core/nodes/group-node.ts:424
Hook: вызывается после markAsTouched()
Переопределите в наследниках для дополнительной логики:
- GroupNode: пометить все дочерние узлы как touched
- ArrayNode: пометить все элементы массива как touched
- FieldNode: пустая реализация (нет дочерних узлов)
Returns
void
Example
// GroupNode
protected onMarkAsTouched(): void {
this.fields.forEach(field => field.markAsTouched());
}
Overrides
onMarkAsUntouched()
protected onMarkAsUntouched(): void;
Defined in: core/nodes/group-node.ts:428
Hook: вызывается после markAsUntouched()
Переопределите в наследниках для дополнительной логики:
- GroupNode: пометить все дочерние узлы как untouched
- ArrayNode: пометить все элементы массива как untouched
- FieldNode: пустая реализация (нет дочерних узлов)
Returns
void
Overrides
patchValue()
patchValue(value): void;
Defined in: core/nodes/group-node.ts:270
Частично обновить значение узла Для FieldNode: работает как setValue Для GroupNode: обновляет только указанные поля Для ArrayNode: обновляет только указанные элементы
Parameters
value
Partial<T>
частичное значение для обновления
Returns
void
Overrides
reset()
reset(value?): void;
Defined in: core/nodes/group-node.ts:306
Сбросить форму к указанным значениям (или к initialValues)
Parameters
value?
T
опциональный объект со значениями для сброса
Returns
void
Remarks
Рекурсивно вызывает reset() для всех полей формы
Example
// Сброс к initialValues
form.reset();
// Сброс к новым значениям
form.reset({ email: 'new@mail.com', password: '' });
Overrides
resetToInitial()
resetToInitial(): void;
Defined in: core/nodes/group-node.ts:320
Сбросить форму к исходным значениям (initialValues)
Returns
void
setErrors()
setErrors(errors): void;
Defined in: core/nodes/group-node.ts:354
Установить form-level validation errors
Parameters
errors
Returns
void
Overrides
setValue()
setValue(value, options?): void;
Defined in: core/nodes/group-node.ts:255
Установить значение узла
Parameters
value
T
новое значение
options?
опции установки значения
Returns
void
Overrides
submit()
submit<R>(onSubmit, options?): Promise<R | null>;
Defined in: core/nodes/group-node.ts:456
Отправить форму
Type Parameters
R
R
Parameters
onSubmit
(values) => R | Promise<R>
Callback для отправки данных
options?
Опции submit (skipValidation, skipTouch)
Returns
Promise<R | null>
Результат от onSubmit или null если валидация не пройдена
Remarks
null перегружен: он означает и «валидация не пройдена», и легитимный null-результат
onSubmit (или void-обработчик). Если вызывающей стороне нужно различать эти случаи —
используйте submitWithResult, который возвращает явный флаг success.
submitWithResult()
submitWithResult<R>(onSubmit, options?): Promise<SubmitResult<R>>;
Defined in: core/nodes/group-node.ts:470
Отправить форму с расширенным результатом
Type Parameters
R
R
Parameters
onSubmit
(values) => R | Promise<R>
Callback для отправки данных
options?
Опции submit
Returns
Promise<SubmitResult<R>>
Объект SubmitResult с данными, статусом и возможной ошибкой
touchAll()
touchAll(): void;
Defined in: core/nodes/form-node.ts:364
Пометить все поля (включая вложенные) как touched Алиас для markAsTouched(), но более явно показывает намерение пометить ВСЕ поля рекурсивно
Полезно для:
- Показа всех ошибок валидации перед submit
- Принудительного отображения ошибок при нажатии "Validate All"
- Отображения невалидных полей в wizard/step form
Returns
void
Example
// Показать все ошибки перед submit
form.touchAll();
const isValid = await form.validate();
if (!isValid) {
// Все ошибки теперь видны пользователю
}
// Или использовать submit() который уже вызывает touchAll
await form.submit(async (values) => {
await api.save(values);
});
Inherited from
validate()
validate(): Promise<boolean>;
Defined in: core/nodes/group-node.ts:331
Запустить валидацию узла
Returns
Promise<boolean>
Promise<boolean> - true если валидация успешна
Overrides
watchField()
watchField<K>(fieldPath, callback): () => void;
Defined in: core/nodes/group-node.ts:635
Подписка на top-level поле — value типизирован как T[K].
Type Parameters
K
K extends string
Parameters
fieldPath
K
callback
(value) => void | Promise<void>
Returns
(): void;
Returns
void
watchFieldByPath()
watchFieldByPath(path, callback): () => void;
Defined in: core/nodes/group-node.ts:659
Подписка на вложенное поле по строковому пути ("address.city").
Путь нельзя выразить в типах узла → value честно unknown, потребитель сужает.
Parameters
path
string
callback
(value) => void | Promise<void>
Returns
(): void;
Returns
void
Properties
_dirty
protected _dirty: Signal<boolean>;
Defined in: core/nodes/form-node.ts:66
Значение узла было изменено (dirty) Protected: наследники могут читать/изменять через методы
Inherited from
_status
protected _status: Signal<FieldStatus>;
Defined in: core/nodes/form-node.ts:72
Текущий статус узла Protected: наследники могут читать/изменять через методы
Inherited from
_touched
protected _touched: Signal<boolean>;
Defined in: core/nodes/form-node.ts:60
Пользователь взаимодействовал с узлом (touched) Protected: наследники могут читать/изменять через методы
Inherited from
dirty
readonly dirty: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:146
Значение узла было изменено (dirty) Computed из _dirty для предоставления readonly интерфейса
Overrides
disabled
readonly disabled: ReadonlySignal<boolean>;
Defined in: core/nodes/form-node.ts:109
Узел отключен (disabled)
Inherited from
enabled
readonly enabled: ReadonlySignal<boolean>;
Defined in: core/nodes/form-node.ts:114
Узел включен (enabled)
Inherited from
errors
readonly errors: ReadonlySignal<ValidationError[]>;
Defined in: core/nodes/group-node.ts:148
Массив ошибок валидации
Overrides
id
id: `${string}-${string}-${string}-${string}-${string}`;
Defined in: core/nodes/group-node.ts:81
invalid
readonly invalid: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:144
Узел невалиден (есть ошибки валидации)
Overrides
pending
readonly pending: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:147
Выполняется асинхронная валидация
Overrides
pristine
readonly pristine: ReadonlySignal<boolean>;
Defined in: core/nodes/form-node.ts:98
Значение узла не было изменено (pristine)
Inherited from
status
readonly status: ReadonlySignal<FieldStatus>;
Defined in: core/nodes/group-node.ts:149
Текущий статус узла Computed из _status для предоставления readonly интерфейса
Overrides
submitting
readonly submitting: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:150
touched
readonly touched: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:145
Пользователь взаимодействовал с узлом (touched) Computed из _touched для предоставления readonly интерфейса
Overrides
untouched
readonly untouched: ReadonlySignal<boolean>;
Defined in: core/nodes/form-node.ts:87
Пользователь не взаимодействовал с узлом (untouched)
Inherited from
valid
readonly valid: ReadonlySignal<boolean>;
Defined in: core/nodes/group-node.ts:143
Узел валиден (все валидаторы прошли успешно)
Overrides
value
readonly value: ReadonlySignal<T>;
Defined in: core/nodes/group-node.ts:142
Текущее значение узла
- Для FieldNode: значение поля
- Для GroupNode: объект со значениями всех полей
- Для ArrayNode: массив значений элементов