Skip to main content

GroupFactory

The group factory returned by createFormPrimitives().

Import​

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

When to use it​

Use when passing the configured group factory from createFormPrimitives() to reusable declaration helpers.

Declaration​

interface GroupFactory<TNullable extends boolean | undefined> {
    (): ConfiguredGroup<{}, TNullable>;
    <TDefinitions extends ObjectNodeDefinitions>(definitions: TDefinitions & ObjectNodeDefinitionInputs<TDefinitions>, ...args: [
        validatorsOrOptions?: NoInfer<ValidatorSource<FormValue<NormalizedNodesWithDefault<TDefinitions, TNullable>>, GroupNode<NormalizedNodesWithDefault<TDefinitions, TNullable>>>> | NoInfer<GroupOptions<FormValue<NormalizedNodesWithDefault<TDefinitions, TNullable>>, GroupNode<NormalizedNodesWithDefault<TDefinitions, TNullable>>>>
    ] | [
        validators: NoInfer<ValidatorSource<FormValue<NormalizedNodesWithDefault<TDefinitions, TNullable>>, GroupNode<NormalizedNodesWithDefault<TDefinitions, TNullable>>>> | undefined,
        options: NoInfer<GroupOptions<FormValue<NormalizedNodesWithDefault<TDefinitions, TNullable>>, GroupNode<NormalizedNodesWithDefault<TDefinitions, TNullable>>>> | undefined
    ]): ConfiguredGroup<TDefinitions, TNullable>;
}

Type parameters​

ParameterConstraintDefault
TNullableboolean | undefinedRequired
Last updated on