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

Class ReferenceClearedEvent<T>

Emitted when a ModelReference's value is explicitly cleared.

Type parameters

  • T

Hierarchy

  • ReferenceClearedEvent

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

name

name: string = ReferenceClearedEvent.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 previous value (if there were multiple) of the reference.

oldValues

oldValues: T[]

The previous values of the reference.

src

src: ModelReference<any>

The underlying reference that was cleared.

NAME

NAME: "cleared" = "cleared"