Node.js gRPC Library
node: This requires
nodeto be installed, version
4.0or above. If you instead have the
nodejsexecutable on Debian, you should install the
Note: If you installed
nodevia a package manager and the version is still less than
4.0, try directly installing it from nodejs.org.
Install the gRPC NPM package
npm install grpc
BUILD FROM SOURCE
The following command can be used to build from source when installing the package from npm:
npm install grpc --build-from-source
--build-from-source option will work even when installing another package that depends on
grpc. To build only
grpc from source, you can use the argument
The official electron documentation recommends to build all of your native packages from source. While the reasons behind this are technically good - many native extensions won't be packaged to work properly with electron - the gRPC source code is fairly difficult to build from source due to its complex nature, and we're also providing working electron pre-built binaries. Therefore, we recommend that you do not follow this model for using gRPC with electron. Also, for the same reason,
electron-rebuild will always build from source. We advise you to not use this tool if you are depending on gRPC. Please note that there's not just one way to get native extensions running in electron, and that there's never any silver bullet for anything. The following instructions try to cater about some of the most generic ways, but different edge cases might require different methodologies.
The best way to get gRPC to work with electron is to do this, possibly in the
postinstall script of your
npm rebuild --target=2.0.0 --runtime=electron --dist-url=https://atom.io/download/electron
Note that the
2.0.0 above is the electron runtime version number. You will need to update this every time you go on a different version of the runtime.
If you have more native dependencies than gRPC, and they work better when built from source, you can explicitely specify which extension to build the following way:
npm rebuild --build-from-source=sqlite3 --target=2.0.0 --runtime=electron --dist-url=https://atom.io/download/electron
This way, if you depend on both
sqlite3, only the
sqlite3 package will be rebuilt from source, leaving the
grpc package to use its precompiled binaries.
BUILD IN GIT REPOSITORY
- Clone the grpc-node Git Repository.
git submodule update --init --recursivefrom the repository root.
npm install --build-from-source.
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
CONFIGURE BINARIES' LOCATION
You can configure the location from which the pre-compiled binaries are downloaded during installation.
npm install --grpc_node_binary_host_mirror=https://your-url.com
grpc_node_binary_host_mirror in your
See the API Documentation.
To run the test suite, simply run
npm test in the install location.