Interface Applied<TValue, TInstance, TConvertedInstance>

An input aspect applied to control.

This is what returned from InAspect.applyTo() method. Contains aspect instance and its manipulation methods.

Type Parameters

  • TValue

    Input value type.

  • TInstance

    Aspect instance type.

  • TConvertedInstance extends TInstance = TInstance

    A type of aspect instance applied to converted control. The same as Instance by default.

Hierarchy

  • Applied

Properties

Methods

Properties

instance: TInstance

Input aspect instance.

Methods

  • Converts an aspect to the same value type.

    When defined, this method is called instead of convertTo when converting aspect for converted control with the same value. I.e. when aspect-only converters used for conversion.

    Parameters

    • target: InControl<TValue>

      Target input control.

    Returns undefined | Applied<TValue, TInstance, TInstance>

    The same aspect applied to target control, or undefined if aspect can not be converted.

  • Converts an aspect to another value type.

    This method is called by input control created by convert method.

    Type Parameters

    • TTargetValue

      Converted input value type.

    Parameters

    • target: InControl<TTargetValue>

      Target input control.

    Returns undefined | Applied<TTargetValue, TConvertedInstance, TConvertedInstance>

    The same aspect applied to target control, or undefined if aspect can not be converted.

Generated using TypeDoc