github-pages-deploy-action/node_modules/p-try/readme.md

59 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2020-01-28 13:07:56 +08:00
# p-try [![Build Status](https://travis-ci.org/sindresorhus/p-try.svg?branch=master)](https://travis-ci.org/sindresorhus/p-try)
2020-03-31 20:57:48 +08:00
> Start a promise chain
2020-01-28 13:07:56 +08:00
[How is it useful?](http://cryto.net/~joepie91/blog/2016/05/11/what-is-promise-try-and-why-does-it-matter/)
## Install
```
2020-03-31 20:57:48 +08:00
$ npm install p-try
2020-01-28 13:07:56 +08:00
```
## Usage
```js
const pTry = require('p-try');
2020-03-31 20:57:48 +08:00
(async () => {
try {
const value = await pTry(() => {
return synchronousFunctionThatMightThrow();
});
console.log(value);
} catch (error) {
console.error(error);
}
})();
2020-01-28 13:07:56 +08:00
```
2020-03-31 20:57:48 +08:00
## API
### pTry(fn, ...arguments)
Returns a `Promise` resolved with the value of calling `fn(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error.
Support for passing arguments on to the `fn` is provided in order to be able to avoid creating unnecessary closures. You probably don't need this optimization unless you're pushing a *lot* of functions.
#### fn
The function to run to start the promise chain.
#### arguments
Arguments to pass to `fn`.
2020-01-28 13:07:56 +08:00
## Related
- [p-finally](https://github.com/sindresorhus/p-finally) - `Promise#finally()` ponyfill - Invoked when the promise is settled regardless of outcome
- [More…](https://github.com/sindresorhus/promise-fun)
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)