├── .editorconfig ├── .gitattributes ├── .github ├── funding.yml ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.d.ts ├── index.js ├── index.test-d.ts ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/funding.yml: -------------------------------------------------------------------------------- 1 | github: sindresorhus 2 | tidelift: npm/p-try 3 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 16 14 | steps: 15 | - uses: actions/checkout@v2 16 | - uses: actions/setup-node@v2 17 | with: 18 | node-version: ${{ matrix.node-version }} 19 | - run: npm install 20 | - run: npm test 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | Start a promise chain. 3 | 4 | @param function_ - The function to run to start the promise chain. 5 | @param arguments - Arguments to pass to `function_`. 6 | @returns The value of calling `function_(...arguments)`. If the function throws an error, the returned `Promise` will be rejected with that error. 7 | 8 | @example 9 | ``` 10 | import pTry from 'p-try'; 11 | 12 | try { 13 | const value = await pTry(() => { 14 | return synchronousFunctionThatMightThrow(); 15 | }); 16 | console.log(value); 17 | } catch (error) { 18 | console.error(error); 19 | } 20 | ``` 21 | */ 22 | export default function( 23 | function_: (...arguments: ArgumentsType) => PromiseLike | ValueType, 24 | ...arguments: ArgumentsType 25 | ): Promise; 26 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | export default async function pTry(function_, ...arguments_) { 2 | return new Promise(resolve => { 3 | resolve(function_(...arguments_)); 4 | }); 5 | } 6 | -------------------------------------------------------------------------------- /index.test-d.ts: -------------------------------------------------------------------------------- 1 | import {expectType} from 'tsd'; 2 | import pTry from './index.js'; 3 | 4 | expectType>(pTry(() => 'foo')); 5 | expectType>(pTry(async () => 1)); 6 | expectType>( 7 | pTry((_string: string, _number: number) => 1, 'foo', 1), 8 | ); 9 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "p-try", 3 | "version": "3.0.0", 4 | "description": "`Start a promise chain", 5 | "license": "MIT", 6 | "repository": "sindresorhus/p-try", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": "^12.20.0 || ^14.13.1 || >=16.0.0" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava && tsd" 20 | }, 21 | "files": [ 22 | "index.js", 23 | "index.d.ts" 24 | ], 25 | "keywords": [ 26 | "promise", 27 | "try", 28 | "resolve", 29 | "function", 30 | "catch", 31 | "async", 32 | "await", 33 | "promises", 34 | "settled", 35 | "ponyfill", 36 | "polyfill", 37 | "shim", 38 | "bluebird" 39 | ], 40 | "devDependencies": { 41 | "ava": "^3.15.0", 42 | "tsd": "^0.17.0", 43 | "xo": "^0.45.0" 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # p-try 2 | 3 | > Start a promise chain 4 | 5 | [How is it useful?](http://cryto.net/~joepie91/blog/2016/05/11/what-is-promise-try-and-why-does-it-matter/) 6 | 7 | ## Install 8 | 9 | ```sh 10 | npm install p-try 11 | ``` 12 | 13 | ## Usage 14 | 15 | ```js 16 | import pTry from 'p-try'; 17 | 18 | try { 19 | const value = await pTry(() => { 20 | return synchronousFunctionThatMightThrow(); 21 | }); 22 | console.log(value); 23 | } catch (error) { 24 | console.error(error); 25 | } 26 | ``` 27 | 28 | ## API 29 | 30 | ### pTry(fn, ...arguments) 31 | 32 | 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. 33 | 34 | 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. 35 | 36 | #### fn 37 | 38 | The function to run to start the promise chain. 39 | 40 | #### arguments 41 | 42 | Arguments to pass to `fn`. 43 | 44 | ## Related 45 | 46 | - [More…](https://github.com/sindresorhus/promise-fun) 47 | 48 | --- 49 | 50 |
51 | 52 | Get professional support for this package with a Tidelift subscription 53 | 54 |
55 | 56 | Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies. 57 | 58 |
59 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import pTry from './index.js'; 3 | 4 | const fixture = Symbol('fixture'); 5 | const fixtureError = new Error('fixture'); 6 | 7 | test('main', async t => { 8 | t.is(await pTry(() => fixture), fixture); 9 | 10 | await t.throwsAsync( 11 | pTry(() => Promise.reject(fixtureError)), 12 | { 13 | message: fixtureError.message, 14 | }, 15 | ); 16 | 17 | await t.throwsAsync(pTry(() => { 18 | throw fixtureError; 19 | }), { 20 | message: fixtureError.message, 21 | }); 22 | }); 23 | 24 | test('allows passing arguments through', async t => { 25 | t.is(await pTry(argument => argument, fixture), fixture); 26 | }); 27 | --------------------------------------------------------------------------------