generated from codibre/boilerplate-base
-
Notifications
You must be signed in to change notification settings - Fork 2
/
index.d.ts
267 lines (257 loc) · 9.31 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
/* eslint-disable no-magic-numbers */
export declare const augments: unique symbol;
export declare const baseIterable: unique symbol;
export declare type AnyIterable<T> = Iterable<T> | AsyncIterable<T>;
/**
* Represents a predicate on type `T`.<br>
* Example: `const evenNumber: Predicate<number> = n => (n % 2) === 0;`
* @typeparam T The type the predicate is defined on.
*/
export declare interface Predicate<T> {
/**
* Evaluates an item of type `T`.
* @param item The item evaluated.
* @returns `true` if the predicate passed on `item`; otherwise `false`.
*/
(item: T): any;
}
/**
* Represents an asynchronous predicate on type `T`.<br>
* Example: `const userExists: AsyncPredicate<User> = async user => !!(await getUser(user.id))`
* @typeparam T The type the predicate is defined on.
*/
interface AsyncPredicate<T> {
/**
* Asynchronously evaluates an item of type `T`.
* @param item The item evaluated.
* @returns A promise of `true` if the predicate passed on `item`; otherwise a promise of `false`.
*/
(item: T): Promise<any> | any;
}
/**
* Represents a mapping operation from type `T` to type `R`.<br>
* Example: ``const userToPrintable: Mapper<User, string> = user => `${user.name} (id: ${user.id})` ``
* @typeparam T The source type.
* @typeparam R The destination type.
*/
interface Mapper<T, R> {
/**
* Maps an item of type `T` into an instance of type `R`.
* @param item The item to map.
* @returns The map of `item`.
*/
(item: T): R;
}
/**
* Represents a asynchronous mapping operation from type `T` to type `R`.<br>
* Example: `const idToUser: AsyncMapper<number, User> = async id => await getUser(id)`<br>
* Note: in the example above, `getUser` function is already an [[AsyncMapper]].
* @typeparam T The source type.
* @typeparam R The destination type.
*/
interface AsyncMapper<T, R> {
/**
* Asynchronously maps an item of type `T` into an instance of type `R`.
* @param item The item to map.
* @returns A promise of the map of `item`.
*/
(item: T): Promise<R> | R;
}
/**
* Performs a forEach operation over the informed iterable applying the augmentative arguments. To use this function,
* you need to bind it to your iterable or call it with call, like .call(originalIterable, mapper)
* @param this: The original iterable you need to bind
* @param action the predicate function
*/
export declare function augmentativeForEach<T>(
this: Iterable<T>,
action: Predicate<T>,
): void;
/**
* Performs a forEach operation over the informed async iterable applying the augmentative arguments. To use this function,
* you need to bind it to your async iterable or call it with call, like .call(originalIterable, mapper)
* @param this: The original iterable or async iterable you need to bind
* @param action the predicate function
*/
export declare function augmentativeForEachAsync<T>(
this: AnyIterable<T>,
action: AsyncPredicate<T>,
): Promise<void>;
/**
* Performs an toArray operation over the informed iterable. To use this function,
* you need to bind it to your iterable or call it with call, like .call(originalIterable, mapper)
* @param this: The original iterable you need to bind
*/
export declare function augmentativeToArray<T>(this: Iterable<T>): T[];
/**
* Performs an toArray operation over the informed async iterable. To use this function,
* you need to bind it to your iterable or use the call method, like this: .call(originalIterable, mapper)
* @param this: The original async iterable you need to bind
*/
export declare function augmentativeToArrayAsync<T>(
this: AnyIterable<T>,
): Promise<T[]>;
/**
* Returns an iterable that returns only the values of the original iterable that passes the informed predicate
* @param it the original iterable
* @param mapper the predicate function
*/
export declare function filterIterable<T>(
it: Iterable<T>,
predicate: Predicate<T>,
): Iterable<T>;
/**
* Returns an async iterable that returns only the values of the original async iterable that passes the informed predicate
* @param it the original async iterable or iterable
* @param mapper the predicate function
*/
export declare function filterAsyncIterable<T>(
it: AnyIterable<T>,
predicate: AsyncPredicate<T>,
): AsyncIterable<T>;
/**
* Returns an iterable that maps each value of the iterable using the function provided
* @param it the original iterable
* @param mapper the mapping function
*/
export declare function mapIterable<T, R>(
it: Iterable<T>,
mapper: Mapper<T, R>,
): Iterable<T>;
/**
* Returns an async iterable that maps each value of the async iterable using the function provided
* @param it the original async iterable or iterable
* @param mapper the mapping function
*/
export declare function mapAsyncIterable<T, R>(
it: AnyIterable<T>,
mapper: AsyncMapper<T, R>,
): AsyncIterable<T>;
/**
* Add a flatMap augment for the iterable. It will returns a new iterable with tne new mapped item type.
* @param it the original iterable
* @param mapper the mapping function
*/
export declare function flatMapIterable<T, R = T extends AnyIterable<infer Sub> ? Sub : never>(
it: Iterable<T>,
mapper?: AsyncMapper<T, AnyIterable<R>>,
): Iterable<R>;
/**
* Add a flatMap augment for the iterable. It will returns a new iterable with tne new mapped item type.
* @param it the original iterable
* @param mapper the mapping function
*/
export declare function flatMapAsyncIterable<T, R = T extends AnyIterable<infer Sub> ? Sub : never>(
it: AnyIterable<T>,
mapper?: AsyncMapper<T, AnyIterable<R>>,
): AsyncIterable<R>;
/**
* Skips the first offset elements and then yields the next ones
* @param it the original iterable
* @param offset the number of offset elements
*/
export declare function skipIterable<T>(
it: Iterable<T>,
offset: number,
): Iterable<T>;
/**
* Skips the first offset elements and then yields the next ones
* @param it the original async iterable
* @param offset the number of offset elements
*/
export declare function skipAsyncIterable<T>(
it: AnyIterable<T>,
offset: number,
): AsyncIterable<T>;
/**
* Returns an iterable that stop to iterate over the values of the original iterable when the informed condition resolves to true.
* @param it the original iterable
* @param predicate the stop condition
*/
export declare function takeWhileIterable<T>(
it: Iterable<T>,
predicate: Predicate<T>,
): Iterable<T>;
/**
* Returns an async iterable that stop to iterate over the values of the original async iterable when the informed condition resolves to true.
* @param it the original iterable or async iterable
* @param predicate the stop condition
*/
export declare function takeWhileAsyncIterable<T>(
it: AnyIterable<T>,
predicate: AsyncPredicate<T>,
): AsyncIterable<T>;
/**
* Add a filter augment for the iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original iterable
* @param mapper the predicate function
*/
export declare function addFilter<T>(
it: Iterable<T>,
predicate: Predicate<T>,
): Iterable<T>;
/**
* Add a filter augment for the async iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original async iterable or iterable
* @param mapper the predicate function
*/
export declare function addFilterAsync<T>(
it: AnyIterable<T>,
predicate: AsyncPredicate<T>,
): AsyncIterable<T>;
/**
* Add a map augment for the iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original iterable
* @param mapper the mapping function
*/
export declare function addMap<T, R>(
it: Iterable<T>,
mapper: Mapper<T, R>,
): Iterable<T>;
/**
* Add a map augment for the async iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original async iterable or iterable
* @param mapper the mapping function
*/
export declare function addMapAsync<T, R>(
it: AnyIterable<T>,
mapper: AsyncMapper<T, R>,
): AsyncIterable<T>;
/**
* Add a takeWhile augment for the iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original iterable
* @param predicate the stop condition
*/
export declare function addTakeWhile<T>(
it: Iterable<T>,
predicate: Predicate<T>,
): Iterable<T>;
/**
* Add a takeWhile augment for the async iterable. It will returns a new iterable if the informed is not already augmentative.
* @param it the original iterable or async iterable
* @param predicate the stop condition
*/
export declare function addTakeWhileAsync<T>(
it: AnyIterable<T>,
predicate: AsyncPredicate<T>,
): AsyncIterable<T>;
/**
* Pass the informed value to the callback and returns it's result
* @typeparam T input type of the callback
* @typeparam R the result type of the callback
* @param value The value to be passed on
* @param callback The callback
*/
export declare function resolver<T, R>(value: T, callback: (c: T) => R): R;
/**
* Resolves a promise like value and pass the result to a callback and returns it's result
* @typeparam T input type of the callback
* @typeparam R the result type of the callback
* @param promise The promise like value
* @param callback The callback
*/
export declare function resolverAsync<T, R>(
promise: PromiseLike<T> | T,
callback: (c: T) => R,
): Promise<R> | R;
export declare function itClone<T extends AnyIterable<any>>(it: T): T;