Welcome to mirror list, hosted at ThFree Co, Russian Federation.

index.d.ts « p-try « node_modules - github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 2a7319ec2a5568d88f05b7adffec7f43e34f8a9d (plain)
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
declare const pTry: {
	/**
	Start a promise chain.

	@param fn - The function to run to start the promise chain.
	@param arguments - Arguments to pass to `fn`.
	@returns The value of calling `fn(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error.

	@example
	```
	import pTry = require('p-try');

	(async () => {
		try {
			const value = await pTry(() => {
				return synchronousFunctionThatMightThrow();
			});
			console.log(value);
		} catch (error) {
			console.error(error);
		}
	})();
	```
	*/
	<ValueType, ArgumentsType extends unknown[]>(
		fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
		...arguments: ArgumentsType
	): Promise<ValueType>;

	// TODO: remove this in the next major version, refactor the whole definition to:
	// declare function pTry<ValueType, ArgumentsType extends unknown[]>(
	//	fn: (...arguments: ArgumentsType) => PromiseLike<ValueType> | ValueType,
	//	...arguments: ArgumentsType
	// ): Promise<ValueType>;
	// export = pTry;
	default: typeof pTry;
};

export = pTry;