@stephen-shopopop/node-metrics
    Preparing search index...

    A generic builder class for managing and storing metric values.

    The StoreBuilder class provides a type-safe way to set, get, and serialize data. It uses a generic type parameter T to define the shape of the store object.

    import assert from 'node:assert';

    const metrics = new StoreBuilder();
    metrics.set('heapUsed', 12);
    assert.equal(metrics.get('heapUsed'), 12);
    assert.deepStrictEqual(metrics.toJson(), { heapUsed: 12 });

    Type Parameters

    • T extends object = { [key: string | number | symbol]: unknown }
    Index

    Constructors

    Methods

    Constructors

    • Type Parameters

      • T extends object = { [key: string | number | symbol]: unknown }

      Returns StoreBuilder<T>

    Methods

    • Get store value

      Example

      import assert from 'node:assert';

      const metrics = new StoreBuilder();
      metrics.set('heapUsed', 12);

      assert.equal(metrics.get('heapUsed'), 12 );

      Type Parameters

      • E extends string | number | symbol

      Parameters

      • key: E

      Returns undefined | T[E]

    • Set store value

      Example

      import assert from 'node:assert';

      const metrics = new StoreBuilder();
      metrics.set('heapUsed', 12);

      assert.equal(metrics.get('heapUsed'), 12 );

      Type Parameters

      • E extends string | number | symbol

      Parameters

      • key: E
      • value: T[E]

      Returns this

    • Convert store to json

      Example

      import assert from 'node:assert';

      const metrics = new StoreBuilder();
      metrics.set('heapUsed', 12);

      assert.deepStrictEqual(metrics.toJson(), { heapUsed: 12 } );

      Returns Readonly<Partial<T>>