'a'

mh-two-thousand-and-two

2024-04-12 44d2c92345cd156a59fc327b3060292a282d2893

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
declare const stop: unique symbol;
 
declare namespace pEachSeries {
    type StopSymbol = typeof stop;
}
 
declare const pEachSeries: {
    /**
    Iterate over promises serially.
 
    @param input - Iterated over serially in the `iterator` function.
    @param iterator - Return value is ignored unless it's `Promise`, then it's awaited before continuing with the next iteration.
    @returns A `Promise` that fulfills when all promises in `input` and ones returned from `iterator` are fulfilled, or rejects if any of the promises reject. The fulfillment value is the original `input`.
 
    @example
    ```
    import pEachSeries = require('p-each-series');
 
    const keywords = [
        getTopKeyword(), //=> Promise
        'rainbow',
        'pony'
    ];
 
    const iterator = async element => saveToDiskPromise(element);
 
    (async () => {
        console.log(await pEachSeries(keywords, iterator));
        //=> ['unicorn', 'rainbow', 'pony']
    })();
    ```
    */
    <ValueType>(
        input: Iterable<PromiseLike<ValueType> | ValueType>,
        iterator: (element: ValueType, index: number) => pEachSeries.StopSymbol | unknown
    ): Promise<ValueType[]>;
 
    /**
    Stop iterating through items by returning `pEachSeries.stop` from the iterator function.
 
    @example
    ```
    const pEachSeries = require('p-each-series');
 
    // Logs `a` and `b`.
    const result = await pEachSeries(['a', 'b', 'c'], value => {
        console.log(value);
 
        if (value === 'b') {
            return pEachSeries.stop;
        }
    });
 
    console.log(result);
    //=> ['a', 'b', 'c']
    ```
    */
    readonly stop: pEachSeries.StopSymbol;
 
    // TODO: Remove this for the next major release
    default: typeof pEachSeries;
};
 
export = pEachSeries;