ixfx
    Preparing search index...

    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.

    Example: 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 Summary)

    Constructors

    constructor

    Properties

    gog store

    Accessors

    size

    Methods

    delete get getTrackedValue has ids initialValues last reset seen tracked trackedByAge valuesByAge

    Constructors

    constructor

    Properties

    gog

    gog: GetOrGenerate<string, T, V>

    store

    store: Map<string, T>

    Accessors

    size

    • get size(): number

      Number of named values being tracked

      Returns number

    Methods

    delete

    • delete(id: string): void

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

      Parameters

      • id: string

      Returns void

    get

    ProtectedgetTrackedValue

    • getTrackedValue(id: string, ...values: V[]): Promise<T>

      Creates or returns a TrackedValue instance for id.

      Parameters

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

      Returns Promise<T>

    has

    • has(id: string): boolean

      Returns true if id is stored

      Parameters

      • id: string

      Returns boolean

    ids

    • ids(): Generator<string, void, unknown>

      Enumerate ids

      Returns Generator<string, void, unknown>

    initialValues

    • initialValues(): Generator<undefined | V, void, unknown>

      Enumerate starting values

      Returns Generator<undefined | V, void, unknown>

    last

    • last(): Generator<undefined | V, void, unknown>

      Enumerate last received values

      Returns Generator<undefined | V, void, unknown>

      Example: Calculate centroid of latest-received values

      const pointers = pointTracker();
      const c = Points.centroid(...Array.from(pointers.lastPoints()));

    reset

    • reset(): void

      Remove all tracked values. Use delete to remove a single value by id.

      Returns void

    seen

    • seen(id: string, ...values: V[]): Promise<TResult>

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

      Parameters

      • id: string

        Id

      • ...values: V[]

        Values(s)

      Returns Promise<TResult>

      Information about start to last value

    tracked

    • tracked(): Generator<T, void, unknown>

      Enumerate tracked values

      Returns Generator<T, void, unknown>

    trackedByAge

    • trackedByAge(): Generator<T, void, unknown>

      Iterates TrackedValues ordered with oldest first

      Returns Generator<T, void, unknown>

    valuesByAge

    • valuesByAge(): Generator<undefined | V, 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>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods