package.index.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of p-try Show documentation

`Start a promise chain

The newest version!

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);
		}
	})();
	```
	*/
	(
		fn: (...arguments: ArgumentsType) => PromiseLike | ValueType,
		...arguments: ArgumentsType
	): Promise;

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

export = pTry;