Interface AeSharedField<TField, TFieldValue, TClass>

An amended entity representing a component member containing a shared field to amend.

Type Parameters

  • TField extends Field<TFieldValue>

    Field type.

  • TFieldValue = Field.ValueType<TField>

    Field value type.

  • TClass extends ComponentClass = Class

    Amended component class type.

Hierarchy

Properties

amendedClass componentDef configurable enumerable featureDef key localShare locateForm name readable share writable

Methods

get getShared 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 localShare

localShare: boolean

Whether the share is local.

  • true to make the value available only locally, i.e. only when requested by sharer context.
  • false to make the value available to nested components too.

Readonly locateForm

locateForm: Fn<FormUnit<any, FormUnit.Controls<any>, any>>

Predefined locator function of the form unit to add the shared field to.

Readonly name

name: null | string

Predefined field name, or null/undefined when the field is not to be added to the form.

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 share

share: Share<TField>

Target field share instance.

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 undefined | TField

getShared

  • Reads value shared by target component.

    This method is not amendable.

    Returns

    An AfterEvent keeper of shared value.

    Parameters

    • this: void
    • component: InstanceType<TClass>

      Sharer component instance.

    Returns AfterEvent<[TField?]>

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: undefined | TField

      Updated member value.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc