https://github.com/huan/gerror
Mixer of gRPC Error & ECMAScript Error
https://github.com/huan/gerror
error grpc status
Last synced: about 2 months ago
JSON representation
Mixer of gRPC Error & ECMAScript Error
- Host: GitHub
- URL: https://github.com/huan/gerror
- Owner: huan
- License: apache-2.0
- Created: 2021-10-31T07:54:15.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-11-24T15:30:42.000Z (over 4 years ago)
- Last Synced: 2025-10-21T02:18:38.108Z (8 months ago)
- Topics: error, grpc, status
- Language: TypeScript
- Homepage: https://paka.dev/npm/gerror
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GError
[](https://badge.fury.io/js/gerror)
[](https://github.com/huan/gerror/actions?query=workflow%3ANPM)
[](https://www.typescriptlang.org/)
[](https://github.com/Chatie/tsconfig/issues/16)
Mixer of gRPC Error & ECMAScript Error
## Motivation
We are writing async programs with gRPC with Node.js(ECMAScript) so we need to mix gRPC Error & ECMAScript Error.
In order to make it easy, we build GError module
## Features
1. `GError.from(anyting: any)`
1. `gerror.toJSON()`
## Examples
TBW
## API Reference
### `class GError`
`GError` can be used to replace the standard `Error` as a drop in replacement.
```ts
import { GError } from 'gerror'
const gerror = GError.from(new Error('test'))
```
### `GError.stringify(e: any)`
Convert anything to a `JSON.stringify()`-ed `GError` payload
```ts
GError.stringify('this is a string error')
// It acepts any type of args
GError.stringify(new Error() as unknown)
```
### `wrapAsyncError()`
It has been designed to convert a Async to Sync, for example:
1. `async (...args: any[]) => Promise` will be converted to `(...args: any[]) => void`
1. `Promise` will be converted to `void`
The error will be send via the `onError` callback.
```ts
import { wrapAsyncError } from 'gerror'
const onError = (e: any) => console.error(e)
const wrapAsync = wrapAsyncError(onError)
const asyncFunc = async () => Promise.reject('rejection')
const syncFunc = wrapAsync(asyncFunc)
// ReturnType === 'void'
asyncFunc() // <- nothing happens (no unhandled rejections)
// console.error('Rejection')
```
## Resources
1. [Google Cloud APIs - Errors](https://cloud.google.com/apis/design/errors)
## History
### master v1.0 (Oct 30, 2021)
1. Initial code from `wechaty-puppet` module
1. Add `timeoutPromise()` function
## Author
[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)), Google Developer Export (GDE), zixia@zixia.net
[](https://stackexchange.com/users/265499)
## Copyright & License
* Docs released under Creative Commons
* Code released under the Apache-2.0 License
* Code & Docs © 2021 Huan LI \