Skip to main content

ValidatorApi

Common node API exposed to validators when no exact owner API is specified.

Import​

import type { ValidatorApi } from '@ngblocks/form-nodes';

When to use it​

Use for the generic node API available inside synchronous validator contexts. Supply a more specific owner through the validator's generics only when the consuming contract guarantees it.

Declaration​

type ValidatorApi<TValue> = AsyncValidatorState & {
    readonly form: Signal<ValidatorForm | null>;
    readonly root: Signal<ValidatorNode>;
    readonly parent: Signal<ValidatorForm | ValidatorGroup | ArrayNode<DynamicNode> | null>;
    readonly path: Signal<readonly string[]>;
    readonly value: Signal<TValue>;
    readonly errors: NodeErrorsSignal;
    readonly allErrors: Signal<readonly ValidationError[]>;
    readonly valid: Signal<boolean>;
    readonly invalid: Signal<boolean>;
    readonly pending: Signal<boolean>;
    readonly debouncing: Signal<boolean>;
    readonly validationStatus: Signal<ValidationStatus>;
    getError<TKind extends keyof ValidationErrorMap | (string & {})>(kind: TKind): ValidationErrorForKind<TKind> | undefined;
    set(value: TValue): void;
    update(updater: (value: TValue) => TValue): void;
    flush(): void;
    reset(...args: [
    ] | [
        value: TValue
    ]): void;
    markAsTouched(options?: {
        skipDescendants?: boolean;
    }): void;
    markAsUntouched(): void;
    markAsDirty(): void;
    markAsPristine(): void;
    disable(message?: string): void;
    enable(): void;
    markAsReadonly(): void;
    markAsWritable(): void;
    hide(): void;
    show(): void;
};

Type parameters​

ParameterConstraintDefault
TValueUnconstrainedRequired

Declared members​

The declaration above also includes inherited contracts and overloads where applicable.

MemberMeaning
formNearest explicit form workflow, or null when none owns the validated node. Exposes the complete form API directly; unknown child keys are available through get().
rootComplete structural root, including a standalone field. Common node members are available directly; narrow the node kind before using primitive-specific operations.
parentImmediate form, group, or array parent, or null for a standalone node. Common node members are available directly. A field can never be a parent.
pathProperty names and array indexes locating the node from its root.
valueCurrent exposed value of the validated node, after configured equality. Signal reads participate in validation dependency tracking.
errorsOwn validation errors by default; pass { descendants: true } to include descendants.
allErrorsErrors owned by this node and every descendant.
validWhether this node and its descendants have no active errors or unresolved validation.
invalidWhether this node or a descendant currently contributes an error. False while unknown.
pendingWhether asynchronous validation is running on this node or a descendant.
debouncingWhether a control-originated value is waiting to be committed on this node or a descendant. This is separate from the debounce option of an asynchronous validator.
validationStatusCurrent aggregate result: valid, invalid, or unknown while validation is unresolved.
getErrorReturns this node's first direct error with kind, or undefined when none exists. Suggests registered error kinds while accepting any custom string.
setReplaces the node's committed value and triggers the corresponding state and validation updates.
updateReplaces the value with the result of applying updater to its current exposed value.
flushCommits any buffered control value immediately and runs validation that was waiting for it.
resetClears interaction state; preserves the current value unless a replacement is provided.
markAsTouchedMarks this node and, unless skipped, its interactive descendants as touched and commits their pending control values for every debounce strategy.
markAsUntouchedClears this node's own touched marker without changing descendant markers or values. An interactive touched descendant can keep an aggregate touched() true. Use reset() to clear interaction state throughout the subtree.
markAsDirtyMarks this node as dirty without changing its value.
markAsPristineClears stored dirty state without changing the current value.
disableAdds an imperative disabled reason and suppresses this node's own validation. Values remain readable, writable programmatically, and present in parent aggregates.
enableClears local disabled state, including a static initial disabled option. Continuing reactive conditions and inherited reasons remain effective, so enabled() may stay false.
markAsReadonlyAdds the imperative readonly state, making readonly() true.
markAsWritableClears local readonly state, including a static initial readonly option. Reactive conditions and ancestor readonly state can still prevent the node from becoming writable.
hideAdds the imperative hidden state, making visible() false.
showClears local hidden state, including a static initial hidden option. Reactive conditions and ancestor hidden state can still keep the node hidden.
Last updated on