Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saqqdy/await-to-done
Async await wrapper for easy error handling
https://github.com/saqqdy/await-to-done
async-await await-error await-resolve await-to await-to-done await-wrapper
Last synced: about 8 hours ago
JSON representation
Async await wrapper for easy error handling
- Host: GitHub
- URL: https://github.com/saqqdy/await-to-done
- Owner: saqqdy
- License: mit
- Created: 2023-11-03T05:00:48.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-13T08:04:43.000Z (about 1 year ago)
- Last Synced: 2023-11-14T08:16:19.166Z (about 1 year ago)
- Topics: async-await, await-error, await-resolve, await-to, await-to-done, await-wrapper
- Language: TypeScript
- Homepage: https://www.saqqdy.com/await-to-done
- Size: 262 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh_CN.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# await-to-done
Async await 封装器可轻松处理错误
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
![typescript][typescript-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![gzip][gzip-image]][gzip-url]
[![License][license-image]][license-url]
[![Sonar][sonar-image]][sonar-url]
### **[API 文档](https://www.saqqdy.com/await-to-done)** • **[更新日志](./CHANGELOG.md)**
**使用其他语言阅读：[English](./README.md) | 简体中文**
## 安装
```bash
# 使用pnpm
$ pnpm install await-to-done
# 使用npm
$ npm install await-to-done --save
```
## 使用
### 简单用法
1. ES6 模块方式引入
```js
import to from 'await-to-done'
const [err, data] = await to(/* promise function */)
```
2. Node.js require
```js
const to = require('await-to-done')
const [err, data] = await to(/* promise function */)
```
### 传入多个Promise
```ts
import to from 'await-to-done'
const bar = () => new Promise()
const foo = () => new Promise()
const [err, data] = await to(bar(), foo()) // data = [boolean, string]
// 或者传入数组形式
const [err, data] = await to([bar(), foo()]) // data = [boolean, string]
```
### 使用 unpkg CDN
```html
;(async () => {
const to = window.awaitToDone
const [err, data] = await to(/* promise function */)
})()
```
## 问题和支持
Please open an issue [here](https://github.com/saqqdy/await-to-done/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/await-to-done.svg?style=flat-square
[npm-url]: https://npmjs.org/package/await-to-done
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/await-to-done/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/await-to-done&utm_campaign=Badge_Grade
[typescript-url]: https://badgen.net/badge/icon/typescript?icon=typescript&label
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/await-to-done.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/await-to-done?branch=master
[download-image]: https://img.shields.io/npm/dm/await-to-done.svg?style=flat-square
[download-url]: https://npmjs.org/package/await-to-done
[gzip-image]: http://img.badgesize.io/https://unpkg.com/await-to-done/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS
[gzip-url]: http://img.badgesize.io/https://unpkg.com/await-to-done/dist/index.global.prod.js?compression=gzip&label=gzip%20size:%20JS
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_await-to-done
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_await-to-done