@oliversalzburg/js-utils 0.0.24-dev.0 → 0.0.24-dev.2

package/core.d.ts

@@ -30,7 +30,7 @@ export type AnyFunctionReturning<TReturned = any> = (...args: Array<any>) => TRe
  * @typeParam TReturned - The type of the item returned by the function.
  * @group Types
  */
-export type AnyAsyncFunctionReturning<TReturned = any> = (...args: Array<any>) => TReturned;
+export type AnyAsyncFunctionReturning<TReturned = any> = (...args: Array<any>) => Promise<TReturned>;
 /**
  * Describes a class "mixin", which is a function that returns a dynamically
  * constructed class, based on the passed parameters.

package/index.d.ts

@@ -8,6 +8,7 @@ export * from "./graphics/index.js";
 export * from "./log/index.js";
 export * from "./math/index.js";
 export * from "./nil.js";
+export * from "./performance.js";
 export * from "./random.js";
 export * from "./string-formatter.js";
 export * from "./string.js";

package/index.js

@@ -8,6 +8,7 @@ export * from "./graphics/index.js";
 export * from "./log/index.js";
 export * from "./math/index.js";
 export * from "./nil.js";
+export * from "./performance.js";
 export * from "./random.js";
 export * from "./string-formatter.js";
 export * from "./string.js";

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}

package/math/core.d.ts

@@ -64,3 +64,35 @@ export declare const isInteger: (value: number) => boolean;
  * @group Math
  */
 export declare const clamp: (input: number, floor: number, ceil: number) => number;
+/**
+ * Rounds a given number to the next highest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export declare const ceilTo: (input: number, fractionDigits?: number) => number;
+/**
+ * Rounds a given number to the next lowest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export declare const floorTo: (input: number, fractionDigits?: number) => number;
+/**
+ * Rounds a given number to the next closest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export declare const roundTo: (input: number, fractionDigits?: number) => number;
+/**
+ * Cuts off digits of a number.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export declare const truncTo: (input: number, fractionDigits?: number) => number;

package/math/core.js

@@ -91,4 +91,48 @@ export const isInteger = (value) => {
 export const clamp = (input, floor, ceil) => {
     return Math.max(floor, Math.min(input, ceil));
 };
+/**
+ * Rounds a given number to the next highest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export const ceilTo = (input, fractionDigits = 0) => {
+    const scale = Math.pow(10, fractionDigits);
+    return Math.floor(input * scale) / scale;
+};
+/**
+ * Rounds a given number to the next lowest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export const floorTo = (input, fractionDigits = 0) => {
+    const scale = Math.pow(10, fractionDigits);
+    return Math.floor(input * scale) / scale;
+};
+/**
+ * Rounds a given number to the next closest value.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export const roundTo = (input, fractionDigits = 0) => {
+    const scale = Math.pow(10, fractionDigits);
+    return Math.round(input * scale) / scale;
+};
+/**
+ * Cuts off digits of a number.
+ * @param input - The number to round.
+ * @param fractionDigits - The amount of digits to retain in the fraction.
+ * @returns The rounded number.
+ * @group Math
+ */
+export const truncTo = (input, fractionDigits = 0) => {
+    const scale = Math.pow(10, fractionDigits);
+    return Math.trunc(input * scale) / scale;
+};
 //# sourceMappingURL=core.js.map

package/math/core.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../../source/math/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAE;IACzE,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,IAAI,CAAC,KAAK,KAAK,EAAE;QACf,OAAO,CAAC,CAAC;KACV,CAAC,oBAAoB;IACtB,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;IACrD,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,CAAC;QACP,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;KAC1B;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAU,EAAE;IAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC"}
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../source/math/core.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAEjD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,OAAO,OAAO,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,KAAa,EAAE,EAAE;IAC1C,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAU,EAAE,EAAE;IACzE,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,CAAC;IACtB,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC,CAAC;AAClD,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,EAAE;IACrC,IAAI,CAAC,KAAK,KAAK,EAAE;QACf,OAAO,CAAC,CAAC;KACV,CAAC,oBAAoB;IACtB,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,8BAA8B;IACrD,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC7B,OAAO,EAAE,GAAG,CAAC,EAAE;QACb,CAAC,GAAG,EAAE,CAAC;QACP,EAAE,GAAG,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;KAC1B;IACD,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,EAAE;IACzC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC;AACrC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,IAAY,EAAU,EAAE;IAC1E,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,cAAc,GAAG,CAAC,EAAU,EAAE;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,cAAc,GAAG,CAAC,EAAU,EAAE;IACnE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,cAAc,GAAG,CAAC,EAAU,EAAE;IACnE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAC3C,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,KAAa,EAAE,cAAc,GAAG,CAAC,EAAU,EAAE;IACnE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AAC3C,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@oliversalzburg/js-utils",
-  "version": "0.0.24-dev.0",
+  "version": "0.0.24-dev.2",
   "license": "MIT",
   "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
   "repository": {
@@ -35,7 +35,7 @@
     "@types/eslint": "8.44.7",
     "@types/mocha": "10.0.6",
     "@types/node": "20.10.0",
-    "@types/web": "0.0.120",
+    "@types/web": "0.0.121",
     "@typescript-eslint/eslint-plugin": "6.12.0",
     "@typescript-eslint/parser": "6.12.0",
     "c8": "8.0.1",

package/performance.d.ts

@@ -0,0 +1,16 @@
+import { AnyAsyncFunctionReturning, AnyFunctionReturning } from "./core.js";
+/**
+ * Executes the given function and measures how long the execution takes.
+ * @param context - The function of which the execution speed should be measured.
+ * @returns A tuple with the result of the function, and the execution time in milliseconds.
+ * @group Performance
+ */
+export declare const measure: <TReturn>(context: AnyFunctionReturning<TReturn>) => [TReturn, number];
+/**
+ * Executes the given async function and measures how long the execution takes.
+ * @param context - The async function of which the execution speed should be measured.
+ * @returns A tuple with the result of the function, and the execution time in milliseconds.
+ * @group Performance
+ * @group Async
+ */
+export declare const measureAsync: <TReturn>(context: AnyAsyncFunctionReturning<TReturn>) => Promise<[TReturn, number]>;

package/performance.js

@@ -0,0 +1,22 @@
+/**
+ * Executes the given function and measures how long the execution takes.
+ * @param context - The function of which the execution speed should be measured.
+ * @returns A tuple with the result of the function, and the execution time in milliseconds.
+ * @group Performance
+ */
+export const measure = (context) => {
+    const entry = performance.now();
+    return [context(), performance.now() - entry];
+};
+/**
+ * Executes the given async function and measures how long the execution takes.
+ * @param context - The async function of which the execution speed should be measured.
+ * @returns A tuple with the result of the function, and the execution time in milliseconds.
+ * @group Performance
+ * @group Async
+ */
+export const measureAsync = async (context) => {
+    const entry = performance.now();
+    return [await context(), performance.now() - entry];
+};
+//# sourceMappingURL=performance.js.map

package/performance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"performance.js","sourceRoot":"","sources":["../source/performance.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAU,OAAsC,EAAqB,EAAE;IAC5F,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,OAAO,CAAC,OAAO,EAAE,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;AAChD,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,OAA2C,EACf,EAAE;IAC9B,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,OAAO,CAAC,MAAM,OAAO,EAAE,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;AACtD,CAAC,CAAC"}