@jsopen/objects 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,12 +1,7 @@
 ## Changelog
 
-### [v2.0.1](https://github.com/panates/jsopen-objects/compare/v2.0.0...v2.0.1) - 
+### [v2.1.0](https://github.com/panates/jsopen-objects/compare/v2.0.2...v2.1.0) - 
 
-#### 🛠 Refactoring and Updates
+#### 🚀 New Features
 
-- refactor: Made default "symbolKeys" option to true @Eray Hanoğlu 
-
-#### 💬 General Changes
-
-- dev: Coveralls parallel @Eray Hanoğlu 
-- dev: Coveralls parallel @Eray Hanoğlu 
+- feat: Added `updateErrorMessage` helper method @Eray Hanoğlu 

package/cjs/index.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateErrorMessage = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./clone.js"), exports);
 tslib_1.__exportStar(require("./is-object.js"), exports);
 tslib_1.__exportStar(require("./merge.js"), exports);
 tslib_1.__exportStar(require("./omit.js"), exports);
 tslib_1.__exportStar(require("./type-guards.js"), exports);
+var update_error_message_js_1 = require("./update-error-message.js");
+Object.defineProperty(exports, "updateErrorMessage", { enumerable: true, get: function () { return update_error_message_js_1.updateErrorMessage; } });

package/cjs/tsconfig-build-cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.9.2"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts","../../src/update-error-message.ts"],"version":"5.9.3"}

package/cjs/update-error-message.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateErrorMessage = updateErrorMessage;
+exports.updateErrorMessageFallback = updateErrorMessageFallback;
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+function updateErrorMessage(err, newMessage) {
+    err.message = String(newMessage);
+    /** V8 */
+    if (typeof Error.captureStackTrace === 'function') {
+        Error.captureStackTrace(err);
+        return;
+    }
+    /** Other engines */
+    return updateErrorMessageFallback(err, newMessage);
+}
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+function updateErrorMessageFallback(err, newMessage) {
+    err.message = String(newMessage);
+    /** Other engines */
+    const stack = typeof err.stack === 'string' ? err.stack : null;
+    if (!stack)
+        return err;
+    const name = err.name || 'Error';
+    const lines = stack.split('\n');
+    const firstFrameIdx = lines.findIndex(l => /^\s*at\s+/.test(l));
+    if (firstFrameIdx === -1) {
+        const msgLines = String(newMessage).split(/\r?\n/);
+        lines[0] = `${name}: ${msgLines[0] ?? ''}`;
+        lines.splice(1, 0, ...msgLines.slice(1));
+        err.stack = lines.join('\n');
+        return err;
+    }
+    const frameLines = lines.slice(firstFrameIdx);
+    const msgLines = String(newMessage).split(/\r?\n/);
+    const newHead = [`${name}: ${msgLines[0] ?? ''}`, ...msgLines.slice(1)];
+    err.stack = [...newHead, ...frameLines].join('\n');
+    return err;
+}

package/esm/index.js

@@ -3,3 +3,4 @@ export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
 export * from './type-guards.js';
+export { updateErrorMessage } from './update-error-message.js';

package/esm/tsconfig-build-esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.9.2"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts","../../src/update-error-message.ts"],"version":"5.9.3"}

package/esm/update-error-message.js

