Class IntervalTracker

Readonlyid

max

min

timestamps

total

values

avg

• get avg(): number

• Returns number

elapsed

• get elapsed(): number

• Returns the elapsed time, in milliseconds since the instance was created

  Returns number

initial

• get initial(): undefined | V

• Returns the initial value, or undefined

  Returns undefined | V

last

• get last(): undefined | V

• Returns undefined | V

size

• get size(): number

• Returns number of recorded values (this can include the initial value)

  Returns number

difference

• difference(): undefined | number

• Difference between last value and initial. Eg. if last value was 10 and initial value was 5, 5 is returned (10 - 5) If either of those is missing, undefined is returned

  Returns undefined | number

filterData

• filterData(rawValues): TimestampedPrimitive<number>[]

• Tracks a value

  Parameters

  • rawValues: number[]

  Returns TimestampedPrimitive<number>[]

getMinMaxAvg

• getMinMaxAvg(): {
      avg: number;
      max: number;
      min: number;
  }

• Returns {
      avg: number;
      max: number;
      min: number;
  }

  • avg: number

  • max: number

  • min: number

onReset

• onReset(): void

• Returns void

onTrimmed

• onTrimmed(reason): void

• When trimmed, recomputes to set total/min/max to be based on current values.

  Parameters

  • reason: TrimReason

  Returns void

relativeDifference

• relativeDifference(): undefined | number

• Relative difference between last value and initial. Eg if last value was 10 and initial value was 5, 2 is returned (200%)

  Returns undefined | number

reset

• reset(): void

• Reset tracker

  Returns void

seen

• seen(...p): NumberTrackerResults

• Adds a value, returning computed result.

  At this point, we check if the buffer is larger than resetAfterSamples. If so, reset() is called. If not, we check sampleLimit. If the buffer is twice as large as sample limit, trimStore() is called to take it down to sample limit, and onTrimmed() is called.

  Parameters

  • Rest...p: number[]

  Returns NumberTrackerResults

trimStore

• trimStore(limit): number

• Reduces size of value store to limit. Returns number of remaining items

  Parameters

  • limit: number

  Returns number