@stacksjs/objects 0.53.1 → 0.56.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +12 -9
- package/dist/index.mjs +14 -11
- package/package.json +7 -6
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { DeepMerge } from '@stacksjs/types';
|
|
2
2
|
export { Collection, collect } from '@stacksjs/collections';
|
|
3
|
+
|
|
3
4
|
/**
|
|
4
5
|
* Map key/value pairs for an object, and construct a new one
|
|
5
6
|
*
|
|
@@ -27,7 +28,7 @@ export { Collection, collect } from '@stacksjs/collections';
|
|
|
27
28
|
* // { b: 2 }
|
|
28
29
|
* ```
|
|
29
30
|
*/
|
|
30
|
-
|
|
31
|
+
declare function objectMap<K extends string, V, NK = K, NV = V>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V>;
|
|
31
32
|
/**
|
|
32
33
|
* Type guard for any key, `k`.
|
|
33
34
|
* Marks `k` as a key of `T` if `k` is in `obj`.
|
|
@@ -36,41 +37,43 @@ export declare function objectMap<K extends string, V, NK = K, NV = V>(obj: Reco
|
|
|
36
37
|
* @param obj object to query for key `k`
|
|
37
38
|
* @param k key to check existence in `obj`
|
|
38
39
|
*/
|
|
39
|
-
|
|
40
|
+
declare function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T;
|
|
40
41
|
/**
|
|
41
42
|
* Strict typed `Object.keys`
|
|
42
43
|
*
|
|
43
44
|
* @category Object
|
|
44
45
|
*/
|
|
45
|
-
|
|
46
|
+
declare function objectKeys<T extends object>(obj: T): (`${keyof T & undefined}` | `${keyof T & null}` | `${keyof T & string}` | `${keyof T & number}` | `${keyof T & false}` | `${keyof T & true}`)[];
|
|
46
47
|
/**
|
|
47
48
|
* Strict typed `Object.entries`
|
|
48
49
|
*
|
|
49
50
|
* @category Object
|
|
50
51
|
*/
|
|
51
|
-
|
|
52
|
+
declare function objectEntries<T extends object>(obj: T): [keyof T, T[keyof T]][];
|
|
52
53
|
/**
|
|
53
54
|
* Deep merge :P
|
|
54
55
|
*
|
|
55
56
|
* @category Object
|
|
56
57
|
*/
|
|
57
|
-
|
|
58
|
+
declare function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S>;
|
|
58
59
|
/**
|
|
59
60
|
* Create a new subset object by providing keys.
|
|
60
61
|
*
|
|
61
62
|
* @category Object
|
|
62
63
|
*/
|
|
63
|
-
|
|
64
|
+
declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
|
|
64
65
|
/**
|
|
65
66
|
* Clear undefined fields from an object. It mutates the object.
|
|
66
67
|
*
|
|
67
68
|
* @category Object
|
|
68
69
|
*/
|
|
69
|
-
|
|
70
|
+
declare function clearUndefined<T extends object>(obj: T): T;
|
|
70
71
|
/**
|
|
71
72
|
* Determines whether an object has a property with the specified name
|
|
72
73
|
*
|
|
73
74
|
* @see https://eslint.org/docs/rules/no-prototype-builtins
|
|
74
75
|
* @category Object
|
|
75
76
|
*/
|
|
76
|
-
|
|
77
|
+
declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;
|
|
78
|
+
|
|
79
|
+
export { clearUndefined, deepMerge, hasOwnProperty, isKeyOf, objectEntries, objectKeys, objectMap, objectPick };
|
package/dist/index.mjs
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
|
-
import { notNullish } from
|
|
2
|
-
import { isObject } from
|
|
3
|
-
export { Collection, collect } from
|
|
4
|
-
|
|
1
|
+
import { notNullish } from '@stacksjs/utils';
|
|
2
|
+
import { isObject } from '@stacksjs/validation';
|
|
3
|
+
export { Collection, collect } from '@stacksjs/collections';
|
|
4
|
+
|
|
5
|
+
function objectMap(obj, fn) {
|
|
5
6
|
return Object.fromEntries(
|
|
6
7
|
Object.entries(obj).map(([k, v]) => fn(k, v)).filter(notNullish)
|
|
7
8
|
);
|
|
8
9
|
}
|
|
9
|
-
|
|
10
|
+
function isKeyOf(obj, k) {
|
|
10
11
|
return k in obj;
|
|
11
12
|
}
|
|
12
|
-
|
|
13
|
+
function objectKeys(obj) {
|
|
13
14
|
return Object.keys(obj);
|
|
14
15
|
}
|
|
15
|
-
|
|
16
|
+
function objectEntries(obj) {
|
|
16
17
|
return Object.entries(obj);
|
|
17
18
|
}
|
|
18
|
-
|
|
19
|
+
function deepMerge(target, ...sources) {
|
|
19
20
|
if (!sources.length)
|
|
20
21
|
return target;
|
|
21
22
|
const source = sources.shift();
|
|
@@ -37,7 +38,7 @@ export function deepMerge(target, ...sources) {
|
|
|
37
38
|
function isMergeableObject(item) {
|
|
38
39
|
return isObject(item) && !Array.isArray(item);
|
|
39
40
|
}
|
|
40
|
-
|
|
41
|
+
function objectPick(obj, keys, omitUndefined = false) {
|
|
41
42
|
return keys.reduce((n, k) => {
|
|
42
43
|
if (k in obj) {
|
|
43
44
|
if (!omitUndefined || obj[k] !== void 0)
|
|
@@ -46,12 +47,14 @@ export function objectPick(obj, keys, omitUndefined = false) {
|
|
|
46
47
|
return n;
|
|
47
48
|
}, {});
|
|
48
49
|
}
|
|
49
|
-
|
|
50
|
+
function clearUndefined(obj) {
|
|
50
51
|
Object.keys(obj).forEach((key) => obj[key] === void 0 ? delete obj[key] : {});
|
|
51
52
|
return obj;
|
|
52
53
|
}
|
|
53
|
-
|
|
54
|
+
function hasOwnProperty(obj, v) {
|
|
54
55
|
if (obj == null)
|
|
55
56
|
return false;
|
|
56
57
|
return Object.prototype.hasOwnProperty.call(obj, v);
|
|
57
58
|
}
|
|
59
|
+
|
|
60
|
+
export { clearUndefined, deepMerge, hasOwnProperty, isKeyOf, objectEntries, objectKeys, objectMap, objectPick };
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacksjs/objects",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
5
|
-
"packageManager": "pnpm@8.5
|
|
4
|
+
"version": "0.56.3",
|
|
5
|
+
"packageManager": "pnpm@8.6.5",
|
|
6
6
|
"description": "The Stacks objects.",
|
|
7
7
|
"author": "Chris Breuer",
|
|
8
8
|
"license": "MIT",
|
|
@@ -38,12 +38,13 @@
|
|
|
38
38
|
"README.md"
|
|
39
39
|
],
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@stacksjs/collections": "0.
|
|
42
|
-
"@stacksjs/
|
|
43
|
-
"@stacksjs/
|
|
41
|
+
"@stacksjs/collections": "0.56.3",
|
|
42
|
+
"@stacksjs/utils": "0.56.3",
|
|
43
|
+
"@stacksjs/validation": "0.56.3",
|
|
44
|
+
"@stacksjs/types": "0.56.3"
|
|
44
45
|
},
|
|
45
46
|
"devDependencies": {
|
|
46
|
-
"@stacksjs/development": "0.
|
|
47
|
+
"@stacksjs/development": "0.56.3"
|
|
47
48
|
},
|
|
48
49
|
"scripts": {
|
|
49
50
|
"build": "unbuild",
|