diff options
Diffstat (limited to 'src/node')
-rw-r--r-- | src/node/README.md | 1 | ||||
-rw-r--r-- | src/node/interop/interop_client.js | 6 | ||||
-rw-r--r-- | src/node/src/client.js | 11 | ||||
-rw-r--r-- | src/node/src/common.js | 2 | ||||
-rw-r--r-- | src/node/src/metadata.js | 9 | ||||
-rw-r--r-- | src/node/src/server.js | 15 |
6 files changed, 39 insertions, 5 deletions
diff --git a/src/node/README.md b/src/node/README.md index 5d89e2228d..b46b986243 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -1,3 +1,4 @@ +[![npm](https://img.shields.io/npm/v/grpc.svg)](https://www.npmjs.com/package/grpc) # Node.js gRPC Library ## Status diff --git a/src/node/interop/interop_client.js b/src/node/interop/interop_client.js index b5061895cf..53ffa385bd 100644 --- a/src/node/interop/interop_client.js +++ b/src/node/interop/interop_client.js @@ -562,11 +562,11 @@ function runTest(address, host_override, test_case, tls, test_ca, done, extra) { var ca_path; if (test_ca) { ca_path = path.join(__dirname, '../test/data/ca.pem'); + var ca_data = fs.readFileSync(ca_path); + creds = grpc.credentials.createSsl(ca_data); } else { - ca_path = process.env.SSL_CERT_FILE; + creds = grpc.credentials.createSsl(); } - var ca_data = fs.readFileSync(ca_path); - creds = grpc.credentials.createSsl(ca_data); if (host_override) { options['grpc.ssl_target_name_override'] = host_override; options['grpc.default_authority'] = host_override; diff --git a/src/node/src/client.js b/src/node/src/client.js index 596ea5ebb0..3cdd550752 100644 --- a/src/node/src/client.js +++ b/src/node/src/client.js @@ -33,6 +33,17 @@ /** * Client module + * + * This module contains the factory method for creating Client classes, and the + * method calling code for all types of methods. + * + * For example, to create a client and call a method on it: + * + * var proto_obj = grpc.load(proto_file_path); + * var Client = proto_obj.package.subpackage.ServiceName; + * var client = new Client(server_address, client_credentials); + * var call = client.unaryMethod(arguments, callback); + * * @module */ diff --git a/src/node/src/common.js b/src/node/src/common.js index ebaaa13db0..e4fe5a8e03 100644 --- a/src/node/src/common.js +++ b/src/node/src/common.js @@ -32,6 +32,8 @@ */ /** + * This module contains functions that are common to client and server + * code. None of them should be used directly by gRPC users. * @module */ diff --git a/src/node/src/metadata.js b/src/node/src/metadata.js index 183c3ad4fc..0a2f1489b6 100644 --- a/src/node/src/metadata.js +++ b/src/node/src/metadata.js @@ -33,6 +33,15 @@ /** * Metadata module + * + * This module defines the Metadata class, which represents header and trailer + * metadata for gRPC calls. Here is an example of how to use it: + * + * var metadata = new metadata_module.Metadata(); + * metadata.set('key1', 'value1'); + * metadata.add('key1', 'value2'); + * metadata.get('key1') // returns ['value1', 'value2'] + * * @module */ diff --git a/src/node/src/server.js b/src/node/src/server.js index 89e1090c6c..d1fb627e6c 100644 --- a/src/node/src/server.js +++ b/src/node/src/server.js @@ -33,6 +33,17 @@ /** * Server module + * + * This module contains all the server code for Node gRPC: both the Server + * class itself and the method handler code for all types of methods. + * + * For example, to create a Server, add a service, and start it: + * + * var server = new server_module.Server(); + * server.addProtoService(protobuf_service_descriptor, service_implementation); + * server.bind('address:port', server_credential); + * server.start(); + * * @module */ @@ -746,8 +757,8 @@ Server.prototype.addProtoService = function(service, implementation) { * Binds the server to the given port, with SSL enabled if creds is given * @param {string} port The port that the server should bind on, in the format * "address:port" - * @param {boolean=} creds Server credential object to be used for SSL. Pass - * nothing for an insecure port + * @param {ServerCredentials=} creds Server credential object to be used for + * SSL. Pass an insecure credentials object for an insecure port. */ Server.prototype.bind = function(port, creds) { if (this.started) { |