Variable ScopedFormConfig

Type declaration

• createSetup:function

  • createSetup<TOptions, TControl, TValue>(config: ScopedFormConfig<TOptions>, createSetup: ((this: void, options?: TOptions) => ((this: void, control: TControl) => SupplyPeer)), defaultRole?: string): ((this: void, control: TControl) => Supply)

  • Creates an input control setup procedure that applies the given configuration to appropriate scope.

    Returns

    A setup procedure accepting target control as parameter and returning a setup supply. The setup is reverted once this supply cut off.

    Type Parameters

    • TOptions

      A type of setup options.

    • TControl extends InControl<TValue, TControl>

      Input control type.

    • TValue = ValueType<TControl>

      Input value type.

    Parameters

    • config: ScopedFormConfig<TOptions>

      Scoped form setup configuration.

    • createSetup: ((this: void, options?: TOptions) => ((this: void, control: TControl) => SupplyPeer))

      A function accepting setup options and returning a procedure that sets up the given control with these options. The setup procedure returns a setup supply peer. The setup should be reverted once this peer's supply cut off.

      • • (this: void, options?: TOptions): ((this: void, control: TControl) => SupplyPeer)

        • Parameters

          • this: void

          • Optional options: TOptions

          Returns ((this: void, control: TControl) => SupplyPeer)

          • • (this: void, control: TControl): SupplyPeer

            • Parameters

              • this: void

              • control: TControl

              Returns SupplyPeer

    • Optional defaultRole: string

      A role name to apply by default. 'default' when omitted.

    Returns ((this: void, control: TControl) => Supply)

    • • (this: void, control: TControl): Supply

      • Creates an input control setup procedure that applies the given configuration to appropriate scope.

        Returns

        A setup procedure accepting target control as parameter and returning a setup supply. The setup is reverted once this supply cut off.

        Parameters

        • this: void

        • control: TControl

        Returns Supply