Package Exports
- grpc
- grpc/package.json
- grpc/src/common
- grpc/src/grpc_extension
- grpc/src/protobuf_js_6_common
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (grpc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Node.js gRPC Library
PREREQUISITES
node
: This requiresnode
to be installed, version4.0
or above. If you instead have thenodejs
executable on Debian, you should install thenodejs-legacy
package.Note: If you installed
node
via a package manager and the version is still less than4.0
, try directly installing it from nodejs.org.
INSTALLATION
Install the gRPC NPM package
npm install grpc
BUILD FROM SOURCE
- Clone the grpc Git Repository.
- 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 retrynpm install
API DOCUMENTATION
See the API Documentation.
TESTING
To run the test suite, simply run npm test
in the install location.