RanchiMall/flocore-p2p
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix jsdocs for message commands

Browse Source
This commit is contained in:
Braydon Fuller 2015-03-16 12:59:29 -04:00
parent f1aa4d3bc0
commit 39d1ae9ac8
3 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
lib/messages/commands/filteradd.js
View File

@ -13,7 +13,8 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
/** /**
* Request peer to add data to a bloom filter already set by 'filterload' * Request peer to add data to a bloom filter already set by 'filterload'
* @param {Buffer} data - Array of bytes representing bloom filter data * @param {Object} options
* @param {Buffer} options.data - Array of bytes representing bloom filter data
* @extends Message * @extends Message
* @constructor * @constructor
*/ */

12
lib/messages/commands/getdata.js
View File

@ -40,14 +40,26 @@ function GetdataMessage(options) {
} }
inherits(GetdataMessage, Message); inherits(GetdataMessage, Message);
/**
* @param {Buffer|String} hash - The hash of the transaction inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forTransaction = function(hash) { GetdataMessage.forTransaction = function(hash) {
return new GetdataMessage([Inventory.forTransaction(hash)]); return new GetdataMessage([Inventory.forTransaction(hash)]);
}; };
/**
* @param {Buffer|String} hash - The hash of the block inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forBlock = function(hash) { GetdataMessage.forBlock = function(hash) {
return new GetdataMessage([Inventory.forBlock(hash)]); return new GetdataMessage([Inventory.forBlock(hash)]);
}; };
/**
* @param {Buffer|String} hash - The hash of the filtered block inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forFilteredBlock = function(hash) { GetdataMessage.forFilteredBlock = function(hash) {
return new GetdataMessage([Inventory.forFilteredBlock(hash)]); return new GetdataMessage([Inventory.forFilteredBlock(hash)]);
}; };

6
lib/messages/commands/notfound.js
View File

@ -41,7 +41,7 @@ inherits(NotfoundMessage, Message);
/** /**
* @param {Buffer|String} hash - The hash of the transaction inventory item * @param {Buffer|String} hash - The hash of the transaction inventory item
* @returns {InvMessage} * @returns {NotfoundMessage}
*/ */
NotfoundMessage.forTransaction = function(hash) { NotfoundMessage.forTransaction = function(hash) {
return new NotfoundMessage([Inventory.forTransaction(hash)]); return new NotfoundMessage([Inventory.forTransaction(hash)]);
@ -49,7 +49,7 @@ NotfoundMessage.forTransaction = function(hash) {
/** /**
* @param {Buffer|String} hash - The hash of the block inventory item * @param {Buffer|String} hash - The hash of the block inventory item
* @returns {InvMessage} * @returns {NotfoundMessage}
*/ */
NotfoundMessage.forBlock = function(hash) { NotfoundMessage.forBlock = function(hash) {
return new NotfoundMessage([Inventory.forBlock(hash)]); return new NotfoundMessage([Inventory.forBlock(hash)]);
@ -57,7 +57,7 @@ NotfoundMessage.forBlock = function(hash) {
/** /**
* @param {Buffer|String} hash - The hash of the filtered block inventory item * @param {Buffer|String} hash - The hash of the filtered block inventory item
* @returns {InvMessage} * @returns {NotfoundMessage}
*/ */
NotfoundMessage.forFilteredBlock = function(hash) { NotfoundMessage.forFilteredBlock = function(hash) {
return new NotfoundMessage([Inventory.forFilteredBlock(hash)]); return new NotfoundMessage([Inventory.forFilteredBlock(hash)]);