Skip to content

Commit d40a004

Browse files
committed
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 <[email protected]>
1 parent 17f69bd commit d40a004

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

sdk/node/src/hfc.ts

+7-3
Original file line numberDiff line numberDiff line change
@@ -2039,9 +2039,13 @@ export class Peer {
20392039
private peerClient:any;
20402040

20412041
/**
2042-
* Constructor for a peer given the endpoint config for the peer.
2043-
* @param {string} url The URL of
2044-
* @param {Chain} The chain of which this peer is a member.
2042+
* Constructs a Peer given its endpoint configuration settings
2043+
* and returns the new Peer.
2044+
* @param {string} url The URL with format of "grpcs://host:port".
2045+
* @param {Chain} chain The chain of which this peer is a member.
2046+
* @param {string} pem The certificate file, in PEM format,
2047+
* to use with the gRPC protocol (that is, with TransportCredentials).
2048+
* Required when using the grpcs protocol.
20452049
* @returns {Peer} The new peer.
20462050
*/
20472051
constructor(url:string, chain:Chain, pem:string) {

0 commit comments

Comments
 (0)