-
-
Notifications
You must be signed in to change notification settings - Fork 399
/
index.d.ts
431 lines (406 loc) · 13.3 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
/*
* @license Apache-2.0
*
* Copyright (c) 2021 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
/**
* Interface defining function options.
*/
interface Options {
/**
* The maximum number of pending invocations at any one time.
*/
limit?: number;
/**
* Boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false).
*/
series?: boolean;
/**
* Execution context.
*/
thisArg?: any;
}
/**
* Callback invoked upon completion.
*/
type DoneNullary = () => void;
/**
* Callback invoked upon completion.
*
* @param error - encountered error or null
*/
type DoneUnary = ( error: Error | null ) => void;
/**
* Callback invoked upon completion.
*
* @param error - encountered error or null
* @param out - output object
*/
type DoneBinary = ( error: Error | null, out: any ) => void;
/**
* Callback invoked upon completion.
*
* @param error - encountered error or null
* @param out - output object
*/
type DoneCallback = DoneNullary | DoneUnary | DoneBinary;
/**
* Callback function.
*/
type Nullary = () => void;
/**
* Callback function.
*
* @param error - encountered error or null
*/
type Unary = ( error: Error | null ) => void;
/**
* Callback function.
*
* @param error - encountered error or null
* @param group - value group
*/
type Binary = ( error: Error | null, group: string ) => void;
/**
* Callback function.
*
* @param error - encountered error or null
* @param group - value group
*/
type Callback = Nullary | Unary | Binary;
/**
* Transform function.
*
* @param key - object key
* @param next - a callback to be invoked after processing an object `value`
*/
type BinaryTransform = ( value: any, next: Callback ) => void;
/**
* Transform function.
*
* @param key - object key
* @param value - object value corresponding to `key`
* @param next - a callback to be invoked after processing an object `value`
*/
type TernaryTransform = ( value: any, index: number, next: Callback ) => void;
/**
* Transform function.
*
* @param key - object key
* @param value - object value corresponding to `key`
* @param obj - the input object
* @param next - a callback to be invoked after processing an object `value`
*/
type QuaternaryTransform = ( value: any, index: number, obj: any, next: Callback ) => void; // tslint-disable-line max-line-length
/**
* Transform function.
*
* @param key - object key
* @param value - object value corresponding to `key`
* @param obj - the input object
* @param next - a callback to be invoked after processing an object `value`
*/
type Transform = Unary | BinaryTransform | TernaryTransform | QuaternaryTransform; // tslint-disable-line max-line-length
/**
* Maps keys from one object to a new object having the same values.
*
* @param obj - the input object
* @param done - function to invoke upon completion
*/
type FactoryFunction = ( obj: any, done: DoneCallback ) => void;
/**
* Interface for `mapValuesAsync`.
*/
interface MapValuesAsync {
/**
* Maps values from one object to a new object having the same keys.
*
* ## Notes
*
* - If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
* - This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
* - Iteration and insertion order are **not** guaranteed.
* - The function only operates on own properties, not inherited properties.
*
*
* @param obj - source object
* @param options - function options
* @param options.thisArg - execution context
* @param options.limit - maximum number of pending invocations at any one time
* @param options.series - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false)
* @param transform - transform function
* @param done - function to invoke upon completion
* @throws must provide valid options
*
* @example
* var stat = require( `fs` ).stat;
*
* function getStats( file, next ) {
* stat( file, onStats );
*
* function onStats( error, data ) {
* if ( error ) {
* return next( error );
* }
* next( null, data );
* }
* }
*
* // Define a callback which handles errors:
* function done( error, out ) {
* if ( error ) {
* throw error;
* }
* console.log( out );
* }
*
* // Create a dictionary of file names:
* var files = {
* 'file1': './beep.js',
* 'file2': './boop.js'
* };
*
* var opts = {
* 'series': true
* };
*
* // Process each file in `files`:
* mapValuesAsync( files, opts, getStats, done );
*/
( obj: any, options: Options, transform: Transform, done: DoneCallback ): void; // tslint-disable-line max-line-length
/**
* Maps values from one object to a new object having the same keys.
*
* ## Notes
*
* - If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
* - This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
* - Iteration and insertion order are **not** guaranteed.
* - The function only operates on own properties, not inherited properties.
*
*
* @param obj - source object
* @param options - function options
* @param options.thisArg - execution context
* @param options.limit - maximum number of pending invocations at any one time
* @param options.series - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false)
* @param transform - transform function
* @param done - function to invoke upon completion
* @throws must provide valid options
*
* @example
* var stat = require( 'fs' ).stat;
*
* function getStats( file, next ) {
* stat( file, onStats );
*
* function onStats( error, data ) {
* if ( error ) {
* return next( error );
* }
* next( null, data );
* }
* }
*
* // Define a callback which handles errors:
* function done( error, out ) {
* if ( error ) {
* throw error;
* }
* console.log( out );
* }
*
* // Create a dictionary of file names:
* var files = {
* 'file1': './beep.js',
* 'file2': './boop.js'
* };
*
* // Process each file in `files`:
* mapValuesAsync( files, getStats, done );
*/
( obj: any, transform: Transform, done: DoneCallback ): void;
/**
* Returns a function to map values from one object to a new object having the same keys.
*
* ## Notes
*
* - If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
* - This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
* - Iteration and insertion order are **not** guaranteed.
* - The function only operates on own properties, not inherited properties.
*
*
* @param options - function options
* @param options.thisArg - execution context
* @param options.limit - maximum number of pending invocations at any one time
* @param options.series - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false)
* @param transform - transform function
* @throws must provide valid options
* @returns function which maps values from one object to a new object having the same keys
*
* @example
* var stat = require( 'fs' ).stat;
*
* function getStats( file, next ) {
* stat( file, onStats );
*
* function onStats( error, data ) {
* if ( error ) {
* return next( error );
* }
* next( null, data );
* }
* }
*
* var opts = {
* 'series': true
* };
*
* // Create a reusable function:
* var mapValuesAsync = factory( opts, getStats );
*
* // Create a dictionary of file names:
* var files = {
* 'file1': './beep.js',
* 'file2': './boop.js'
* };
*
* // Define a callback which handles errors:
* function done( error, out ) {
* if ( error ) {
* throw error;
* }
* console.log( out );
* }
*
* // Process each file in `files`:
* mapValuesAsync( files, done );
*/
factory( options: Options, transform: Transform ): FactoryFunction;
/**
* Returns a function to map values from one object to a new object having the same keys.
*
* ## Notes
*
* - If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
* - This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
* - Iteration and insertion order are **not** guaranteed.
* - The function only operates on own properties, not inherited properties.
*
*
* @param options - function options
* @param options.thisArg - execution context
* @param options.limit - maximum number of pending invocations at any one time
* @param options.series - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false)
* @param transform - transform function
* @throws must provide valid options
* @returns function which maps values from one object to a new object having the same keys
*
* @example
* var stat = require( 'fs' ).stat;
*
* function getStats( file, next ) {
* stat( file, onStats );
*
* function onStats( error, data ) {
* if ( error ) {
* return next( error );
* }
* next( null, data );
* }
* }
*
* // Create a reusable function:
* var mapValuesAsync = factory( getStats );
*
* // Create a dictionary of file names:
* var files = {
* 'file1': './beep.js',
* 'file2': './boop.js'
* };
*
* // Define a callback which handles errors:
* function done( error, out ) {
* if ( error ) {
* throw error;
* }
* console.log( out );
* }
*
* // Process each file in `files`:
* mapValuesAsync( files, done );
*/
factory( transform: Transform ): FactoryFunction;
}
/**
* Maps values from one object to a new object having the same keys.
*
* ## Notes
*
* - If a provided function calls the provided callback with a truthy error argument, the function suspends execution and immediately calls the `done` callback for subsequent error handling.
* - This function does **not** guarantee that execution is asynchronous. To do so, wrap the `done` callback in a function which either executes at the end of the current stack (e.g., `nextTick`) or during a subsequent turn of the event loop (e.g., `setImmediate`, `setTimeout`).
* - Iteration and insertion order are **not** guaranteed.
* - The function only operates on own properties, not inherited properties.
*
*
* @param obj - source object
* @param options - function options
* @param options.thisArg - execution context
* @param options.limit - maximum number of pending invocations at any one time
* @param options.series - boolean indicating whether to wait for a previous invocation to complete before invoking a provided function for the next own property (default: false)
* @param transform - transform function
* @param done - function to invoke upon completion
* @throws must provide valid options
*
* @example
* var stat = require( `fs` ).stat;
*
* function getStats( file, next ) {
* stat( file, onStats );
*
* function onStats( error, data ) {
* if ( error ) {
* return next( error );
* }
* next( null, data );
* }
* }
*
* // Define a callback which handles errors:
* function done( error, out ) {
* if ( error ) {
* throw error;
* }
* console.log( out );
* }
*
* // Create a dictionary of file names:
* var files = {
* 'file1': './beep.js',
* 'file2': './boop.js'
* };
*
* var opts = {
* 'series': true
* };
*
* // Process each file in `files`:
* mapValuesAsync( files, opts, getStats, done );
*/
declare var mapValuesAsync: MapValuesAsync;
// EXPORTS //
export = mapValuesAsync;