Skip to content

Commit

Permalink
FABN-987: Update JSDoc for ProposalResponseObject
Browse files Browse the repository at this point in the history
Clarify that index 0 is a mixed array containing both ProposalResponse
and/or Error objects.

Change-Id: I9e8906f871b5ab6ed4398cde7eeeb9e8b52f4780
Signed-off-by: Mark S. Lewis <mark_lewis@uk.ibm.com>
  • Loading branch information
bestbeforetoday committed Dec 4, 2018
1 parent 532e9d6 commit cfaec8f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions fabric-client/lib/Client.js
Original file line number Diff line number Diff line change
Expand Up @@ -1009,8 +1009,9 @@ const Client = class extends BaseClient {
* standard array of objects.
*
* @typedef {array} ProposalResponseObject
* @property {ProposalResponse[]} index:0 - Array of ProposalResponse objects from the
* endorsing peers
* @property {Array<(ProposalResponse|Error)>} index:0 - Array where each element is either a ProposalResponse
* object (for a successful response from the endorsing peer) or an Error object (for an unsuccessful
* peer response or runtime error).
* @property {Object} index:1 - The original Proposal object needed when
* sending the transaction request to the orderer
*/
Expand Down

0 comments on commit cfaec8f

Please sign in to comment.