Michael Lumish 0fee7226cc Merge pull request #11286 from murgatroid99/node_perf_tests 8 lat temu
..
ext c18b9069cd Merge remote-tracking branch 'upstream/v1.3.x' into master_1.3.x_upmerge 8 lat temu
health_check aebcdbd732 master bumped to 1.5.x 8 lat temu
interop b5b5f020a3 Upgrade Node dependency on Protobuf.js to version 6 9 lat temu
performance 648832fd28 Enable more Node performance tests, fix streaming test implementation 8 lat temu
src 9baf4b19f0 Merge pull request #11309 from murgatroid99/master_1.3.x_upmerge 8 lat temu
stress b5b5f020a3 Upgrade Node dependency on Protobuf.js to version 6 9 lat temu
test 7563641414 Fix node cancellation tests 8 lat temu
tools aebcdbd732 master bumped to 1.5.x 8 lat temu
.jshintignore 18997430dd Use math test to test generated code 10 lat temu
README.md c92df4cbbd Refactor some code and document most of the API 8 lat temu
index.js 0f5674bcec Merge branch 'master' into node_api_docs 8 lat temu
jsdoc_conf.json 7229f88745 Move gRPC constants to js file to include them in generated documentation 8 lat temu

README.md

npm

Node.js gRPC Library

PREREQUISITES

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

  • Note: If you installed node via a package manager and the version is still less than 4.0, try directly installing it from nodejs.org.

INSTALLATION

Install the gRPC NPM package

npm install grpc

BUILD FROM SOURCE

  1. Clone the grpc Git Repository.
  2. Run npm install --build-from-source from the repository root.
  • Note: On Windows, this might fail due to nodejs issue #4932 in which case, you will see something like the following in npm install's output (towards the very beginning):

     ..
     Building the projects in this solution one at a time. To enable parallel build, please add the "/m" switch.
     WINDOWS_BUILD_WARNING
      "..\IMPORTANT: Due to https:\github.com\nodejs\node\issues\4932, to build this library on Windows, you must first remove C:\Users\jenkins\.node-gyp\4.4.0\include\node\openssl"
      ...
      ..
    

    To fix this, you will have to delete the folder C:\Users\<username>\.node-gyp\<node_version>\include\node\openssl and retry npm install

TESTING

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