Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zcong1993/ts-grpc-helper
https://github.com/zcong1993/ts-grpc-helper
Last synced: about 23 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/zcong1993/ts-grpc-helper
- Owner: zcong1993
- License: mit
- Created: 2021-03-12T06:28:30.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-20T08:48:41.000Z (about 3 years ago)
- Last Synced: 2023-02-28T14:37:12.285Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 575 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ts-grpc-helper
[](https://npmjs.com/package/@zcong/ts-grpc-helper) [](https://npmjs.com/package/@zcong/ts-grpc-helper) [](https://github.com/zcong1993/ts-grpc-helper/actions/workflows/js-test.yml)
> ts grpc helper
## Install
```bash
$ yarn add @zcong/ts-grpc-helper
# or npm
$ npm i @zcong/ts-grpc-helper --save
```
## Why
Type Before After
UnaryCall server side
```ts
{
echo: (call, callback) => {
console.log(call.request.toObject())
callback(null, call.request)
}
}
```
```ts
{
echo: toHandleUnaryCall(async (req, md, call) => {
console.log(req.toObject())
return req
}),
}
```
UnaryCall client side
```ts
const testEcho = async (c: HelloClient) => {
const req = new pb.EchoRequest()
req.setMessage('test')
c.echo(req, (err, data) => {
if (err) {
console.log('err: ', err)
} else {
console.log(data.toObject())
}
})
}
```
```ts
const testEcho = async (c: HelloClient) => {
const req = new pb.EchoRequest()
req.setMessage('test')
const resp = await promisifyUnaryCall(c.echo, c)(req)
console.log(resp.res.toObject())
}
```
ServerStream server side
```ts
{
serverStream: (call) => {
console.log(call.request.toObject())
Array(3)
.fill(call.request)
.map((r) => call.write(r))
call.end()
},
}
```
```ts
{
serverStream: toHandleServerStreamingCall(async (req, md, call) => {
console.log(req.toObject())
return from(Array(3).fill(req))
}),
}
```
ServerStream client side
```ts
const testStream = async (c: HelloClient) => {
const req = new pb.EchoRequest()
req.setMessage('test2')
const st = c.serverStream(req)
st.on('data', (d) => {
console.log(d.toObject())
})
st.on('end', () => {
console.log('done')
})
st.on('error', (err) => {
console.log('error', err)
})
}
```
```ts
const testStream = async (c: HelloClient) => {
const req = new pb.EchoRequest()
req.setMessage('test2')
const st = c.serverStream(req)
const result$ = readStreamToObserver(st)
await result$.forEach((data) => {
console.log(data.toObject())
})
}
```
ClientStream server side
```ts
{
clientStream: (call, callback) => {
let d: any
call.on('data', (dd) => {
console.log(dd.toObject())
d = dd
})
call.on('error', (err) => {
callback(err)
})
call.on('end', () => {
callback(null, d)
})
},
}
```
```ts
{
clientStream: toHandleClientStreamingCall(async (req, md, call) => {
let res: hello_pb.EchoRequest
await req.forEach((data) => {
res = data
console.log(data.toObject())
})
return res
}),
}
```
ClientStream client side
```ts
const testClientStream = async (c: HelloClient) => {
const m = new grpc.Metadata()
m.set('hello', 'xxx')
const [call, p] = promisifyClientStream(c.clientStream, c, m)
observerToWriteStream(
from(
Array(5)
.fill(null)
.map((_, i) => {
const req = new pb.EchoRequest()
req.setMessage(`test ${i}`)
return req
})
),
call
)
const resp = await p
console.log(resp.toObject())
}
```
```ts
const testClientStream = async (c: HelloClient) => {
const call = c.clientStream((err, resp) => {
if (err) {
console.log(err)
} else {
console.log(resp.toObject())
}
})
observerToWriteStream(
range(0, 5).pipe(
map((val) => {
const req = new pb.EchoRequest()
req.setMessage(`test ${val}`)
return req
})
),
call
)
}
```
DuplexStream server side
```ts
{
duplexStream: (call) => {
call.on('error', (err) => {
call.emit('error', err)
})
call.on('end', () => {
call.end()
})
call.on('data', (d) => {
console.log(d.toObject())
call.write(d)
})
},
}
```
```ts
{
duplexStream: toHandleBidiStreamingCall(async (req, md, call) => {
return req.pipe(tap((data) => console.log(data.toObject())))
}),
}
```
DuplexStream client side
```ts
const testDuplexStream = async (c: HelloClient) => {
const call = c.duplexStream()
call.on('data', (data) => {
console.log(data.toObject())
})
call.on('end', () => {
console.log('end')
})
for (let i = 0; i < 5; i++) {
const req = new pb.EchoRequest()
req.setMessage(`test ${i}`)
call.write(req)
if (i < 4) {
await sleep(1000)
}
}
call.end()
}
```
```ts
const testDuplexStream = async (c: HelloClient) => {
const call = c.duplexStream()
const result$ = readStreamToObserver(call)
result$
.forEach((data) => {
console.log(data.toObject())
})
.then(() => console.log('end'))
const source$ = interval(1000).pipe(
take(5),
map((v) => {
const req = new pb.EchoRequest()
req.setMessage(`test ${v}`)
return of(req)
}),
concatAll()
)
observerToWriteStream(source$, call)
}
```
## License
MIT © zcong1993