-
-
Notifications
You must be signed in to change notification settings - Fork 399
/
index.d.ts
197 lines (179 loc) · 4 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/// <reference types="@stdlib/types"/>
/**
* Merge strategy.
*
* @returns merged value
*/
type Nullary = () => any;
/**
* Merge strategy.
*
* @param a - target value
* @returns merged value
*/
type Unary = ( a: any ) => any;
/**
* Merge strategy.
*
* @param a - target value
* @param b - source value
* @returns merged value
*/
type Binary = ( a: any, b: any ) => any;
/**
* Merge strategy.
*
* @param a - target value
* @param b - source value
* @param key - object key
* @returns merged value
*/
type Ternary = ( a: any, b: any, key: string | symbol ) => any;
/**
* Merge strategy.
*
* @param a - target value
* @param b - source value
* @param key - object key
* @returns merged value
*/
type MergeStrategy = Nullary | Unary | Binary | Ternary;
/**
* Merges objects into a target object.
*
* ## Notes
*
* - The target object is mutated.
*
* @param target - target object
* @param source - source objects (i.e., objects to be merged into the target object)
* @returns merged (target) object
*/
type MergeFunction = ( target: any, ...source: Array<any> ) => any;
/**
* Interface defining function options.
*/
interface Options {
/**
* Merge level.
*/
level?: number;
/**
* Boolean indicating whether to deep copy merged values.
*/
copy?: boolean;
/**
* Defines the merge strategy.
*/
override?: boolean | MergeStrategy;
/**
* Boolean indicating whether new properties can be added to the target object.
*/
extend?: boolean;
}
/**
* Interface for merging objects.
*/
interface Merge {
/**
* Merges objects into a target object.
*
* ## Notes
*
* - The target object is mutated.
*
* @param target - target object
* @param source - source objects (i.e., objects to be merged into the target object)
* @returns merged (target) object
*
* @example
* var target = {
* 'a': 'beep'
* };
* var source = {
* 'a': 'boop',
* 'b': 'bap'
* };
*
* var out = merge( target, source );
* // returns {'a':'boop', 'b':'bap'}
*/
( target: any, ...source: Array<any> ): any;
/**
* Returns a function for merging and extending objects.
*
* @param options - merge options
* @param options.level - merge level (default: Infinity)
* @param options.copy - boolean indicating whether to deep copy merged values (default: true)
* @param options.override - defines the merge strategy (default: true)
* @param options.extend - boolean indicating whether new properties can be added to the target object (default: true)
* @returns function which can be used to merge objects
*
* @example
* var opts = {
* 'level': 100,
* 'copy': true,
* 'override': true,
* 'extend': true
* };
*
* var mergefcn = merge.factory( opts );
* // returns <Function>
*/
factory( options: Options ): MergeFunction;
}
/**
* Merges objects into a target object.
*
* ## Notes
*
* - The target object is mutated.
*
* @param target - target object
* @param source - source objects (i.e., objects to be merged into the target object)
* @returns merged (target) object
*
* @example
* var target = {
* 'a': 'beep'
* };
* var source = {
* 'a': 'boop',
* 'b': 'bap'
* };
*
* var out = merge( target, source );
* // returns {'a':'boop', 'b':'bap'}
*
* @example
* var opts = {
* 'level': 100,
* 'copy': true,
* 'override': true,
* 'extend': true
* };
*
* var mergefcn = merge.factory( opts );
* // returns <Function>
*/
declare var merge: Merge;
// EXPORTS //
export = merge;