Interface FieldDefinition<T, V>

Domain accessors, validation and renderer selection for one registered field.

interface FieldDefinition<T, V = unknown> {
    enabledWhen?: FieldPredicate<T>;
    equals?: (a: V, b: V) => boolean;
    id: string;
    label?: MessageLike;
    path: FieldPath;
    presentation?: Readonly<Record<string, unknown>>;
    read: (entity: T) => V;
    readOnlyWhen?: FieldPredicate<T>;
    renderer: string;
    validators?: readonly FieldValidator<T, V>[];
    visibleWhen?: FieldPredicate<T>;
    write: (entity: T, value: V) => T;
}

Type Parameters

T
V = unknown

Index

Properties

enabledWhen? equals? id label? path presentation? read readOnlyWhen? renderer validators? visibleWhen? write

Properties

`Optional` `Readonly`enabledWhen

enabledWhen?: FieldPredicate<T>

`Optional` `Readonly`equals

equals?: (a: V, b: V) => boolean

`Readonly`id

id: string

`Optional` `Readonly`label

label?: MessageLike

`Readonly`path

path: FieldPath

`Optional` `Readonly`presentation

presentation?: Readonly<Record<string, unknown>>

`Readonly`read

read: (entity: T) => V

`Optional` `Readonly`readOnlyWhen

readOnlyWhen?: FieldPredicate<T>

`Readonly`renderer

renderer: string

`Optional` `Readonly`validators

validators?: readonly FieldValidator<T, V>[]

`Optional` `Readonly`visibleWhen

visibleWhen?: FieldPredicate<T>

`Readonly`write

write: (entity: T, value: V) => T