Interface AeComponentMember<TValue, TClass, TUpdate>

An amended entity representing a component member to amend.

Type Parameters

  • TValue extends TUpdate

    Amended member value type.

  • TClass extends ComponentClass = Class

    Amended component class type.

  • TUpdate = TValue

    Amended member update type accepted by its setter.

Hierarchy

  • AeComponent<TClass>
  • AeMember<TValue, TClass, TUpdate>
    • AeComponentMember

Properties

amendedClass componentDef configurable enumerable featureDef key readable writable

Methods

get set

Properties

Readonly amendedClass

amendedClass: TClass

Amended class constructor.

Readonly componentDef

componentDef: ComponentDef<any>

Amended component definition.

Readonly configurable

configurable: boolean

Whether the member is configurable.

Readonly enumerable

enumerable: boolean

Whether the member is enumerable.

Readonly featureDef

featureDef: FeatureDef

Amended feature definition options.

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.

    Returns

    Member value.

    Parameters

    • this: void
    • instance: InstanceType<TClass>

      Target instance.

    Returns TValue

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

Generated using TypeDoc