grpc-node/packages/grpc-native-core
Nicolas "Pixel" Noble 88adf94cb6 Bumping to 1.13.1. 2018-07-24 22:41:41 +02:00
..
deps Update to v1.13.0 2018-07-02 11:21:33 -07:00
ext Properly create slices from utf8 strings. 2018-07-10 20:03:55 +02:00
src Fix generic client interceptor resolution 2018-06-05 11:14:58 -07:00
templates Ensuring the presence of node-pre-gyp before publishing. 2018-05-24 23:57:17 +02:00
test Properly create slices from utf8 strings. 2018-07-10 20:03:55 +02:00
tools Actually publish for arm32... 2018-06-26 01:21:35 +02:00
.jshintignore Moving files into their new location. 2017-09-12 01:33:18 +02:00
.npmignore Remove some unnecessary files from the native npm package 2017-09-19 11:18:00 -07:00
README.md Update package descriptions in README, add API docs link 2017-09-14 13:03:21 -07:00
binding.gyp Update grpc submodule on master 2018-06-05 17:08:21 -07:00
build.yaml Bumping to 1.13.1. 2018-07-24 22:41:41 +02:00
gulpfile.js Increasing mocha timeout to 5s up from 2s. 2018-05-25 19:16:04 +02:00
index.d.ts Make Protobuf.js Message type non-generic 2018-06-12 11:03:23 -07:00
index.js Stop using lodash's template generator. 2018-07-24 20:02:23 +02:00
jsdoc_conf.json Move dependencies around, add gulp target for document generation 2017-09-20 12:39:16 -07:00
package.json Bumping to 1.13.1. 2018-07-24 22:41:41 +02:00

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

API DOCUMENTATION

See the API Documentation.

TESTING

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