diff options
Diffstat (limited to 'deps/npm/node_modules/libnpmconfig/node_modules/p-try/readme.md')
| -rw-r--r-- | deps/npm/node_modules/libnpmconfig/node_modules/p-try/readme.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/deps/npm/node_modules/libnpmconfig/node_modules/p-try/readme.md b/deps/npm/node_modules/libnpmconfig/node_modules/p-try/readme.md new file mode 100644 index 0000000000..58acb759aa --- /dev/null +++ b/deps/npm/node_modules/libnpmconfig/node_modules/p-try/readme.md @@ -0,0 +1,47 @@ +# p-try [](https://travis-ci.org/sindresorhus/p-try) + +> 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/) + + +## Install + +``` +$ npm install p-try +``` + + +## Usage + +```js +const pTry = require('p-try'); + +pTry(() => { + return synchronousFunctionThatMightThrow(); +}).then(value => { + console.log(value); +}).catch(error => { + console.error(error); +}); +``` + + +## API + +### pTry(fn, ...args) + +Returns a `Promise` resolved with the value of calling `fn(...args)`. 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. + + +## 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) |