npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@spacefleet/grpc-ts-health-check

v1.8.0-fixes.3

Published

Health check client and service for use with gRPC-node in TS using @grpc/grpc-js

Downloads

3

Readme

grpc-ts-health-check

THIS REPO IS JUST A FORK FROM https://github.com/grpc/grpc-node/tree/master/packages/grpc-health-check with some minor tweaks to prevent the use of the original grpc module and add some Typescript.

Health check client and service for use with gRPC-node.

Background

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

By using this package, clients and servers can rely on common proto and service definitions. This means:

  • Clients can use the generated stubs to health check any server that adheres to the protocol.
  • Servers do not reimplement common logic for publishing health statuses.

Installation

Use the package manager npm to install grpc-health-check.

npm install grpc-health-check

Usage

Server

Any gRPC-node server can use grpc-health-check to adhere to the gRPC Health Checking Protocol. The following shows how this package can be added to a pre-existing gRPC server.

// Import package
let health = require('grpc-health-check');

// Define service status map. Key is the service name, value is the corresponding status.
// By convention, the empty string "" key represents that status of the entire server.
const statusMap = {
  "ServiceFoo": proto.grpc.health.v1.HealthCheckResponse.ServingStatus.SERVING,
  "ServiceBar": proto.grpc.health.v1.HealthCheckResponse.ServingStatus.NOT_SERVING,
  "": proto.grpc.health.v1.HealthCheckResponse.ServingStatus.NOT_SERVING,
};

// Construct the service implementation
let healthImpl = new health.Implementation(statusMap);

// Add the service and implementation to your pre-existing gRPC-node server
server.addService(health.service, healthImpl);

Congrats! Your server now allows any client to run a health check against it.

Client

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

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Apache License 2.0