GitHub - cjihrig/grpc-server-js: Pure JavaScript gRPC Server (original) (raw)

Skip to content

Navigation Menu

• • GitHub Copilot Write better code with AI
  • GitHub Advanced Security Find and fix vulnerabilities
  • Actions Automate any workflow
  • Codespaces Instant dev environments
  • Issues Plan and track work
  • Code Review Manage code changes
  • Discussions Collaborate outside of code
  • Code Search Find more, search less
• Explore
  • Learning Pathways
  • Events & Webinars
  • Ebooks & Whitepapers
  • Customer Stories
  • Partners
  • Executive Insights
• • GitHub Sponsors Fund open source developers
  • The ReadME Project GitHub community articles
• • Enterprise platform AI-powered developer platform
• Pricing

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign up

This repository was archived by the owner on Sep 28, 2021. It is now read-only.

grpc-server-js

Pure JavaScript gRPC Server

Documentation

The goal is to be largely compatible with the existing Server implementation.

Features

• Unary calls.
• Streaming client request calls.
• Streaming server response calls.
• Bidirectional streaming calls.
• Deadline and cancellation support.
• Support for gzip and deflate compression, as well as uncompressed messages.
• Server credentials for handling both secure and insecure calls.
• gRPC Metadata.
• gRPC logging.
• No production dependencies.
• No C++ dependencies. This implementation relies on Node's http2 module.
• Supports the following gRPC server options:
  • grpc.http2.max_frame_size
  • grpc.keepalive_time_ms
  • grpc.keepalive_timeout_ms
  • grpc.max_concurrent_streams
  • grpc.max_receive_message_length
  • grpc.max_send_message_length
  • All possible options and their descriptions are available here.
• Supports the following gRPC environment variables:
  • GRPC_DEFAULT_SSL_ROOTS_FILE_PATH
  • GRPC_SSL_CIPHER_SUITES
  • GRPC_VERBOSITY
  • All possible environment variables and their descriptions are available here.

Public API Deviations from the Existing grpc.Server

• Server.prototype.bind() is an async function.
• The deprecated Server.prototype.addProtoService() is not implemented.
• Server.prototype.addHttp2Port() is not implemented.

Useful References

• What is gRPC?
• gRPC over HTTP2
• gRPC Compression
• gRPC Environment Variables
• gRPC Keepalive
• gRPC Name Resolution
• gRPC Status Codes

Acknowledgement

This module is heavily inspired by the grpc native module. Some of the source code is adapted from the @grpc/grpc-js module.