@pezkuwi/util 14.0.1 → 14.0.3

package/object/entries.js

@@ -0,0 +1,7 @@
+/**
+ * @name objectEntries
+ * @summary A version of Object.entries that is typed for TS
+ */
+export function objectEntries(obj) {
+    return Object.entries(obj);
+}

package/object/index.d.ts

@@ -0,0 +1,7 @@
+export { objectClear } from './clear.js';
+export { objectCopy } from './copy.js';
+export { objectEntries } from './entries.js';
+export { objectKeys } from './keys.js';
+export { objectProperties, objectProperty } from './property.js';
+export { objectSpread } from './spread.js';
+export { objectValues } from './values.js';

package/object/index.js

@@ -0,0 +1,7 @@
+export { objectClear } from './clear.js';
+export { objectCopy } from './copy.js';
+export { objectEntries } from './entries.js';
+export { objectKeys } from './keys.js';
+export { objectProperties, objectProperty } from './property.js';
+export { objectSpread } from './spread.js';
+export { objectValues } from './values.js';

package/object/keys.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name objectKeys
+ * @summary A version of Object.keys that is typed for TS
+ */
+export declare function objectKeys<T extends object, K extends Extract<keyof T, string>>(value: T): K[];

package/object/keys.js

@@ -0,0 +1,7 @@
+/**
+ * @name objectKeys
+ * @summary A version of Object.keys that is typed for TS
+ */
+export function objectKeys(value) {
+    return Object.keys(value);
+}

package/object/property.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @name objectProperty
+ * @summary Assign a get property on the input object
+ */
+export declare function objectProperty<S>(that: object, key: string, getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string, index?: number): void;
+/**
+ * @name objectProperties
+ * @summary Assign get properties on the input object
+ */
+export declare function objectProperties<S>(that: object, keys: string[], getter: (key: string, index: number, self: S) => unknown, getName?: (key: string, index: number) => string): void;

package/object/property.js

@@ -0,0 +1,34 @@
+/**
+ * @name objectProperty
+ * @summary Assign a get property on the input object
+ */
+export function objectProperty(that, key, getter, getName, index = 0) {
+    const name = getName
+        ? getName(key, index)
+        : key;
+    // There are 3 approaches here -
+    //  - Object.prototype.hasOwnProperty.call(that, key) - this only checks the current class, i.e
+    //    will retuirn false if the property is set in the parent class
+    //  - isUndefined(...) - this may yield a false positive when the property is there, but not set.
+    //    Additionally, on pre-defined getters it may make a call
+    //  - key in that - Does not need to be combined with either of the above and checks the full chain
+    if (!(name in that)) {
+        Object.defineProperty(that, name, {
+            enumerable: true,
+            // Unlike in lazy, we always call into the upper function, i.e. this method
+            // does not cache old values (it is expected to be used for dynamic values)
+            get: function () {
+                return getter(key, index, this);
+            }
+        });
+    }
+}
+/**
+ * @name objectProperties
+ * @summary Assign get properties on the input object
+ */
+export function objectProperties(that, keys, getter, getName) {
+    for (let i = 0, count = keys.length; i < count; i++) {
+        objectProperty(that, keys[i], getter, getName, i);
+    }
+}

package/object/spread.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @name objectSpread
+ * @summary Concats all sources into the destination
+ * @description Spreads object properties while maintaining object integrity
+ */
+export declare function objectSpread<T extends object>(dest: object, ...sources: (object | undefined | null)[]): T;

package/object/spread.js

@@ -0,0 +1,31 @@
+/**
+ * @name objectSpread
+ * @summary Concats all sources into the destination
+ * @description Spreads object properties while maintaining object integrity
+ */
+export function objectSpread(dest, ...sources) {
+    const filterProps = new Set(['__proto__', 'constructor', 'prototype']);
+    for (let i = 0, count = sources.length; i < count; i++) {
+        const src = sources[i];
+        if (src) {
+            if (typeof src.entries === 'function') {
+                for (const [key, value] of src.entries()) {
+                    if (!filterProps.has(key)) {
+                        dest[key] = value;
+                    }
+                }
+            }
+            else {
+                // Create a clean copy of the source object
+                const sanitizedSrc = Object.create(null);
+                for (const [key, value] of Object.entries(src)) {
+                    if (!filterProps.has(key)) {
+                        sanitizedSrc[key] = value;
+                    }
+                }
+                Object.assign(dest, sanitizedSrc);
+            }
+        }
+    }
+    return dest;
+}

package/object/values.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @name objectValues
+ * @summary A version of Object.values that is typed for TS
+ */
+export declare function objectValues<T extends object>(obj: T): T[keyof T][];

package/object/values.js

@@ -0,0 +1,7 @@
+/**
+ * @name objectValues
+ * @summary A version of Object.values that is typed for TS
+ */
+export function objectValues(obj) {
+    return Object.values(obj);
+}