Interface Core<TAmended>

A core API of amendment target.

Every amendment target implements it. The rest of the target consists of amended entity properties.

Type Parameters

  • TAmended extends object

    Amended entity type.

Hierarchy

  • Core

Methods

Methods

  • Amends the target.

    The returned function can be called to construct the modified amendment target. The latter can be used to chain amendments.

    This method does not require this context. Thus it can be extracted from amendment target e.g. by destructuring the latter.

    Type Parameters

    • TExt extends object = AeNone

      A type of amended entity extension.

    Parameters

    • this: void
    • Optional request: AmendRequest<TAmended, TExt>

      Amendment request. Also serves as modification or extension of this amendment target.

    Returns ((this) => AmendTarget<TAmended & TExt>)

    A function without arguments returning modified amendment target.

      • (this): AmendTarget<TAmended & TExt>
      • Amends the target.

        The returned function can be called to construct the modified amendment target. The latter can be used to chain amendments.

        This method does not require this context. Thus it can be extracted from amendment target e.g. by destructuring the latter.

        Parameters

        • this: void

        Returns AmendTarget<TAmended & TExt>

        A function without arguments returning modified amendment target.

Generated using TypeDoc