Options
Menu

Class ArrayInsertEvent

Emitted when a value is inserted into a RealTimeArray. This could be from a RealTimeArray.insert, RealTimeArray.push, RealTimeArray.unshift, or some other method.

Hierarchy

  • ArrayInsertEvent

Implements

Index

Properties

element

The RealTimeArray or HistoricalArray which was modified

index

index: number

The index at which the new value was inserted

local

local: boolean

name

name: string = ArrayInsertEvent.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.

sessionId

sessionId: string

The sessionId corresponding to the session that performed the modification

user

The user which performed the modification

value

value: ObservableElement<any>

A read-only representation of the value that was just inserted

StaticNAME

NAME: "insert" = "insert"