@stacksjs/objects 0.67.0 → 0.68.1
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 +9 -83
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,85 +1,11 @@
|
|
|
1
|
-
import type { DeepMerge } from
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
* @category Object
|
|
7
|
-
*
|
|
8
|
-
* Transform:
|
|
9
|
-
* @example
|
|
10
|
-
* ```
|
|
11
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => [k.toString().toUpperCase(), v.toString()])
|
|
12
|
-
* // { A: '1', B: '2' }
|
|
13
|
-
* ```
|
|
14
|
-
*
|
|
15
|
-
* Swap key/value:
|
|
16
|
-
* @example
|
|
17
|
-
* ```
|
|
18
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => [v, k])
|
|
19
|
-
* // { 1: 'a', 2: 'b' }
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* Filter keys:
|
|
23
|
-
* @example
|
|
24
|
-
* ```
|
|
25
|
-
* objectMap({ a: 1, b: 2 }, (k, v) => k === 'a' ? undefined : [k, v])
|
|
26
|
-
* // { b: 2 }
|
|
27
|
-
* ```
|
|
28
|
-
*/
|
|
29
|
-
export declare function objectMap<
|
|
30
|
-
K extends string,
|
|
31
|
-
V,
|
|
32
|
-
NK = K,
|
|
33
|
-
NV = V
|
|
34
|
-
>(obj: Record<K, V>, fn: (key: K, value: V) => [NK, NV] | undefined): Record<K, V>;
|
|
35
|
-
/**
|
|
36
|
-
* Type guard for any key, `k`.
|
|
37
|
-
* Marks `k` as a key of `T` if `k` is in `obj`.
|
|
38
|
-
*
|
|
39
|
-
* @category Object
|
|
40
|
-
* @param obj object to query for key `k`
|
|
41
|
-
* @param k key to check existence in `obj`
|
|
42
|
-
*/
|
|
1
|
+
import type { DeepMerge } from '@stacksjs/types';
|
|
2
|
+
|
|
3
|
+
export 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> { return Object.fromEntries( Object.entries(obj) .map(([k, v]) => fn(k as K, v as V)) .filter(notNullish), ) };
|
|
43
4
|
export declare function isKeyOf<T extends object>(obj: T, k: keyof any): k is keyof T;
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
export declare function objectKeys<T extends object>(obj: T): Array<`${keyof T & (string | number | boolean | null | undefined)}`>;
|
|
50
|
-
/**
|
|
51
|
-
* Strict typed `Object.entries`
|
|
52
|
-
*
|
|
53
|
-
* @category Object
|
|
54
|
-
*/
|
|
55
|
-
export declare function objectEntries<T extends object>(obj: T): Array<[keyof T, T[keyof T]]>;
|
|
56
|
-
/**
|
|
57
|
-
* Deep merge :P
|
|
58
|
-
*
|
|
59
|
-
* @category Object
|
|
60
|
-
*/
|
|
61
|
-
export declare function deepMerge<
|
|
62
|
-
T extends object = object,
|
|
63
|
-
S extends object = T
|
|
64
|
-
>(target: T, ...sources: S[]): DeepMerge<T, S>;
|
|
65
|
-
/**
|
|
66
|
-
* Create a new subset object by providing keys.
|
|
67
|
-
*
|
|
68
|
-
* @category Object
|
|
69
|
-
*/
|
|
70
|
-
export declare function objectPick<
|
|
71
|
-
O extends object,
|
|
72
|
-
T extends keyof O
|
|
73
|
-
>(obj: O, keys: T[], omitUndefined?: boolean): Pick<O, T>;
|
|
74
|
-
/**
|
|
75
|
-
* Clear undefined fields from an object. It mutates the object.
|
|
76
|
-
*
|
|
77
|
-
* @category Object
|
|
78
|
-
*/
|
|
5
|
+
export declare function objectKeys<T extends object>(obj: T): void;
|
|
6
|
+
export declare function objectEntries<T extends object>(obj: T): void;
|
|
7
|
+
export declare function deepMerge<T extends object = object, S extends object = T>(target: T, ...sources: S[]): DeepMerge<T, S>;
|
|
8
|
+
declare function isMergeableObject(item: any): item is object;
|
|
9
|
+
export declare function objectPick<O extends object, T extends keyof O>(obj: O, keys: T[], omitUndefined = false): Pick<O, T>;
|
|
79
10
|
export declare function clearUndefined<T extends object>(obj: T): T;
|
|
80
|
-
|
|
81
|
-
* Determines whether an object has a property with the specified name
|
|
82
|
-
*
|
|
83
|
-
* @category Object
|
|
84
|
-
*/
|
|
85
|
-
export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;
|
|
11
|
+
export declare function hasOwnProperty<T>(obj: T, v: PropertyKey): boolean;
|