diff options
Diffstat (limited to 'node_modules/p-try/readme.md')
| -rw-r--r-- | node_modules/p-try/readme.md | 38 |
1 files changed, 29 insertions, 9 deletions
diff --git a/node_modules/p-try/readme.md b/node_modules/p-try/readme.md index 8e5fdddbe..4d7bd64df 100644 --- a/node_modules/p-try/readme.md +++ b/node_modules/p-try/readme.md @@ -1,6 +1,6 @@ # p-try [](https://travis-ci.org/sindresorhus/p-try) -> [`Promise#try()`](https://github.com/ljharb/proposal-promise-try) [ponyfill](https://ponyfill.com) - Starts a promise chain +> Start a promise chain [How is it useful?](http://cryto.net/~joepie91/blog/2016/05/11/what-is-promise-try-and-why-does-it-matter/) @@ -8,7 +8,7 @@ ## Install ``` -$ npm install --save p-try +$ npm install p-try ``` @@ -17,16 +17,36 @@ $ npm install --save p-try ```js const pTry = require('p-try'); -pTry(() => { - return synchronousFunctionThatMightThrow(); -}).then(value => { - console.log(value); -}).catch(error => { - console.error(error); -}); +(async () => { + try { + const value = await pTry(() => { + return synchronousFunctionThatMightThrow(); + }); + console.log(value); + } catch (error) { + console.error(error); + } +})(); ``` +## 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`. + + ## Related - [p-finally](https://github.com/sindresorhus/p-finally) - `Promise#finally()` ponyfill - Invoked when the promise is settled regardless of outcome |