From d40a0040e1d79fa7908d9f1b4c41aa15ff7e70ba Mon Sep 17 00:00:00 2001 From: Caroline Daughtrey Date: Fri, 26 Aug 2016 15:06:09 -0400 Subject: [PATCH] node-SDK: Change hfc Peer constructor description There are two incomplete descriptions. "config" should be "configuration" and the url description is incomplete. Fix parameter chain and add parameter pem with description. https://jira.hyperledger.org/browse/FAB-233 Change-Id: I82e678abcc26bacfb48b712dd35b47f9647f6b3a Signed-off-by: Caroline Daughtrey --- sdk/node/src/hfc.ts | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/sdk/node/src/hfc.ts b/sdk/node/src/hfc.ts index 867078a7274..66bdd92033f 100644 --- a/sdk/node/src/hfc.ts +++ b/sdk/node/src/hfc.ts @@ -2039,9 +2039,13 @@ export class Peer { private peerClient:any; /** - * Constructor for a peer given the endpoint config for the peer. - * @param {string} url The URL of - * @param {Chain} The chain of which this peer is a member. + * Constructs a Peer given its endpoint configuration settings + * and returns the new Peer. + * @param {string} url The URL with format of "grpcs://host:port". + * @param {Chain} chain The chain of which this peer is a member. + * @param {string} pem The certificate file, in PEM format, + * to use with the gRPC protocol (that is, with TransportCredentials). + * Required when using the grpcs protocol. * @returns {Peer} The new peer. */ constructor(url:string, chain:Chain, pem:string) {