1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
6 |
|
7 |
|
8 |
|
9 |
|
10 |
|
11 |
|
12 |
|
13 |
|
14 |
|
15 |
|
16 | export const mapObjectSkip: unique symbol;
|
17 |
|
18 | export type Mapper<
|
19 | SourceObjectType extends Record<string, any>,
|
20 | MappedObjectKeyType extends string,
|
21 | MappedObjectValueType,
|
22 | > = (
|
23 | sourceKey: keyof SourceObjectType,
|
24 | sourceValue: SourceObjectType[keyof SourceObjectType],
|
25 | source: SourceObjectType
|
26 | ) => [
|
27 | targetKey: MappedObjectKeyType,
|
28 | targetValue: MappedObjectValueType,
|
29 | mapperOptions?: MapperOptions,
|
30 | ] | typeof mapObjectSkip;
|
31 |
|
32 | export interface Options {
|
33 | |
34 |
|
35 |
|
36 |
|
37 |
|
38 | readonly deep?: boolean;
|
39 |
|
40 | |
41 |
|
42 |
|
43 |
|
44 |
|
45 | readonly target?: Record<string, any>;
|
46 | }
|
47 |
|
48 | export interface DeepOptions extends Options {
|
49 | readonly deep: true;
|
50 | }
|
51 |
|
52 | export interface TargetOptions<TargetObjectType extends Record<string, any>> extends Options {
|
53 | readonly target: TargetObjectType;
|
54 | }
|
55 |
|
56 | export interface MapperOptions {
|
57 | |
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 |
|
64 | readonly shouldRecurse?: boolean;
|
65 | }
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 | export default function mapObject<
|
91 | SourceObjectType extends Record<string, unknown>,
|
92 | TargetObjectType extends Record<string, any>,
|
93 | MappedObjectKeyType extends string,
|
94 | MappedObjectValueType,
|
95 | >(
|
96 | source: SourceObjectType,
|
97 | mapper: Mapper<
|
98 | SourceObjectType,
|
99 | MappedObjectKeyType,
|
100 | MappedObjectValueType
|
101 | >,
|
102 | options: DeepOptions & TargetOptions<TargetObjectType>
|
103 | ): TargetObjectType & Record<string, unknown>;
|
104 | export default function mapObject<
|
105 | SourceObjectType extends Record<string, unknown>,
|
106 | MappedObjectKeyType extends string,
|
107 | MappedObjectValueType,
|
108 | >(
|
109 | source: SourceObjectType,
|
110 | mapper: Mapper<
|
111 | SourceObjectType,
|
112 | MappedObjectKeyType,
|
113 | MappedObjectValueType
|
114 | >,
|
115 | options: DeepOptions
|
116 | ): Record<string, unknown>;
|
117 | export default function mapObject<
|
118 | SourceObjectType extends Record<string, any>,
|
119 | TargetObjectType extends Record<string, any>,
|
120 | MappedObjectKeyType extends string,
|
121 | MappedObjectValueType,
|
122 | >(
|
123 | source: SourceObjectType,
|
124 | mapper: Mapper<
|
125 | SourceObjectType,
|
126 | MappedObjectKeyType,
|
127 | MappedObjectValueType
|
128 | >,
|
129 | options: TargetOptions<TargetObjectType>
|
130 | ): TargetObjectType & {[K in MappedObjectKeyType]: MappedObjectValueType};
|
131 | export default function mapObject<
|
132 | SourceObjectType extends Record<string, any>,
|
133 | MappedObjectKeyType extends string,
|
134 | MappedObjectValueType,
|
135 | >(
|
136 | source: SourceObjectType,
|
137 | mapper: Mapper<
|
138 | SourceObjectType,
|
139 | MappedObjectKeyType,
|
140 | MappedObjectValueType
|
141 | >,
|
142 | options?: Options
|
143 | ): {[K in MappedObjectKeyType]: MappedObjectValueType};
|