@universal-packages/time-measurer 1.3.1 → 1.4.1

package/README.md

@@ -12,7 +12,9 @@ Time Measurer is a simple wrap for `process.hrtime.bigint` to measure time with
 npm install @universal-packages/time-measurer
 ```
 
-## startMeasurement()
+## Global methods
+
+#### **`startMeasurement()`**
 
 Creates a new TimeMeasurer instance to start a measurement.
 
@@ -31,6 +33,18 @@ getAll()
 // > All records - 2.23ms
 ```
 
+#### **`sleep(milliseconds: number)`**
+
+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.
+
+```js
+import { sleep } from '@universal-packages/time-measurer'
+
+async function awaitable() {
+  await sleep(2000)
+}
+```
+
 ## TimeMeasurer
 
 Class `TimeMeasurer` provides an instantiable interface to start measuring time from any part of your code. The measurement starts at instancing time.
@@ -41,6 +55,8 @@ 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()
 
@@ -51,22 +67,27 @@ getAll()
 // > All records - 2.23ms
 ```
 
+### Instance methods
+
+#### **`start()`**
+
+Resets the initial time.
+
+#### **`stop()`**
+
+Returns a measurement representing the time passed from when start was called.
+
 ## Measurement
 
 A `Measurement` object is the time representation after a measure, it provides the interface to express time as a formatted string or even as a date object.
 
-### .toString()
+### Instance methods
 
-Get the time representation as a string, this function takes one param `TimeFormat`, that can be one of `Condensed`, `Human`, `Expressive`, default: `Human`.
+#### **`toString(format: TimeFormat)`**
 
-```js
-measurement.toString()
-measurement.toString('Condensed')
-measurement.toString('Human')
-measurement.toString('Expressive')
-```
+Get the time representation as a string, this function takes one param `TimeFormat`, that can be one of `Condensed`, `Human`, `Expressive`, default: `Human`.
 
-You will get something like
+Example output
 
 ```
 2hrs 35min 51.235sec
@@ -84,26 +105,10 @@ It will take into account parts of the representation that are not contributing
 51.235 Seconds
 ```
 
-### .toString()
+#### **`toDate()`**
 
 Get the time representation as a date object this can be helpful if you want to use the `Date` api to format or do whatever with the date.
 
-```js
-measurement.toDate()
-```
-
-## 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.
-
-```js
-import { sleep } from '@universal-packages/time-measurer'
-
-async function waitable() {
-  await sleep(2000)
-}
-```
-
 ## Typescript
 
 This library is developed in TypeScript and shipped fully typed.

package/TimeMeasurer.d.ts

@@ -7,7 +7,8 @@ import Measurement from './Measurement';
  */
 export default class TimeMeasurer {
     private hrStart;
-    constructor();
+    /** Resets the initial time */
+    start(): void;
     /** Returns a measurement representing the time passed from when start was called */
     finish(): Measurement;
 }

package/TimeMeasurer.js

@@ -12,6 +12,10 @@ const Measurement_1 = __importDefault(require("./Measurement"));
  */
 class TimeMeasurer {
     constructor() {
+        this.hrStart = 0n;
+    }
+    /** Resets the initial time */
+    start() {
         this.hrStart = process.hrtime.bigint();
     }
     /** Returns a measurement representing the time passed from when start was called */

package/TimeMeasurer.js.map

@@ -1 +1 @@
-{"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,oFAAoF;IAC7E,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"}
+{"version":3,"file":"TimeMeasurer.js","sourceRoot":"","sources":["../src/TimeMeasurer.ts"],"names":[],"mappings":";;;;;AAAA,gEAAuC;AAEvC;;;;;GAKG;AACH,MAAqB,YAAY;IAAjC;QACU,YAAO,GAAW,EAAE,CAAA;IAa9B,CAAC;IAXC,8BAA8B;IACvB,KAAK;QACV,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAA;IACxC,CAAC;IAED,oFAAoF;IAC7E,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;AAdD,+BAcC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@universal-packages/time-measurer",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "description": "Utility to measure routines times with precision",
   "author": "David De Anda <david@universal-packages.com> (https://github.com/universal-packages)",
   "license": "MIT",
@@ -11,14 +11,16 @@
     "build": "tsc --p tsconfig.dis.json",
     "test": "jest --watch",
     "test:full": "jest --coverage --verbose",
-    "test:clear": "jest --clearCache"
+    "test:clear": "jest --clearCache",
+    "format": "prettier --write \"./{src,tests}/**/*.{ts,tsx,js,jsx,json}\""
   },
-  "dependencies": {},
   "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^4.1.1",
     "@types/jest": "^28.1.0",
     "@types/node": "^17.0.39",
     "jest": "^28.1.0",
     "jest-circus": "^28.1.0",
+    "prettier": "^2.8.7",
     "ts-jest": "^28.0.4",
     "typescript": "^4.7.3"
   },
@@ -42,6 +44,17 @@
     "semi": false,
     "singleQuote": true,
     "printWidth": 180,
-    "trailingComma": "none"
+    "trailingComma": "none",
+    "importOrder": [
+      "^[./]"
+    ],
+    "importOrderSeparation": true,
+    "importOrderSortSpecifiers": true,
+    "importOrderParserPlugins": [
+      "typescript",
+      "jsx",
+      "classProperties",
+      "decorators-legacy"
+    ]
   }
 }

package/sleep.d.ts

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

package/sleep.js

@@ -1,8 +1,8 @@
 "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));
+/** Simple awaitable timeout to sleep the process */
+async function sleep(milliseconds) {
+    return new Promise((resolve) => setTimeout(() => resolve(), milliseconds));
 }
 exports.default = sleep;
 //# sourceMappingURL=sleep.js.map

package/sleep.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../src/sleep.ts"],"names":[],"mappings":";;AAAA,oDAAoD;AACrC,KAAK,UAAU,KAAK,CAAC,YAAoB;IACtD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAkB,EAAE,CAAC,UAAU,CAAC,GAAS,EAAE,CAAC,OAAO,EAAE,EAAE,YAAY,CAAC,CAAC,CAAA;AAClG,CAAC;AAFD,wBAEC"}

package/startMeasurement.js

@@ -6,7 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.startMeasurement = void 0;
 const TimeMeasurer_1 = __importDefault(require("./TimeMeasurer"));
 function startMeasurement() {
-    return new TimeMeasurer_1.default();
+    const measurer = new TimeMeasurer_1.default();
+    measurer.start();
+    return measurer;
 }
 exports.startMeasurement = startMeasurement;
 //# sourceMappingURL=startMeasurement.js.map

package/startMeasurement.js.map

@@ -1 +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"}
+{"version":3,"file":"startMeasurement.js","sourceRoot":"","sources":["../src/startMeasurement.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAyC;AAEzC,SAAgB,gBAAgB;IAC9B,MAAM,QAAQ,GAAG,IAAI,sBAAY,EAAE,CAAA;IAEnC,QAAQ,CAAC,KAAK,EAAE,CAAA;IAEhB,OAAO,QAAQ,CAAA;AACjB,CAAC;AAND,4CAMC"}