'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 namespace pLocate {
    interface Options {
        /**
        Number of concurrently pending promises returned by `tester`. Minimum: `1`.
 
        @default Infinity
        */
        readonly concurrency?: number;
 
        /**
        Preserve `input` order when searching.
 
        Disable this to improve performance if you don't care about the order.
 
        @default true
        */
        readonly preserveOrder?: boolean;
    }
}
 
declare const pLocate: {
    /**
    Get the first fulfilled promise that satisfies the provided testing function.
 
    @param input - An iterable of promises/values to test.
    @param tester - This function will receive resolved values from `input` and is expected to return a `Promise<boolean>` or `boolean`.
    @returns A `Promise` that is fulfilled when `tester` resolves to `true` or the iterable is done, or rejects if any of the promises reject. The fulfilled value is the current iterable value or `undefined` if `tester` never resolved to `true`.
 
    @example
    ```
    import pathExists = require('path-exists');
    import pLocate = require('p-locate');
 
    const files = [
        'unicorn.png',
        'rainbow.png', // Only this one actually exists on disk
        'pony.png'
    ];
 
    (async () => {
        const foundPath = await pLocate(files, file => pathExists(file));
 
        console.log(foundPath);
        //=> 'rainbow'
    })();
    ```
    */
    <ValueType>(
        input: Iterable<PromiseLike<ValueType> | ValueType>,
        tester: (element: ValueType) => PromiseLike<boolean> | boolean,
        options?: pLocate.Options
    ): Promise<ValueType | undefined>;
 
    // TODO: Remove this for the next major release, refactor the whole definition to:
    // declare function pLocate<ValueType>(
    //     input: Iterable<PromiseLike<ValueType> | ValueType>,
    //     tester: (element: ValueType) => PromiseLike<boolean> | boolean,
    //     options?: pLocate.Options
    // ): Promise<ValueType | undefined>;
    // export = pLocate;
    default: typeof pLocate;
};
 
export = pLocate;