@stacksjs/objects 0.65.0 → 0.67.0
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.js +1 -4
- package/package.json +7 -9
- package/dist/index.js.map +0 -10
- package/src/index.ts +0 -150
package/dist/index.js
CHANGED
|
@@ -1,5 +1,2 @@
|
|
|
1
1
|
// @bun
|
|
2
|
-
import{notNullish as F}from"@stacksjs/utils";import{isObject as G}from"@stacksjs/validation";function L(q,x){return Object.fromEntries(Object.entries(q).map(([A,z])=>x(A,z)).filter(F))}function P(q,x){return x in q}function H(q){return Object.keys(q)}function Q(q){return Object.entries(q)}function E(q,...x){if(!x.length)return q;
|
|
3
|
-
|
|
4
|
-
//# debugId=F1DD95F2B382242F64756E2164756E21
|
|
5
|
-
//# sourceMappingURL=index.js.map
|
|
2
|
+
import{notNullish as F}from"@stacksjs/utils";import{isObject as G}from"@stacksjs/validation";function L(q,x){return Object.fromEntries(Object.entries(q).map(([A,z])=>x(A,z)).filter(F))}function P(q,x){return x in q}function H(q){return Object.keys(q)}function Q(q){return Object.entries(q)}function E(q,...x){if(!x.length)return q;let A=x.shift();if(A===void 0)return q;if(C(q)&&C(A))H(A).forEach((z)=>{if(C(A[z])){if(!q[z])q[z]={};E(q[z],A[z])}else q[z]=A[z]});return E(q,...x)}function C(q){return G(q)&&!Array.isArray(q)}function R(q,x,A=!1){return x.reduce((z,B)=>{if(B in q){if(!A||q[B]!==void 0)z[B]=q[B]}return z},{})}function S(q){return Object.keys(q).forEach((x)=>q[x]===void 0&&delete q[x]),q}function T(q,x){return q==null?!1:Object.prototype.hasOwnProperty.call(q,x)}export{R as objectPick,L as objectMap,H as objectKeys,Q as objectEntries,P as isKeyOf,T as hasOwnProperty,E as deepMerge,S as clearUndefined};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stacksjs/objects",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.67.0",
|
|
5
5
|
"description": "The Stacks objects.",
|
|
6
6
|
"author": "Chris Breuer",
|
|
7
7
|
"contributors": ["Chris Breuer <chris@stacksjs.org>"],
|
|
@@ -19,29 +19,27 @@
|
|
|
19
19
|
"keywords": ["objects", "utilities", "functions", "stacks"],
|
|
20
20
|
"exports": {
|
|
21
21
|
".": {
|
|
22
|
-
"bun": "./src/index.ts",
|
|
23
22
|
"import": "./dist/index.js"
|
|
24
23
|
},
|
|
25
24
|
"./*": {
|
|
26
|
-
"bun": "./src/*",
|
|
27
25
|
"import": "./dist/*"
|
|
28
26
|
}
|
|
29
27
|
},
|
|
30
28
|
"module": "dist/index.js",
|
|
31
29
|
"types": "dist/index.d.ts",
|
|
32
|
-
"files": ["README.md", "dist"
|
|
30
|
+
"files": ["README.md", "dist"],
|
|
33
31
|
"scripts": {
|
|
34
32
|
"build": "bun build.ts",
|
|
35
33
|
"typecheck": "bun tsc --noEmit",
|
|
36
34
|
"prepublishOnly": "bun run build"
|
|
37
35
|
},
|
|
38
36
|
"dependencies": {
|
|
39
|
-
"@stacksjs/collections": "0.
|
|
40
|
-
"@stacksjs/types": "0.
|
|
41
|
-
"@stacksjs/utils": "0.
|
|
42
|
-
"@stacksjs/validation": "0.
|
|
37
|
+
"@stacksjs/collections": "0.67.0",
|
|
38
|
+
"@stacksjs/types": "0.67.0",
|
|
39
|
+
"@stacksjs/utils": "0.67.0",
|
|
40
|
+
"@stacksjs/validation": "0.67.0"
|
|
43
41
|
},
|
|
44
42
|
"devDependencies": {
|
|
45
|
-
"@stacksjs/development": "0.
|
|
43
|
+
"@stacksjs/development": "0.67.0"
|
|
46
44
|
}
|
|
47
45
|
}
|
package/dist/index.js.map
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"version": 3,
|
|
3
|
-
"sources": ["../src/index.ts"],
|
|
4
|
-
"sourcesContent": [
|
|
5
|
-
"import type { DeepMerge } from '@stacksjs/types'\nimport { notNullish } from '@stacksjs/utils'\nimport { isObject } from '@stacksjs/validation'\n\n/**\n * Map key/value pairs for an object, and construct a new one\n *\n *\n * @category Object\n *\n * Transform:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])\n * // { A: '1', B: '2' }\n * ```\n *\n * Swap key/value:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => [v, k])\n * // { 1: 'a', 2: 'b' }\n * ```\n *\n * Filter keys:\n * @example\n * ```\n * objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])\n * // { b: 2 }\n * ```\n */\nexport function objectMap<K extends string, V, NK = K, NV = V>(\n obj: Record<K, V>,\n fn: (key: K, value: V) => [NK, NV] | undefined,\n): Record<K, V> {\n return Object.fromEntries(\n Object.entries(obj)\n .map(([k, v]) => fn(k as K, v as V))\n .filter(notNullish),\n )\n}\n\n/**\n * Type guard for any key, `k`.\n * Marks `k` as a key of `T` if `k` is in `obj`.\n *\n * @category Object\n * @param obj object to query for key `k`\n * @param k key to check existence in `obj`\n */\nexport function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {\n return k in obj\n}\n\n/**\n * Strict typed `Object.keys`\n *\n * @category Object\n */\nexport function objectKeys<T extends object>(obj: T) {\n return Object.keys(obj) as Array<`${keyof T & (string | number | boolean | null | undefined)}`>\n}\n\n/**\n * Strict typed `Object.entries`\n *\n * @category Object\n */\nexport function objectEntries<T extends object>(obj: T) {\n return Object.entries(obj) as Array<[keyof T, T[keyof T]]>\n}\n\n/**\n * Deep merge :P\n *\n * @category Object\n */\nexport function deepMerge<T extends object = object, S extends object = T>(\n target: T,\n ...sources: S[]\n): DeepMerge<T, S> {\n if (!sources.length)\n return target as any\n\n const source = sources.shift()\n if (source === undefined)\n return target as any\n\n if (isMergeableObject(target) && isMergeableObject(source)) {\n objectKeys(source).forEach((key) => {\n // @ts-expect-error some description\n if (isMergeableObject(source[key])) {\n // @ts-expect-error some description\n if (!target[key])\n // @ts-expect-error some description\n target[key] = {}\n\n // @ts-expect-error some description\n deepMerge(target[key], source[key])\n }\n else {\n // @ts-expect-error some description\n target[key] = source[key]\n }\n })\n }\n\n return deepMerge(target, ...sources)\n}\n\nfunction isMergeableObject(item: any): item is object {\n return isObject(item) && !Array.isArray(item)\n}\n\n/**\n * Create a new subset object by providing keys.\n *\n * @category Object\n */\nexport function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false): Pick<O, T> {\n return keys.reduce(\n (n, k) => {\n if (k in obj) {\n if (!omitUndefined || obj[k] !== undefined)\n n[k] = obj[k]\n }\n return n\n },\n {} as Pick<O, T>,\n )\n}\n\n/**\n * Clear undefined fields from an object. It mutates the object.\n *\n * @category Object\n */\nexport function clearUndefined<T extends object>(obj: T): T {\n ;(Object.keys(obj) as Array<keyof T>).forEach(key => obj[key] === undefined && delete obj[key])\n return obj\n}\n\n/**\n * Determines whether an object has a property with the specified name\n *\n * @category Object\n */\nexport function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean {\n return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)\n}\n"
|
|
6
|
-
],
|
|
7
|
-
"mappings": ";AACA,qBAAS,wBACT,mBAAS,6BA6BF,SAAS,CAA8C,CAC5D,EACA,EACc,CACd,OAAO,OAAO,YACZ,OAAO,QAAQ,CAAG,EACf,IAAI,EAAE,EAAG,KAAO,EAAG,EAAQ,CAAM,CAAC,EAClC,OAAO,CAAU,CACtB,EAWK,SAAS,CAAyB,CAAC,EAAQ,EAA4B,CAC5E,OAAO,KAAK,EAQP,SAAS,CAA4B,CAAC,EAAQ,CACnD,OAAO,OAAO,KAAK,CAAG,EAQjB,SAAS,CAA+B,CAAC,EAAQ,CACtD,OAAO,OAAO,QAAQ,CAAG,EAQpB,SAAS,CAA0D,CACxE,KACG,EACc,CACjB,IAAK,EAAQ,OACX,OAAO,EAET,MAAM,EAAS,EAAQ,MAAM,EAC7B,GAAI,IAAW,OACb,OAAO,EAET,GAAI,EAAkB,CAAM,GAAK,EAAkB,CAAM,EACvD,EAAW,CAAM,EAAE,QAAQ,CAAC,IAAQ,CAElC,GAAI,EAAkB,EAAO,EAAI,EAAG,CAElC,IAAK,EAAO,GAEV,EAAO,GAAO,CAAC,EAGjB,EAAU,EAAO,GAAM,EAAO,EAAI,MAIlC,GAAO,GAAO,EAAO,GAExB,EAGH,OAAO,EAAU,EAAQ,GAAG,CAAO,EAGrC,SAAS,CAAiB,CAAC,EAA2B,CACpD,OAAO,EAAS,CAAI,IAAM,MAAM,QAAQ,CAAI,EAQvC,SAAS,CAA+C,CAAC,EAAQ,EAAW,EAAgB,GAAmB,CACpH,OAAO,EAAK,OACV,CAAC,EAAG,IAAM,CACR,GAAI,KAAK,GACP,IAAK,GAAiB,EAAI,KAAO,OAC/B,EAAE,GAAK,EAAI,GAEf,OAAO,GAET,CAAC,CACH,EAQK,SAAS,CAAgC,CAAC,EAAW,CAE1D,OADE,OAAO,KAAK,CAAG,EAAqB,QAAQ,KAAO,EAAI,KAAS,eAAoB,EAAI,EAAI,EACvF,EAQF,SAAS,CAAiB,CAAC,EAAQ,EAAyB,CACjE,OAAO,GAAO,KAAO,GAAQ,OAAO,UAAU,eAAe,KAAK,EAAK,CAAC",
|
|
8
|
-
"debugId": "F1DD95F2B382242F64756E2164756E21",
|
|
9
|
-
"names": []
|
|
10
|
-
}
|
package/src/index.ts
DELETED
|
@@ -1,150 +0,0 @@
|
|
|
1
|
-
import type { DeepMerge } from '@stacksjs/types'
|
|
2
|
-
import { notNullish } from '@stacksjs/utils'
|
|
3
|
-
import { isObject } from '@stacksjs/validation'
|
|
4
|
-
|
|
5
|
-
/**
|
|
6
|
-
* Map key/value pairs for an object, and construct a new one
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* @category Object
|
|
10
|
-
*
|
|
11
|
-
* Transform:
|
|
12
|
-
* @example
|
|
13
|
-
* ```
|
|
14
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])
|
|
15
|
-
* // { A: '1', B: '2' }
|
|
16
|
-
* ```
|
|
17
|
-
*
|
|
18
|
-
* Swap key/value:
|
|
19
|
-
* @example
|
|
20
|
-
* ```
|
|
21
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => [v, k])
|
|
22
|
-
* // { 1: 'a', 2: 'b' }
|
|
23
|
-
* ```
|
|
24
|
-
*
|
|
25
|
-
* Filter keys:
|
|
26
|
-
* @example
|
|
27
|
-
* ```
|
|
28
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])
|
|
29
|
-
* // { b: 2 }
|
|
30
|
-
* ```
|
|
31
|
-
*/
|
|
32
|
-
export function objectMap<K extends string, V, NK = K, NV = V>(
|
|
33
|
-
obj: Record<K, V>,
|
|
34
|
-
fn: (key: K, value: V) => [NK, NV] | undefined,
|
|
35
|
-
): Record<K, V> {
|
|
36
|
-
return Object.fromEntries(
|
|
37
|
-
Object.entries(obj)
|
|
38
|
-
.map(([k, v]) => fn(k as K, v as V))
|
|
39
|
-
.filter(notNullish),
|
|
40
|
-
)
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* Type guard for any key, `k`.
|
|
45
|
-
* Marks `k` as a key of `T` if `k` is in `obj`.
|
|
46
|
-
*
|
|
47
|
-
* @category Object
|
|
48
|
-
* @param obj object to query for key `k`
|
|
49
|
-
* @param k key to check existence in `obj`
|
|
50
|
-
*/
|
|
51
|
-
export function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T {
|
|
52
|
-
return k in obj
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
/**
|
|
56
|
-
* Strict typed `Object.keys`
|
|
57
|
-
*
|
|
58
|
-
* @category Object
|
|
59
|
-
*/
|
|
60
|
-
export function objectKeys<T extends object>(obj: T) {
|
|
61
|
-
return Object.keys(obj) as Array<`${keyof T & (string | number | boolean | null | undefined)}`>
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Strict typed `Object.entries`
|
|
66
|
-
*
|
|
67
|
-
* @category Object
|
|
68
|
-
*/
|
|
69
|
-
export function objectEntries<T extends object>(obj: T) {
|
|
70
|
-
return Object.entries(obj) as Array<[keyof T, T[keyof T]]>
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Deep merge :P
|
|
75
|
-
*
|
|
76
|
-
* @category Object
|
|
77
|
-
*/
|
|
78
|
-
export function deepMerge<T extends object = object, S extends object = T>(
|
|
79
|
-
target: T,
|
|
80
|
-
...sources: S[]
|
|
81
|
-
): DeepMerge<T, S> {
|
|
82
|
-
if (!sources.length)
|
|
83
|
-
return target as any
|
|
84
|
-
|
|
85
|
-
const source = sources.shift()
|
|
86
|
-
if (source === undefined)
|
|
87
|
-
return target as any
|
|
88
|
-
|
|
89
|
-
if (isMergeableObject(target) && isMergeableObject(source)) {
|
|
90
|
-
objectKeys(source).forEach((key) => {
|
|
91
|
-
// @ts-expect-error some description
|
|
92
|
-
if (isMergeableObject(source[key])) {
|
|
93
|
-
// @ts-expect-error some description
|
|
94
|
-
if (!target[key])
|
|
95
|
-
// @ts-expect-error some description
|
|
96
|
-
target[key] = {}
|
|
97
|
-
|
|
98
|
-
// @ts-expect-error some description
|
|
99
|
-
deepMerge(target[key], source[key])
|
|
100
|
-
}
|
|
101
|
-
else {
|
|
102
|
-
// @ts-expect-error some description
|
|
103
|
-
target[key] = source[key]
|
|
104
|
-
}
|
|
105
|
-
})
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
return deepMerge(target, ...sources)
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
function isMergeableObject(item: any): item is object {
|
|
112
|
-
return isObject(item) && !Array.isArray(item)
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* Create a new subset object by providing keys.
|
|
117
|
-
*
|
|
118
|
-
* @category Object
|
|
119
|
-
*/
|
|
120
|
-
export function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false): Pick<O, T> {
|
|
121
|
-
return keys.reduce(
|
|
122
|
-
(n, k) => {
|
|
123
|
-
if (k in obj) {
|
|
124
|
-
if (!omitUndefined || obj[k] !== undefined)
|
|
125
|
-
n[k] = obj[k]
|
|
126
|
-
}
|
|
127
|
-
return n
|
|
128
|
-
},
|
|
129
|
-
{} as Pick<O, T>,
|
|
130
|
-
)
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* Clear undefined fields from an object. It mutates the object.
|
|
135
|
-
*
|
|
136
|
-
* @category Object
|
|
137
|
-
*/
|
|
138
|
-
export function clearUndefined<T extends object>(obj: T): T {
|
|
139
|
-
;(Object.keys(obj) as Array<keyof T>).forEach(key => obj[key] === undefined && delete obj[key])
|
|
140
|
-
return obj
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* Determines whether an object has a property with the specified name
|
|
145
|
-
*
|
|
146
|
-
* @category Object
|
|
147
|
-
*/
|
|
148
|
-
export function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean {
|
|
149
|
-
return obj == null ? false : Object.prototype.hasOwnProperty.call(obj, v)
|
|
150
|
-
}
|