@universal-packages/time-measurer 1.1.0 → 1.2.0

package/README.md

@@ -3,7 +3,7 @@
 [![Testing](https://github.com/universal-packages/universal-time-measurer/actions/workflows/testing.yml/badge.svg)](https://github.com/universal-packages/universal-time-measurer/actions/workflows/testing.yml)
 [![codecov](https://codecov.io/gh/universal-packages/universal-time-measurer/branch/main/graph/badge.svg?token=CXPJSN8IGL)](https://codecov.io/gh/universal-packages/universal-time-measurer)
 
-Time Measurer is a simple wrap for `process.hrtime` to measure time with procession and express that time easily through formatted representations, anytime you want to express how much a query or a request took at code level you may want to give this a try.
+Time Measurer is a simple wrap for `process.hrtime.bigint` to measure time with procession and express that time easily through formatted representations, anytime you want to express how much a query or a request took at code level you may want to give this a try.
 
 ## Install
 
@@ -11,9 +11,29 @@ Time Measurer is a simple wrap for `process.hrtime` to measure time with process
 npm install @universal-packages/time-measurer
 ```
 
+## startMeasurement()
+
+Creates a new TimeMeasurer instance to start a measurerment.
+
+```ts
+import { startMeasurement } from '@universal-packages/time-measurer'
+
+async function getAll() {
+  const measurer = startMeasurement()
+  const data = await myDB.getAllRecords()
+  const measurement = measurer.finish()
+
+  console.log('All records - ', measurement.toString())
+}
+
+
+getAll()
+// > All records - 2.23ms
+```
+
 ## TimeMeasurer
 
-Class `TimeMeasurer` provides an instantiable interface to start measuring time from any part of your code.
+Class `TimeMeasurer` provides an instantiable interface to start measuring time from any part of your code. The measurement starts at instancing time.
 
 ```js
 import TimeMeasurer from '@universal-packages/time-measurer'
@@ -21,15 +41,12 @@ import TimeMeasurer from '@universal-packages/time-measurer'
 async function getAll() {
   const measurer = new TimeMeasurer()
 
-  measurer.start()
-
   const data = await myDB.getAllRecords()
   const measurement = measurer.finish()
 
   console.log('All records - ', measurement.toString())
 }
 
-
 getAll()
 // > All records - 2.23ms
 ```
@@ -52,10 +69,10 @@ measurement.toString('Expressive')
 You will get someting like
 
 ```
-02hrs 35min 51.235sec
-02:35:51.235
-02hrs 35min 51.235sec
-02 Hours, 35 Minutes, and 51.235 Seconds
+2hrs 35min 51.235sec
+2:35:51.235
+2hrs 35min 51.235sec
+2 Hours, 35 Minutes, and 51.235 Seconds
 ```
 
 It will take into account parts of the representation that are not contributing to the time, like if the measurement only took seconds, minutes and hours will not be included.
@@ -75,26 +92,6 @@ Get the time representation as a date object this can be helpful if you want to
 measurement.toDate()
 ```
 
-## Functional
-
-A more simple way to use the time measurer API is by importing just the `start` and `finish` functions, the only disadvantage here is that you can only measure one thing at a time, unlike `TimeMeasurer` that can be instantiated multiple times and measurer several things useful when you have a lot of async tasks running.
-
-```ts
-import { start, finish } from '@universal-packages/time-measurer'
-
-async function getAll() {
-  start()
-  const data = await myDB.getAllRecords()
-  const measurement = finish()
-
-  console.log('All records - ', measurement.toString())
-}
-
-
-getAll()
-// > All records - 2.23ms
-```
-
 ## Sleep
 
 Time measurer ships with a convenient sleep function that takes a single parameter `time` in milliseconds, internally it is just a promise with a timeout that resolves it.

package/TimeMeasurer.d.ts

@@ -7,21 +7,7 @@ import Measurement from './Measurement';
  */
 export default class TimeMeasurer {
     private hrstart;
-    /** Starts a measurement */
-    start(): void;
+    constructor();
     /** Returns a measurement representing the time passed from when start wass colled */
     finish(): Measurement;
-    /**
-     * Simple waitable timeout to sleep the process
-     *
-     * Example:
-     *
-     * ```ts
-     * // In milliseconds
-     * await TimeMeasurer.sleep(1000)
-     *
-     * ```
-     *
-     * */
-    static sleep(time: number): Promise<void>;
 }

package/TimeMeasurer.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Measurement_1 = __importDefault(require("./Measurement"));
-const sleep_1 = __importDefault(require("./sleep"));
 /**
  *
  * It meassures the time a process takes from the time start is called
@@ -12,32 +11,14 @@ const sleep_1 = __importDefault(require("./sleep"));
  *
  */
 class TimeMeasurer {
-    /** Starts a measurement */
-    start() {
+    constructor() {
         this.hrstart = process.hrtime.bigint();
     }
     /** Returns a measurement representing the time passed from when start wass colled */
     finish() {
-        if (this.hrstart === undefined)
-            throw new Error('Time measurer finished without previously started');
         const nanoseconds = process.hrtime.bigint() - this.hrstart;
         return new Measurement_1.default(nanoseconds);
     }
-    /**
-     * Simple waitable timeout to sleep the process
-     *
-     * Example:
-     *
-     * ```ts
-     * // In milliseconds
-     * await TimeMeasurer.sleep(1000)
-     *
-     * ```
-     *
-     * */
-    static async sleep(time) {
-        return (0, sleep_1.default)(time);
-    }
 }
 exports.default = TimeMeasurer;
 //# sourceMappingURL=TimeMeasurer.js.map

package/TimeMeasurer.js.map

@@ -1 +1 @@
-{"version":3,"file":"TimeMeasurer.js","sourceRoot":"","sources":["../src/TimeMeasurer.ts"],"names":[],"mappings":";;;;;AAAA,gEAAuC;AACvC,oDAA2B;AAE3B;;;;;GAKG;AACH,MAAqB,YAAY;IAG/B,2BAA2B;IACpB,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;IACxC,CAAC;IAED,qFAAqF;IAC9E,MAAM;QACX,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;QAEpG,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE1D,OAAO,IAAI,qBAAW,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;IAED;;;;;;;;;;;SAWK;IACE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAY;QACpC,OAAO,IAAA,eAAK,EAAC,IAAI,CAAC,CAAA;IACpB,CAAC;CACF;AAhCD,+BAgCC"}
+{"version":3,"file":"TimeMeasurer.js","sourceRoot":"","sources":["../src/TimeMeasurer.ts"],"names":[],"mappings":";;;;;AAAA,gEAAuC;AAEvC;;;;;GAKG;AACH,MAAqB,YAAY;IAG/B;QACE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;IACxC,CAAC;IAED,qFAAqF;IAC9E,MAAM;QACX,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;QAE1D,OAAO,IAAI,qBAAW,CAAC,WAAW,CAAC,CAAA;IACrC,CAAC;CACF;AAbD,+BAaC"}

package/index.d.ts

@@ -2,4 +2,4 @@ export { default } from './TimeMeasurer';
 export { default as Measurement } from './Measurement';
 export * from './Measurement.types';
 export { default as sleep } from './sleep';
-export * from './singleton';
+export * from './startMeasurement';

package/index.js

@@ -25,5 +25,5 @@ Object.defineProperty(exports, "Measurement", { enumerable: true, get: function
 __exportStar(require("./Measurement.types"), exports);
 var sleep_1 = require("./sleep");
 Object.defineProperty(exports, "sleep", { enumerable: true, get: function () { return __importDefault(sleep_1).default; } });
-__exportStar(require("./singleton"), exports);
+__exportStar(require("./startMeasurement"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,+CAAwC;AAA/B,wHAAA,OAAO,OAAA;AAChB,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,sDAAmC;AACnC,iCAA0C;AAAjC,+GAAA,OAAO,OAAS;AACzB,8CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,+CAAwC;AAA/B,wHAAA,OAAO,OAAA;AAChB,6CAAsD;AAA7C,2HAAA,OAAO,OAAe;AAC/B,sDAAmC;AACnC,iCAA0C;AAAjC,+GAAA,OAAO,OAAS;AACzB,qDAAkC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@universal-packages/time-measurer",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Utility to measure routines times with precision",
   "author": "David De Anda <david@universal-packages.com> (https://github.com/universal-packages)",
   "license": "MIT",

package/sleep.d.ts

@@ -1 +1,2 @@
+/** Simple waitable timeout to sleep the process */
 export default function sleep(time: number): Promise<void>;

package/sleep.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/** Simple waitable timeout to sleep the process */
 async function sleep(time) {
     return new Promise((resolve) => setTimeout(() => resolve(), time));
 }

package/sleep.js.map

@@ -1 +1 @@
-{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../src/sleep.ts"],"names":[],"mappings":";;AAAe,KAAK,UAAU,KAAK,CAAC,IAAY;IAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAkB,EAAE,CAAC,UAAU,CAAC,GAAS,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1F,CAAC;AAFD,wBAEC"}
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../src/sleep.ts"],"names":[],"mappings":";;AAAA,mDAAmD;AACpC,KAAK,UAAU,KAAK,CAAC,IAAY;IAC9C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAkB,EAAE,CAAC,UAAU,CAAC,GAAS,EAAE,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,CAAC,CAAA;AAC1F,CAAC;AAFD,wBAEC"}

package/startMeasurement.d.ts

@@ -0,0 +1,2 @@
+import TimeMeasurer from './TimeMeasurer';
+export declare function startMeasurement(): TimeMeasurer;

package/startMeasurement.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.startMeasurement = void 0;
+const TimeMeasurer_1 = __importDefault(require("./TimeMeasurer"));
+function startMeasurement() {
+    return new TimeMeasurer_1.default();
+}
+exports.startMeasurement = startMeasurement;
+//# sourceMappingURL=startMeasurement.js.map

package/startMeasurement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"startMeasurement.js","sourceRoot":"","sources":["../src/startMeasurement.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAyC;AAEzC,SAAgB,gBAAgB;IAC9B,OAAO,IAAI,sBAAY,EAAE,CAAA;AAC3B,CAAC;AAFD,4CAEC"}

package/singleton.d.ts

@@ -1,3 +0,0 @@
-import Measurement from './Measurement';
-export declare function start(): void;
-export declare function finish(): Measurement;

package/singleton.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.finish = exports.start = void 0;
-const TimeMeasurer_1 = __importDefault(require("./TimeMeasurer"));
-const PROCESS_MEASURER = new TimeMeasurer_1.default();
-function start() {
-    PROCESS_MEASURER.start();
-}
-exports.start = start;
-function finish() {
-    return PROCESS_MEASURER.finish();
-}
-exports.finish = finish;
-//# sourceMappingURL=singleton.js.map

package/singleton.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"singleton.js","sourceRoot":"","sources":["../src/singleton.ts"],"names":[],"mappings":";;;;;;AACA,kEAAyC;AAEzC,MAAM,gBAAgB,GAAG,IAAI,sBAAY,EAAE,CAAA;AAE3C,SAAgB,KAAK;IACnB,gBAAgB,CAAC,KAAK,EAAE,CAAA;AAC1B,CAAC;AAFD,sBAEC;AAED,SAAgB,MAAM;IACpB,OAAO,gBAAgB,CAAC,MAAM,EAAE,CAAA;AAClC,CAAC;AAFD,wBAEC"}