@augment-vir/common 14.3.1 → 15.0.0

package/dist/cjs/augments/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeAndReturnError = exports.wrapInTry = exports.ensureError = exports.extractErrorMessage = exports.combineErrorMessages = exports.combineErrors = void 0;
+exports.executeAndReturnError = exports.wrapInTry = exports.ensureErrorAndPrependMessage = exports.ensureError = exports.extractErrorMessage = exports.combineErrorMessages = exports.combineErrors = void 0;
 const __1 = require("..");
 function combineErrors(errors) {
     if (!errors || errors.length === 0) {
@@ -20,27 +20,36 @@ function combineErrorMessages(errors) {
     return errors.map(extractErrorMessage).filter(__1.isTruthy).join('\n');
 }
 exports.combineErrorMessages = combineErrorMessages;
-function extractErrorMessage(error) {
-    if (!error) {
+function extractErrorMessage(maybeError) {
+    if (!maybeError) {
         return '';
     }
-    if (error instanceof Error) {
-        return error.message;
+    if (maybeError instanceof Error) {
+        return maybeError.message;
+    }
+    else if ((0, __1.typedHasProperty)(maybeError, 'message')) {
+        return String(maybeError.message);
     }
     else {
-        return String(error);
+        return String(maybeError);
     }
 }
 exports.extractErrorMessage = extractErrorMessage;
-function ensureError(input) {
-    if (input instanceof Error) {
-        return input;
+function ensureError(maybeError) {
+    if (maybeError instanceof Error) {
+        return maybeError;
     }
     else {
-        return new Error(extractErrorMessage(input));
+        return new Error(extractErrorMessage(maybeError));
     }
 }
 exports.ensureError = ensureError;
+function ensureErrorAndPrependMessage(maybeError, prependMessage) {
+    const error = ensureError(maybeError);
+    error.message = `${prependMessage}: ${error.message}`;
+    return error;
+}
+exports.ensureErrorAndPrependMessage = ensureErrorAndPrependMessage;
 function wrapInTry(inputs) {
     try {
         return inputs.callback();

package/dist/cjs/augments/pixel.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePx = exports.addPx = void 0;
+function addPx(input) {
+    if (String(input).endsWith('px')) {
+        return String(input);
+    }
+    else {
+        return `${input}px`;
+    }
+}
+exports.addPx = addPx;
+function removePx(input) {
+    return Number(input.replace(/px$/, ''));
+}
+exports.removePx = removePx;

package/dist/cjs/augments/time.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.measureCallbackDuration = exports.timeCallback = void 0;
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ */
+function timeCallback(callback) {
+    const startTime = Date.now();
+    const result = callback();
+    if (result instanceof Promise) {
+        return new Promise(async (resolve, reject) => {
+            try {
+                await result;
+                const endTime = Date.now();
+                resolve(endTime - startTime);
+            }
+            catch (caught) {
+                reject(caught);
+            }
+        });
+    }
+    const endTime = Date.now();
+    return (endTime - startTime);
+}
+exports.timeCallback = timeCallback;
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ *
+ * Alias of timeCallback.
+ */
+exports.measureCallbackDuration = timeCallback;

package/dist/cjs/index.js

@@ -19,8 +19,6 @@ __exportStar(require("./augments/array"), exports);
 __exportStar(require("./augments/async"), exports);
 __exportStar(require("./augments/common-number"), exports);
 __exportStar(require("./augments/common-string"), exports);
-__exportStar(require("./augments/date/date"), exports);
-__exportStar(require("./augments/date/relative-date"), exports);
 __exportStar(require("./augments/environment"), exports);
 __exportStar(require("./augments/error"), exports);
 __exportStar(require("./augments/function"), exports);
@@ -38,11 +36,13 @@ __exportStar(require("./augments/object/object"), exports);
 __exportStar(require("./augments/object/object-entries"), exports);
 __exportStar(require("./augments/object/pick-deep"), exports);
 __exportStar(require("./augments/object/typed-has-property"), exports);
+__exportStar(require("./augments/pixel"), exports);
 __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/runtime-type-of"), exports);
 __exportStar(require("./augments/string/url"), exports);
 __exportStar(require("./augments/string/uuid"), exports);
+__exportStar(require("./augments/time"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);

package/dist/esm/augments/error.js

@@ -1,4 +1,4 @@
-import { isPromiseLike, isTruthy } from '..';
+import { isPromiseLike, isTruthy, typedHasProperty, } from '..';
 export function combineErrors(errors) {
     if (!errors || errors.length === 0) {
         return undefined;
@@ -15,25 +15,33 @@ export function combineErrorMessages(errors) {
     }
     return errors.map(extractErrorMessage).filter(isTruthy).join('\n');
 }
-export function extractErrorMessage(error) {
-    if (!error) {
+export function extractErrorMessage(maybeError) {
+    if (!maybeError) {
         return '';
     }
-    if (error instanceof Error) {
-        return error.message;
+    if (maybeError instanceof Error) {
+        return maybeError.message;
+    }
+    else if (typedHasProperty(maybeError, 'message')) {
+        return String(maybeError.message);
     }
     else {
-        return String(error);
+        return String(maybeError);
     }
 }
-export function ensureError(input) {
-    if (input instanceof Error) {
-        return input;
+export function ensureError(maybeError) {
+    if (maybeError instanceof Error) {
+        return maybeError;
     }
     else {
-        return new Error(extractErrorMessage(input));
+        return new Error(extractErrorMessage(maybeError));
     }
 }
+export function ensureErrorAndPrependMessage(maybeError, prependMessage) {
+    const error = ensureError(maybeError);
+    error.message = `${prependMessage}: ${error.message}`;
+    return error;
+}
 export function wrapInTry(inputs) {
     try {
         return inputs.callback();

package/dist/esm/augments/pixel.js

@@ -0,0 +1,11 @@
+export function addPx(input) {
+    if (String(input).endsWith('px')) {
+        return String(input);
+    }
+    else {
+        return `${input}px`;
+    }
+}
+export function removePx(input) {
+    return Number(input.replace(/px$/, ''));
+}

package/dist/esm/augments/time.js

@@ -0,0 +1,31 @@
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ */
+export function timeCallback(callback) {
+    const startTime = Date.now();
+    const result = callback();
+    if (result instanceof Promise) {
+        return new Promise(async (resolve, reject) => {
+            try {
+                await result;
+                const endTime = Date.now();
+                resolve(endTime - startTime);
+            }
+            catch (caught) {
+                reject(caught);
+            }
+        });
+    }
+    const endTime = Date.now();
+    return (endTime - startTime);
+}
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ *
+ * Alias of timeCallback.
+ */
+export const measureCallbackDuration = timeCallback;

package/dist/esm/index.js

@@ -3,8 +3,6 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date/date';
-export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -22,11 +20,13 @@ export * from './augments/object/object';
 export * from './augments/object/object-entries';
 export * from './augments/object/pick-deep';
 export * from './augments/object/typed-has-property';
+export * from './augments/pixel';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
 export * from './augments/string/uuid';
+export * from './augments/time';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/types/augments/error.d.ts

@@ -5,8 +5,9 @@ export declare function combineErrors(errors: ReadonlyArray<never>): undefined;
 export declare function combineErrors(errors: ReadonlyArray<Error>): Error | undefined;
 export declare function combineErrors(errors?: undefined): undefined;
 export declare function combineErrorMessages(errors?: ReadonlyArray<Error | string | undefined> | undefined): string;
-export declare function extractErrorMessage(error: unknown): string;
-export declare function ensureError(input: unknown): Error;
+export declare function extractErrorMessage(maybeError: unknown): string;
+export declare function ensureError(maybeError: unknown): Error;
+export declare function ensureErrorAndPrependMessage(maybeError: unknown, prependMessage: string): Error;
 export type TryWrapInputs<CallbackReturn, FallbackReturn> = {
     callback: () => CallbackReturn;
 } & RequireExactlyOne<{

package/dist/types/augments/pixel.d.ts

@@ -0,0 +1,3 @@
+export type WithPx = `${string | number}px`;
+export declare function addPx(input: number | string): WithPx;
+export declare function removePx(input: WithPx | string): number;

package/dist/types/augments/time.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ */
+export declare function timeCallback<T>(callback: () => T): T extends Promise<any> ? Promise<number> : number;
+/**
+ * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
+ * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
+ * purely synchronous).
+ *
+ * Alias of timeCallback.
+ */
+export declare const measureCallbackDuration: typeof timeCallback;

package/dist/types/index.d.ts

@@ -3,8 +3,6 @@ export * from './augments/array';
 export * from './augments/async';
 export * from './augments/common-number';
 export * from './augments/common-string';
-export * from './augments/date/date';
-export * from './augments/date/relative-date';
 export * from './augments/environment';
 export * from './augments/error';
 export * from './augments/function';
@@ -22,11 +20,13 @@ export * from './augments/object/object';
 export * from './augments/object/object-entries';
 export * from './augments/object/pick-deep';
 export * from './augments/object/typed-has-property';
+export * from './augments/pixel';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
 export * from './augments/string/uuid';
+export * from './augments/time';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "14.3.1",
+    "version": "15.0.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"