Interface AeMember<TValue, TClass, TUpdate>

An amended entity representing a class instance member (property) to amend.

Used by amendments to modify the member definition. I.e. its property descriptor.

Type Parameters

  • TValue extends TUpdate

    Amended member value type.

  • TClass extends AmendableClass = Class

    A type of amended class.

  • TUpdate = TValue

    Amended member update type accepted by its setter.

Hierarchy

Constructors

constructor

Properties

amendedClass configurable enumerable key readable writable

Methods

get set

Constructors

constructor

constructor

Properties

Readonly amendedClass

amendedClass: TClass

Amended class constructor.

Readonly configurable

configurable: boolean

Whether the member is configurable.

Readonly enumerable

enumerable: boolean

Whether the member is enumerable.

Readonly key

key: string | symbol

A key of the instance member.

Updates to this property are always ignored. The member key can not be changed.

Readonly readable

readable: boolean

Whether the member is writable.

Updates to this property are always ignored.

Set to true when get property assigned. Set to false when set property assigned, while the get one is not. Remains unchanged when neither get, nor set properties assigned.

Readonly writable

writable: boolean

Whether the member is writable.

Updates to this property are always ignored.

Set to true when set property assigned. Set to false when get property assigned, while the set one is not. Remains unchanged when neither get, nor set properties assigned.

Methods

get

  • Reads the value of this member in the target instance.

    Throws if the member is not readable.

    Parameters

    • this: void
    • instance: InstanceType<TClass>

      Target instance.

    Returns TValue

    Member value.

set

  • Assigns the value of this member in the target instance.

    Throw is the member is not writable.

    Parameters

    • this: void
    • instance: InstanceType<TClass>

      Target instance.

    • update: TUpdate

      Updated member value.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc