Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Event<V>

An event in a time series.

Two instances are equal if and only if they have identical attributes. Typically, two Event instances that have the same sequence number will be equal, but this may not be true if the event has changed on the server – see Changes to a time series made outside the API in the TimeSeries documentation.

Type parameters

  • V

Hierarchy

Implemented by

Index

Properties

author

author: string

Server-authenticated identity of the session that created the event.

If the session that created the event was not authenticated, the author will be an empty string.

isEditEvent

isEditEvent: boolean

Flag indicating whether this is an edit event.

x.isEditEvent is equivalent to x.originalEvent != x.

originalEvent

originalEvent: EventMetadata

If this is an edit event, returns the metadata of the original event that this event replaces; otherwise returns this event.

The result is always the metadata of an original event, never that of an edit event.

sequence

sequence: number

Sequence number identifying this event within its time series. Assigned by the server when the event is created.

Sequence numbers are unique within a time series. Each event appended to a time series is assigned a sequence number that is is equal to the sequence number of the preceding event plus one.

timestamp

timestamp: number

Event timestamp. Assigned by the server when the event is created.

Events do not have unique timestamps. Events with different sequence numbers may have the same timestamp.

Subsequent events in a time series usually have timestamps that are greater or equal to the timestamps of earlier events, but this is not guaranteed due to changes to the time source used by the server.

Timestamps represent the difference, measured in milliseconds, between the time the server added the event to the time series and midnight, January 1, 1970 UTC

value

value: V

The value associated with the event.

Methods

equals

  • equals(other: any): boolean
  • Check if the EventMetadata is equal to another object

    Parameters

    • other: any

    Returns boolean

    true if the two objects are equal