Skip to content

API reference > @kontsedal/olas-core > Field

Field type ​

A reactive form field. Extends ReadSignal<T> for the current value, plus five signals for state (errors / isValid / isDirty / touched / isValidating) and four methods (set, reset, markTouched, revalidate). Created viacreateField(ctx, initial, { validators, validateOn }). Spec §8, §20.7.

Signature:

typescript
type Field<T> = ReadSignal<T> & {
  errors: ReadSignal<string[]>;
  isValid: ReadSignal<boolean>;
  isDirty: ReadSignal<boolean>;
  touched: ReadSignal<boolean>;
  isValidating: ReadSignal<boolean>;
  set(value: T): void;
  setAsInitial(value: T): void;
  reset(): void;
  markTouched(): void;
  revalidate(): Promise<boolean>;
  setErrors(errors: ReadonlyArray<string>): void;
  dispose(): void;
};

References: ReadSignal

Released under the MIT License.