Convergence JavaScript Client API Documentation 1.0.0-rc.12
Dev Guide
Options
Menu

Class ReferenceSetEvent<T>

Emitted when a ModelReference's value is set.

Type parameters

  • T

Hierarchy

  • ReferenceSetEvent

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

addedValues

addedValues: T[]

All newly-added values. That is, values that were not in the set of old values.

name

name: string = ReferenceSetEvent.NAME

The name of the event that was fired. This is commonly used to filter when using the ConvergenceEventEmitter.events stream.

Note that the name is only guaranteed to be unique within the class / subsystem that is firing it. Names might be reused across classes and subsystems.

oldValue

oldValue: T

The first (if there were multiple) previous value of the reference.

oldValues

oldValues: T[]

The previous values of the reference.

removedValues

removedValues: T[]

All just-removed values. That is, old values not in the set of new values.

src

src: ModelReference<any>

The underlying reference that changed.

synthetic

synthetic: boolean

true if this event was emitted by the system, as opposed to an explicit e.g. LocalModelReference.set.

NAME

NAME: "set" = "set"