@jsopen/objects 1.0.0 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# v1.2.0
+[2024-11-21]
+
+### Changes
+
+* feat: Added isConstructor, isIterable and isAsyncIterable type guards ([`b2251c1`](https://github.com/panates/jsopen-objects/commit/b2251c1a780a632d7eaf8bd8e7f3205f73c43c52))

package/cjs/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./clone.js"), exports);
-tslib_1.__exportStar(require("./is-built-in.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);

package/cjs/merge.js

@@ -97,7 +97,7 @@ for (i = 0; i < len; i++) {
     /** ************* filter *****************/
     if (options?.filter) {
         scriptL1For.push(`
-if (!filterCallback(key, curPath, target, source)) {
+if (!filterCallback(key, source, target, curPath)) {
   delete target[key];
   continue;
 }`);
@@ -107,7 +107,7 @@ if (!filterCallback(key, curPath, target, source)) {
         scriptL1For.push(`
 if (
       Object.prototype.hasOwnProperty.call(target, key) && 
-      ignoreCallback(key, curPath, target, source)
+      ignoreCallback(key, source, target, curPath)
    ) continue;
 `);
     }
@@ -118,7 +118,7 @@ if (
     if (options?.copyDescriptors) {
         let scriptL2Descriptors = scriptL1For;
         if (typeof options?.copyDescriptors === 'function') {
-            scriptL1For.push('if (copyDescriptorsCallback(key, curPath, target, source)) {');
+            scriptL1For.push('if (copyDescriptorsCallback(key, source, target, curPath)) {');
             scriptL2Descriptors = [];
             scriptL1For.push(scriptL2Descriptors);
             scriptL1For.push(`} else`);

package/cjs/omit.js

@@ -1,60 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.omit = omit;
 exports.omitUndefined = omitUndefined;
 exports.omitNull = omitNull;
 exports.omitNullish = omitNullish;
-const is_object_js_1 = require("./is-object.js");
+const merge_js_1 = require("./merge.js");
+function omit(obj, keys) {
+    const keysSet = new Set(keys);
+    return (0, merge_js_1.merge)({}, obj, {
+        deep: false,
+        filter(key) {
+            return !keysSet.has(key);
+        },
+    });
+}
 function omitUndefined(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === undefined)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitUndefined(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitUndefined(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }
 function omitNull(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNull(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitNull(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: false,
+        copyDescriptors: true,
+    });
 }
 function omitNullish(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v == null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNullish(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitNullish(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }

package/cjs/tsconfig-build-cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-built-in.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts"],"version":"5.6.3"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.6.3"}

package/cjs/{is-built-in.js → type-guards.js}

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isBuiltIn = isBuiltIn;
+exports.isConstructor = isConstructor;
+exports.isIterable = isIterable;
+exports.isAsyncIterable = isAsyncIterable;
 function isBuiltIn(v) {
     return ((typeof v === 'object' &&
         (v instanceof Date ||
@@ -25,3 +28,16 @@ function isBuiltIn(v) {
             Buffer.isBuffer(v))) ||
         Array.isArray(v));
 }
+function isConstructor(fn) {
+    return (typeof fn === 'function' &&
+        fn.prototype &&
+        fn.prototype.constructor === fn &&
+        fn.prototype.constructor.name !== 'Function' &&
+        fn.prototype.constructor.name !== 'embedded');
+}
+function isIterable(x) {
+    return Symbol.iterator in x;
+}
+function isAsyncIterable(x) {
+    return Symbol.asyncIterator in x;
+}

package/esm/index.js

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/esm/merge.js

@@ -93,7 +93,7 @@ for (i = 0; i < len; i++) {
     /** ************* filter *****************/
     if (options?.filter) {
         scriptL1For.push(`
-if (!filterCallback(key, curPath, target, source)) {
+if (!filterCallback(key, source, target, curPath)) {
   delete target[key];
   continue;
 }`);
@@ -103,7 +103,7 @@ if (!filterCallback(key, curPath, target, source)) {
         scriptL1For.push(`
 if (
       Object.prototype.hasOwnProperty.call(target, key) && 
-      ignoreCallback(key, curPath, target, source)
+      ignoreCallback(key, source, target, curPath)
    ) continue;
 `);
     }
@@ -114,7 +114,7 @@ if (
     if (options?.copyDescriptors) {
         let scriptL2Descriptors = scriptL1For;
         if (typeof options?.copyDescriptors === 'function') {
-            scriptL1For.push('if (copyDescriptorsCallback(key, curPath, target, source)) {');
+            scriptL1For.push('if (copyDescriptorsCallback(key, source, target, curPath)) {');
             scriptL2Descriptors = [];
             scriptL1For.push(scriptL2Descriptors);
             scriptL1For.push(`} else`);

package/esm/omit.js

@@ -1,55 +1,33 @@
-import { isPlainObject } from './is-object.js';
+import { merge } from './merge.js';
+export function omit(obj, keys) {
+    const keysSet = new Set(keys);
+    return merge({}, obj, {
+        deep: false,
+        filter(key) {
+            return !keysSet.has(key);
+        },
+    });
+}
 export function omitUndefined(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === undefined)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitUndefined(x, deep));
-            else if (isPlainObject(v))
-                omitUndefined(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }
 export function omitNull(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNull(x, deep));
-            else if (isPlainObject(v))
-                omitNull(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: false,
+        copyDescriptors: true,
+    });
 }
 export function omitNullish(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v == null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNullish(x, deep));
-            else if (isPlainObject(v))
-                omitNullish(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }

package/esm/tsconfig-build-esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-built-in.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts"],"version":"5.6.3"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.6.3"}

package/esm/{is-built-in.js → type-guards.js}

@@ -22,3 +22,16 @@ export function isBuiltIn(v) {
             Buffer.isBuffer(v))) ||
         Array.isArray(v));
 }
+export function isConstructor(fn) {
+    return (typeof fn === 'function' &&
+        fn.prototype &&
+        fn.prototype.constructor === fn &&
+        fn.prototype.constructor.name !== 'Function' &&
+        fn.prototype.constructor.name !== 'embedded');
+}
+export function isIterable(x) {
+    return Symbol.iterator in x;
+}
+export function isAsyncIterable(x) {
+    return Symbol.asyncIterator in x;
+}

package/package.json

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

package/types/index.d.cts

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/types/index.d.ts

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/types/merge.d.ts

@@ -1,5 +1,5 @@
 export declare namespace merge {
-    type NodeCallback = (key: string | symbol, path: string, target: any, source: any) => boolean;
+    type NodeCallback = (key: string | symbol, source: any, target: any, path: string) => boolean;
     interface Options {
         deep?: boolean | NodeCallback;
         /**

package/types/omit.d.ts

@@ -1,4 +1,4 @@
-import { DeeperOmitTypes } from 'ts-gems';
-export declare function omitUndefined<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, undefined>;
-export declare function omitNull<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, null>;
-export declare function omitNullish<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, null | undefined>;
+export declare function omit<T, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+export declare function omitUndefined<T>(obj: T, deep?: boolean): T;
+export declare function omitNull<T>(obj: T, deep?: boolean): T;
+export declare function omitNullish<T>(obj: T, deep?: boolean): T;

package/types/type-guards.d.ts

@@ -0,0 +1,5 @@
+import { Type } from 'ts-gems';
+export declare function isBuiltIn(v: any): boolean;
+export declare function isConstructor(fn: any): fn is Type;
+export declare function isIterable<T = unknown>(x: any): x is Iterable<T>;
+export declare function isAsyncIterable<T = unknown>(x: any): x is AsyncIterableIterator<T>;

package/types/is-built-in.d.ts

@@ -1 +0,0 @@
-export declare function isBuiltIn(v: any): boolean;