Class TrackedValueMap<V, T, TResult>

Keeps track of keyed values of type V (eg Point). It stores occurences in type T, which must extend from TrackerBase<V>, eg PointTracker.

The creator function passed in to the constructor is responsible for instantiating the appropriate TrackerBase sub-class.

export class TrackedPointMap extends TrackedValueMap<Points.Point> {
constructor(opts:TrackOpts = {}) {
super((key, start) => {
if (start === undefined) throw new Error(`Requires start point`);
const p = new PointTracker(key, opts);
p.seen(start);
return p;
});
}
}

Type Parameters

Hierarchy (view full)

Constructors

Properties

gog: GetOrGenerate<string, T, V>
store: Map<string, T>

Accessors

  • get size(): number
  • Number of named values being tracked

    Returns number

Methods

  • Remove a tracked value by id. Use reset to clear them all.

    Parameters

    • id: string

    Returns void

  • Creates or returns a TrackedValue instance for id.

    Parameters

    • id: string
    • Rest...values: V[]

    Returns Promise<T>

  • Returns true if id is stored

    Parameters

    • id: string

    Returns boolean

  • Enumerate ids

    Returns Generator<string, void, undefined>

  • Enumerate starting values

    Returns Generator<undefined | V, void, unknown>

  • Enumerate last received values

    Returns Generator<undefined | V, void, unknown>

    const pointers = pointTracker();
    const c = Points.centroid(...Array.from(pointers.lastPoints()));
  • Remove all tracked values. Use delete to remove a single value by id.

    Returns void

  • For a given id, note that we have seen one or more values.

    Parameters

    • id: string

      Id

    • Rest...values: V[]

      Values(s)

    Returns Promise<TResult>

    Information about start to last value

  • Enumerate tracked values

    Returns Generator<T, void, undefined>

  • Iterates TrackedValues ordered with oldest first

    Returns Generator<T, void, unknown>

  • Iterates underlying values, ordered by age (oldest first) First the named values are sorted by their elapsed value, and then we return the last value for that group.

    Returns Generator<undefined | V, void, unknown>