@@ -0,0 +1,42 @@
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+export function updateErrorMessage(err, newMessage) {
+    err.message = String(newMessage);
+    /** V8 */
+    if (typeof Error.captureStackTrace === 'function') {
+        Error.captureStackTrace(err);
+        return;
+    }
+    /** Other engines */
+    return updateErrorMessageFallback(err, newMessage);
+}
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+export function updateErrorMessageFallback(err, newMessage) {
+    err.message = String(newMessage);
+    /** Other engines */
+    const stack = typeof err.stack === 'string' ? err.stack : null;
+    if (!stack)
+        return err;
+    const name = err.name || 'Error';
+    const lines = stack.split('\n');
+    const firstFrameIdx = lines.findIndex(l => /^\s*at\s+/.test(l));
+    if (firstFrameIdx === -1) {
+        const msgLines = String(newMessage).split(/\r?\n/);
+        lines[0] = `${name}: ${msgLines[0] ?? ''}`;
+        lines.splice(1, 0, ...msgLines.slice(1));
+        err.stack = lines.join('\n');
+        return err;
+    }
+    const frameLines = lines.slice(firstFrameIdx);
+    const msgLines = String(newMessage).split(/\r?\n/);
+    const newHead = [`${name}: ${msgLines[0] ?? ''}`, ...msgLines.slice(1)];
+    err.stack = [...newHead, ...frameLines].join('\n');
+    return err;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jsopen/objects",
   "description": "Helper utilities for working with JavaScript objects and arrays",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {

package/types/index.d.cts

@@ -3,3 +3,4 @@ export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
 export * from './type-guards.js';
+export { updateErrorMessage } from './update-error-message.js';

package/types/index.d.ts

@@ -3,3 +3,4 @@ export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
 export * from './type-guards.js';
+export { updateErrorMessage } from './update-error-message.js';

package/types/merge.d.ts

@@ -1,8 +1,8 @@
-export declare function merge<A, B>(target: A, source: B, options?: merge.Options): A & B;
-export declare function merge<A, B, C>(target: A, source: [B, C], options?: merge.Options): A & B & C;
-export declare function merge<A, B, C, D>(target: A, source: [B, C, D], options?: merge.Options): A & B & C & D;
-export declare function merge<A, B, C, D, E>(target: A, source: [B, C, D, E], options?: merge.Options): A & B & C & D & E;
+export declare function merge<A extends object, B extends object, C extends object>(target: A, source: [B, C], options?: merge.Options): A & B & C;
+export declare function merge<A extends object, B extends object, C extends object, D extends object>(target: A, source: [B, C, D], options?: merge.Options): A & B & C & D;
+export declare function merge<A extends object, B extends object, C extends object, D extends object, E extends object>(target: A, source: [B, C, D, E], options?: merge.Options): A & B & C & D & E;
 export declare function merge<A, B, C, D, F>(target: A, source: [B, C, D, F], options?: merge.Options): A & B & C & D & F;
+export declare function merge<A extends object, B extends object>(target: A, source: B, options?: merge.Options): A & B;
 /**
  * @namespace
  */

package/types/omit.d.ts

@@ -1,14 +1,14 @@
 import { DeeperOmitUndefined, DeeperUnNullish, DeepOmitTypes, DeepOmitUndefined, DeepUnNullish, OmitTypes, OmitUndefined, UnNullish } from 'ts-gems';
-export declare function omit<T, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
-export declare function omitUndefined<T>(obj: T, deep: true): DeepOmitUndefined<T>;
-export declare function omitUndefined<T>(obj: T, deep: 'full'): DeeperOmitUndefined<T>;
-export declare function omitUndefined<T>(obj: T, deep: false): OmitUndefined<T>;
-export declare function omitUndefined<T>(obj: T): OmitUndefined<T>;
-export declare function omitNull<T>(obj: T, deep: true): DeepOmitTypes<T, null>;
-export declare function omitNull<T>(obj: T, deep: 'full'): DeeperUnNullish<T>;
-export declare function omitNull<T>(obj: T, deep: false): OmitTypes<T, null>;
-export declare function omitNull<T>(obj: T): OmitTypes<T, null>;
-export declare function omitNullish<T>(obj: T, deep: true): DeepUnNullish<T>;
-export declare function omitNullish<T>(obj: T, deep: 'full'): DeeperUnNullish<T>;
-export declare function omitNullish<T>(obj: T, deep: false): UnNullish<T>;
-export declare function omitNullish<T>(obj: T): UnNullish<T>;
+export declare function omit<T extends object, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+export declare function omitUndefined<T extends object>(obj: T, deep: true): DeepOmitUndefined<T>;
+export declare function omitUndefined<T extends object>(obj: T, deep: 'full'): DeeperOmitUndefined<T>;
+export declare function omitUndefined<T extends object>(obj: T, deep: false): OmitUndefined<T>;
+export declare function omitUndefined<T extends object>(obj: T): OmitUndefined<T>;
+export declare function omitNull<T extends object>(obj: T, deep: true): DeepOmitTypes<T, null>;
+export declare function omitNull<T extends object>(obj: T, deep: 'full'): DeeperUnNullish<T>;
+export declare function omitNull<T extends object>(obj: T, deep: false): OmitTypes<T, null>;
+export declare function omitNull<T extends object>(obj: T): OmitTypes<T, null>;
+export declare function omitNullish<T extends object>(obj: T, deep: true): DeepUnNullish<T>;
+export declare function omitNullish<T extends object>(obj: T, deep: 'full'): DeeperUnNullish<T>;
+export declare function omitNullish<T extends object>(obj: T, deep: false): UnNullish<T>;
+export declare function omitNullish<T extends object>(obj: T): UnNullish<T>;

package/types/update-error-message.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+export declare function updateErrorMessage(err: Error, newMessage: string): Error | undefined;
+/**
+ * Updates the error message and stack trace at sametime.
+ * @param err
+ * @param newMessage
+ */
+export declare function updateErrorMessageFallback(err: Error, newMessage: string): Error;