-
Notifications
You must be signed in to change notification settings - Fork 15
/
some.d.ts
65 lines (65 loc) · 1.57 KB
/
some.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
export = some;
/**
* @name some
*
* @synopsis
* ```coffeescript [specscript]
* type Foldable = Array|Iterable|AsyncIterable|{ reduce: function }|Object
*
* some(collection Foldable, predicate function) -> Promise|boolean
*
* some(predicate function)(collection Foldable) -> Promise|boolean
* ```
*
* @description
* Test a predicate concurrently across all items of a collection, returning true if any executions return truthy.
*
* ```javascript [playground]
* const isOdd = number => number % 2 == 1
*
* console.log(
* some([1, 2, 3, 4, 5], isOdd),
* ) // true
* ```
*
* The collection can be any iterable, async iterable, or object values iterable collection. Below is an example of `some` accepting an async generator as the collection.
*
* ```javascript [playground]
* const toTodosUrl = id => 'https://jsonplaceholder.typicode.com/todos/' + id
*
* const fetchedToJson = fetched => fetched.json()
*
* const fetchTodo = pipe([
* toTodosUrl,
* fetch,
* fetchedToJson,
* ])
*
* const todoIDsGenerator = async function* () {
* yield 1; yield 2; yield 3; yield 4; yield 5
* }
*
* const promise = some(todoIDsGenerator(), async id => {
* const todo = await fetchTodo(id)
* return todo.title.startsWith('fugiat')
* })
*
* promise.then(console.log) // true
* ```
*
* `some` supports a lazy API for composability.
*
* ```javascript [playground]
* pipe([1, 2, 3], [
* some(number => number < 5),
* console.log, // true
* ])
* ```
*
* @execution concurrent
*
* @muxing
*
* @related or
*/
declare function some(...args: any[]): any;