-
Notifications
You must be signed in to change notification settings - Fork 12.2k
/
es2015.iterable.d.ts
357 lines (303 loc) · 8.94 KB
/
es2015.iterable.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
/// <reference lib="es2015.symbol" />
interface SymbolConstructor {
/**
* A method that returns the default iterator for an object. Called by the semantics of the
* for-of statement.
*/
readonly iterator: unique symbol;
}
interface IteratorYieldResult<TYield> {
done?: false;
value: TYield;
}
interface IteratorReturnResult<TReturn> {
done: true;
value: TReturn;
}
type IteratorResult<T, TReturn = any> = IteratorYieldResult<T> | IteratorReturnResult<TReturn>;
interface Iterator<T, TReturn = any, TNext = undefined> {
// NOTE: 'next' is defined using a tuple to ensure we report the correct assignability errors in all places.
next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
return?(value?: TReturn): IteratorResult<T, TReturn>;
throw?(e?: any): IteratorResult<T, TReturn>;
}
interface Iterable<T> {
[Symbol.iterator](): Iterator<T>;
}
interface IterableIterator<T> extends Iterator<T> {
[Symbol.iterator](): IterableIterator<T>;
}
interface ArrayLikeOrIterableTypes<T> {
iterable: Iterable<T>;
}
interface Array<T> {
/** Iterator */
[Symbol.iterator](): IterableIterator<T>;
/**
* Returns an iterable of key, value pairs for every entry in the array
*/
entries(): IterableIterator<[number, T]>;
/**
* Returns an iterable of keys in the array
*/
keys(): IterableIterator<number>;
/**
* Returns an iterable of values in the array
*/
values(): IterableIterator<T>;
}
interface ReadonlyArray<T> {
/** Iterator of values in the array. */
[Symbol.iterator](): IterableIterator<T>;
/**
* Returns an iterable of key, value pairs for every entry in the array
*/
entries(): IterableIterator<[number, T]>;
/**
* Returns an iterable of keys in the array
*/
keys(): IterableIterator<number>;
/**
* Returns an iterable of values in the array
*/
values(): IterableIterator<T>;
}
interface IArguments {
/** Iterator */
[Symbol.iterator](): IterableIterator<any>;
}
interface Map<K, V> {
/** Returns an iterable of entries in the map. */
[Symbol.iterator](): IterableIterator<[K, V]>;
/**
* Returns an iterable of key, value pairs for every entry in the map.
*/
entries(): IterableIterator<[K, V]>;
/**
* Returns an iterable of keys in the map
*/
keys(): IterableIterator<K>;
/**
* Returns an iterable of values in the map
*/
values(): IterableIterator<V>;
}
interface ReadonlyMap<K, V> {
/** Returns an iterable of entries in the map. */
[Symbol.iterator](): IterableIterator<[K, V]>;
/**
* Returns an iterable of key, value pairs for every entry in the map.
*/
entries(): IterableIterator<[K, V]>;
/**
* Returns an iterable of keys in the map
*/
keys(): IterableIterator<K>;
/**
* Returns an iterable of values in the map
*/
values(): IterableIterator<V>;
}
interface MapConstructor {
new(): Map<any, any>;
new <K, V>(iterable?: Iterable<readonly [K, V]> | null): Map<K, V>;
}
interface WeakMap<K extends object, V> { }
interface WeakMapConstructor {
new <K extends object, V>(iterable: Iterable<readonly [K, V]>): WeakMap<K, V>;
}
interface Set<T> {
/** Iterates over values in the set. */
[Symbol.iterator](): IterableIterator<T>;
/**
* Returns an iterable of [v, v] pairs for every value `v` in the set.
*/
entries(): IterableIterator<[T, T]>;
/**
* Despite its name, returns an iterable of the values in the set.
*/
keys(): IterableIterator<T>;
/**
* Returns an iterable of values in the set.
*/
values(): IterableIterator<T>;
}
interface ReadonlySet<T> {
/** Iterates over values in the set. */
[Symbol.iterator](): IterableIterator<T>;
/**
* Returns an iterable of [v, v] pairs for every value `v` in the set.
*/
entries(): IterableIterator<[T, T]>;
/**
* Despite its name, returns an iterable of the values in the set.
*/
keys(): IterableIterator<T>;
/**
* Returns an iterable of values in the set.
*/
values(): IterableIterator<T>;
}
interface SetConstructor {
new <T>(iterable?: Iterable<T> | null): Set<T>;
}
interface WeakSet<T extends object> { }
interface WeakSetConstructor {
new <T extends object = object>(iterable: Iterable<T>): WeakSet<T>;
}
interface Promise<T> { }
interface PromiseConstructor {
/**
* Creates a Promise that is resolved with an array of results when all of the provided Promises
* resolve, or rejected when any Promise is rejected.
* @param values An iterable of Promises.
* @returns A new Promise.
*/
all<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>[]>;
/**
* Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
* or rejected.
* @param values An iterable of Promises.
* @returns A new Promise.
*/
race<T>(values: Iterable<T | PromiseLike<T>>): Promise<Awaited<T>>;
}
interface String {
/** Iterator */
[Symbol.iterator](): IterableIterator<string>;
}
interface Int8Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Uint8Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Uint8ClampedArray {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Int16Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Uint16Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Int32Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Uint32Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Float32Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}
interface Float64Array {
[Symbol.iterator](): IterableIterator<number>;
/**
* Yields index, value pairs for every entry in the array.
*/
entries(): IterableIterator<[number, number]>;
/**
* Yields each index in the array.
*/
keys(): IterableIterator<number>;
/**
* Yields each value in the array.
*/
values(): IterableIterator<number>;
}