Interface: FieldGroupHelper#

Defined in: FieldGroup/fieldGroupTypes.public.ts:259

Declares the virtual fields in a reusable field group and how their value types may bind to concrete form fields.

Example#

const profileFields = defineFieldGroup(({ strict, loose }) => ({
  name: strict(''),
  status: loose<string>(),
}))

Properties#

loose#

loose: {
<TValue>  (value): LooseFieldGroupFieldSlot<TValue>;
<TValue>  (): LooseFieldGroupFieldSlot<TValue>;
};

Defined in: FieldGroup/fieldGroupTypes.public.ts:298

Declares a virtual field that can bind to form fields whose value type is assignable to the declared type.

Call Signature#

<TValue>(value): LooseFieldGroupFieldSlot<TValue>;

Type Parameters#

TValue#

TValue

Inferred from the representative value.

Parameters#

value#

TValue

A representative value used only for type inference.

Returns#

LooseFieldGroupFieldSlot<TValue>

A field slot that uses assignable value-type matching.

Call Signature#

<TValue>(): LooseFieldGroupFieldSlot<TValue>;

Type Parameters#

TValue#

TValue

The value type that compatible concrete field values must be assignable to.

Returns#

LooseFieldGroupFieldSlot<TValue>

A field slot that uses assignable value-type matching.

Example#

const passwordFieldGroup = defineFieldGroup(({ loose }) => ({
  password: loose<string>(),
  confirmPassword: loose<string>(),
}))

strict#

strict: {
<TValue>  (value): StrictFieldGroupFieldSlot<TValue>;
<TValue>  (): StrictFieldGroupFieldSlot<TValue>;
};

Defined in: FieldGroup/fieldGroupTypes.public.ts:272

Declares a virtual field whose value type must exactly match the value type of the concrete form field it binds to.

Call Signature#

<TValue>(value): StrictFieldGroupFieldSlot<TValue>;

Type Parameters#

TValue#

TValue

Inferred from the representative value.

Parameters#

value#

TValue

A representative value used only for type inference.

Returns#

StrictFieldGroupFieldSlot<TValue>

A field slot that uses strict value-type matching.

Call Signature#

<TValue>(): StrictFieldGroupFieldSlot<TValue>;

Type Parameters#

TValue#

TValue

The value type the concrete form field must match exactly.

Returns#

StrictFieldGroupFieldSlot<TValue>

A field slot that uses strict value-type matching.

Example#

const passwordFieldGroup = defineFieldGroup(({ strict }) => ({
  password: strict<string>(),
  confirmPassword: strict<string>(),
}))