Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xobotyi/await-of
await wrapper for easier errors handling without try-catch
https://github.com/xobotyi/await-of
async async-await await browser error-handling node promise try-catch wrapper
Last synced: about 1 month ago
JSON representation
await wrapper for easier errors handling without try-catch
- Host: GitHub
- URL: https://github.com/xobotyi/await-of
- Owner: xobotyi
- License: mit
- Created: 2018-08-02T13:59:06.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-01T01:01:43.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T15:16:54.798Z (2 months ago)
- Topics: async, async-await, await, browser, error-handling, node, promise, try-catch, wrapper
- Language: TypeScript
- Size: 1.8 MB
- Stars: 268
- Watchers: 4
- Forks: 16
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-github-star - await-of - catch | xobotyi | 267 | (TypeScript)
- awesome-list - await-of - catch | xobotyi | 244 | (TypeScript)
README
# await-of
await wrapper for easier errors handling without try-catch
[](https://www.npmjs.com/package/await-of)
[](https://www.npmjs.com/package/await-of)
[](https://www.npmjs.com/package/await-of)
[](https://github.com/xobotyi/await-of/actions)
[](https://app.codecov.io/gh/xobotyi/await-of)
[](https://www.npmjs.com/package/await-of)
[](https://bundlephobia.com/result?p=await-of)
---
❤️Please consider starring this project to show your love and support.🙌
---
## About
ES7 `async/await` gives to developers ability to write asynchronous code that look like synchronous. But under the hood it is still just a sugar on top of the ES6 `Promise`.
You can write code that looks clean, but only unless you have to catch errors. To catch thrown error or handle the promise's rejection you have to surround it with `try-catch` block or fallback to pure promises and from that moment visual purity of your code is over.
But there is a solution!☀️
I really like the way it's done in **Go**. It has no error throwing mechanism, but has a multi-value return and the common way to handle errors in Go is to return error as a last value, like so:
```go
data, err := someErrorFunc(someStuff)
if err != nil {
return err
}
```
_But JavaScript has no multi-value return!_ - you would say. Sad, but true.
But!
It has a destructuring assignment and `await-of` gives you ability to do this:
```javascript
import { of } from "await-of";
async () => {
let [res, err] = await of(axios.get("some.uri/to/get"));
if (err) {
// rethrow if its not an axios response error
if (!err.response) {
throw err;
}
res = err.response;
}
const { data, status = 0 } = res;
console.log(data, status);
};
```
There is no modifications needed in function/promise you want to await - just pass it to the `of()` and whole the magic will be done.
## Installation
```bash
npm i --save await-of
```
## Usage
```javascript
import { of } from "await-of";
async function someAsyncStuff() {
let error, data;
// if we don't want to handle error
[data] = await of(Promise.reject(new Error("ERROR!")));
console.log(data); // undefined
// if promise was rejected - it's rejection value will be treated as error
[, error] = await of(Promise.reject(new Error("ERROR!")));
console.log(error); // ERROR!
// or if promise has any uncaught errors it'll catch them too!
[, error] = await of(
new Promise(() => {
throw new TypeError("ERROR!");
})
);
console.log(error.message); // ERROR!
}
```
## Tests
```bash
# install dependencies if you haven't yet
npm install
npm run test
```