@common.js/time-span 5.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/time-span
+
+The [time-span](https://www.npmjs.com/package/time-span) package exported as CommonJS modules.
+
+Exported from [time-span@5.1.0](https://www.npmjs.com/package/time-span/v/5.1.0) using https://github.com/etienne-martin/common.js.

package/browser.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return timeSpan;
+    }
+});
+function timeSpan() {
+    var start = performance.now();
+    var end = function() {
+        return performance.now() - start;
+    };
+    end.rounded = function() {
+        return Math.round(end());
+    };
+    end.seconds = function() {
+        return end() / 1000;
+    };
+    end.nanoseconds = function() {
+        return end() * 1000000;
+    };
+    return end;
+}

package/index.d.ts

@@ -0,0 +1,46 @@
+export interface TimeEndFunction {
+	/**
+	@returns Elapsed milliseconds.
+	*/
+	(): number;
+
+	/**
+	@returns Elapsed milliseconds rounded.
+	*/
+	rounded(): number;
+
+	/**
+	@returns Elapsed seconds.
+	*/
+	seconds(): number;
+
+	/**
+	@returns Elapsed nanoseconds.
+	*/
+	nanoseconds(): bigint;
+}
+
+/**
+Simplified high resolution timing.
+
+@returns A function that returns the time difference.
+
+@example
+```
+import timeSpan from 'time-span';
+
+const end = timeSpan();
+
+timeConsumingFn();
+
+console.log(end());
+//=> 1745.3186
+
+console.log(end.rounded());
+//=> 1745
+
+console.log(end.seconds());
+//=> 1.7453186
+```
+*/
+export default function timeSpan(): TimeEndFunction;

package/index.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return timeSpan;
+    }
+});
+var _convertHrtime = /*#__PURE__*/ _interopRequireDefault(require("convert-hrtime"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function timeSpan() {
+    var start = process.hrtime.bigint();
+    var end = function(type) {
+        return (0, _convertHrtime.default)(process.hrtime.bigint() - start)[type];
+    };
+    var returnValue = function() {
+        return end("milliseconds");
+    };
+    returnValue.rounded = function() {
+        return Math.round(end("milliseconds"));
+    };
+    returnValue.seconds = function() {
+        return end("seconds");
+    };
+    returnValue.nanoseconds = function() {
+        return end("nanoseconds");
+    };
+    return returnValue;
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@common.js/time-span",
+  "version": "5.1.0",
+  "description": "Simplified high resolution timing",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "engines": {
+    "node": ">=12"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "browser.js",
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@common.js/convert-hrtime": "^5.0.0"
+  },
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "delay": "^5.0.0",
+    "in-range": "^3.0.0",
+    "tsd": "^0.14.0",
+    "xo": "^0.38.2"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "types": "./index.d.ts",
+  "main": "./index.js",
+  "browser": "./browser.js"
+}

package/readme.md

@@ -0,0 +1,52 @@
+# time-span
+
+> Simplified high resolution timing
+
+Uses [`process.hrtime`](https://nodejs.org/api/process.html#processhrtimebigint) in Node.js and [`performance.now`](https://developer.mozilla.org/en-US/docs/Web/API/Performance/now) in browsers ([accurate to 5 microseconds](https://developer.mozilla.org/en-US/docs/Web/API/DOMHighResTimeStamp)).
+
+## Install
+
+```
+$ npm install time-span
+```
+
+## Usage
+
+```js
+import timeSpan from 'time-span';
+
+const end = timeSpan();
+
+timeConsumingFn();
+
+console.log(end());
+//=> 1745.3186
+
+console.log(end.rounded());
+//=> 1745
+
+console.log(end.seconds());
+//=> 1.7453186
+```
+
+## API
+
+### `const end = timeSpan()`
+
+Returns a function, that when called, returns the time difference.
+
+#### end()
+
+Elapsed milliseconds.
+
+#### end.rounded()
+
+Elapsed milliseconds rounded.
+
+#### end.seconds()
+
+Elapsed seconds.
+
+#### end.nanoseconds()
+
+Elapsed nanoseconds.