Variable FormScope

Type declaration

• createSetup:function

  • createSetup<TControl, TValue>(this: void, scope: FormScope, setup: ((this: void, control: TControl) => SupplyPeer), defaultRole?: string): ((this: void, control: TControl) => Supply)

  • Creates an input control setup procedure applied to the given 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

    • TControl extends InControl<TValue, TControl>

      Input control type.

    • TValue = ValueType<TControl>

      Input value type.

    Parameters

    • this: void

    • scope: FormScope

      Setup applicability scope.

    • setup: ((this: void, control: TControl) => SupplyPeer)

      A setup procedure to apply. Accepts target control instance as parameter and returns a setup supply peer. The setup should be reverted once this peer's supply cut off.

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

        • Parameters

          • this: void

          • control: TControl

          Returns SupplyPeer

    • defaultRole: string = 'default'

      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 applied to the given 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