murgatroid99 4718a387fd Unref uv_async after construction to avoid blocking at shutdown před 10 roky
..
ext 4718a387fd Unref uv_async after construction to avoid blocking at shutdown před 10 roky
health_check aea13f1c85 global replace health check proto v1alpha to v1 před 10 roky
interop 9adecb06e0 Fix race between parsing messages and receiving status in Node client před 10 roky
performance f74a67b6d5 Rename to reduce confusion před 10 roky
src 734c8db599 Node: made call credentials properly use UV async events. Also deleted some log lines před 10 roky
test 9adecb06e0 Fix race between parsing messages and receiving status in Node client před 10 roky
.gitignore c4f0ebe63b Prepare for the new batch call API. před 11 roky
.jshintrc dca966d39c Fixed lint errors před 11 roky
README.md 11ce4ffc75 update min node version před 10 roky
index.js 654d2549b7 Add tests and documentation for new options před 10 roky
jsdoc_conf.json f7f4f57c62 Update Node API documentation generation configuration for move to repo root před 10 roky

README.md

npm

Node.js gRPC Library

Status

Beta

PREREQUISITES

  • node: This requires node to be installed, version 0.12 or above. If you instead have the nodejs executable on Debian, you should install the nodejs-legacy package.

INSTALLATION

Install the gRPC NPM package

npm install grpc

BUILD FROM SOURCE

  1. Clone the grpc Git Repository.
  2. Run npm install.

TESTING

To run the test suite, simply run npm test in the install location.

API

This library internally uses ProtoBuf.js, and some structures it exports match those exported by that library

If you require this module, you will get an object with the following members

function load(filename)

Takes a filename of a Protocol Buffer file, and returns an object representing the structure of the protocol buffer in the following way:

  • Namespaces become maps from the names of their direct members to those member objects
  • Service definitions become client constructors for clients for that service. They also have a service member that can be used for constructing servers.
  • Message definitions become Message constructors like those that ProtoBuf.js would create
  • Enum definitions become Enum objects like those that ProtoBuf.js would create
  • Anything else becomes the relevant reflection object that ProtoBuf.js would create

    function loadObject(reflectionObject)
    

Returns the same structure that load returns, but takes a reflection object from ProtoBuf.js instead of a file name.

function Server([serverOpions])

Constructs a server to which service/implementation pairs can be added.

status

An object mapping status names to status code numbers.

callError

An object mapping call error names to codes. This is primarily useful for tracking down certain kinds of internal errors.

Credentials

An object with factory methods for creating credential objects for clients.

ServerCredentials

An object with factory methods for creating credential objects for servers.