-
Notifications
You must be signed in to change notification settings - Fork 15
/
every.d.ts
52 lines (52 loc) · 1.31 KB
/
every.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
export = every;
/**
* @name every
*
* @synopsis
* ```coffeescript [specscript]
* type Foldable = Array|Iterable|AsyncIterable|{ reduce: function }|Object
*
* every(collection Foldable, predicate function) -> result Promise|boolean
*
* every(predicate function)(collection Foldable) -> result Promise|boolean
* ```
*
* @description
* Test a predicate concurrently across all items of a collection, returning true if all predications are truthy.
*
* ```javascript [playground]
* const isOdd = number => number % 2 == 1
*
* console.log(
* every([1, 2, 3, 4, 5], isOdd),
* ) // false
*
* console.log(
* every([1, 3, 5], isOdd),
* ) // true
* ```
*
* The collection can be any iterable, async iterable, or object values iterable collection. Below is an example of `every` accepting an async generator as the collection.
*
* ```javascript [playground]
* const asyncNumbers = async function* () {
* yield 1; yield 2; yield 3; yield 4; yield 5
* }
*
* every(asyncNumbers(), async number => number < 6).then(console.log) // true
* ```
*
* `every` supports a lazy API for composability.
*
* ```javascript [playground]
* pipe([1, 2, 3], [
* every(number => number < 5),
* console.log, // true
* ])
* ```
*
* @execution concurrent
*
* @muxing
*/
declare function every(...args: any[]): any;