node-grpc-health-check


> Health check client and service for use with @grpc/grpc-js.

Background

This package exports both a client and server that adhere to the gRPC Health Checking Protocol.

$3

- grpc-health-check is for deprecated native grpc package not for @grpc/grpc-js
- grpc-health-check implements an expired protocol of gRPC Health Checking Protocol not the latest version

Features

- 100% Typescript
- implements the latest version of gRPC Health Checking Protocol
- API is similar to grpc-health-check
- support shutdown and resume method like grpc-go

Install

``bash
$ yarn add @zcong/node-grpc-health-check


or npm


$ npm i @zcong/node-grpc-health-check --save
`

Usage

$3

`ts
import { HealthImplementation, service, ServingStatus } from '../src'

const server = new grpc.Server()
const h = new HealthImplementation({
'': ServingStatus.NOT_SERVING,
test1: ServingStatus.SERVING,
})
server.addService(service, h)
`

$3

Any gRPC-node client can use @zcong/node-grpc-health-check` to run health checks against other servers that follow the protocol.

Full examples can be viewed at ./example.

License

MIT © zcong1993