Skip to main content

FormFactory

The form factory returned by createFormPrimitives().

Import​

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

When to use it​

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

Declaration​

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

Type parameters​

ParameterConstraintDefault
TNullableboolean | undefinedRequired
Last updated on