From 47816940384b8af666f9d0b4099a76c522312338 Mon Sep 17 00:00:00 2001
From: Braydon Fuller <braydon@bitpay.com>
Date: Wed, 18 Feb 2015 19:04:01 -0500
Subject: [PATCH] Added jsdocs for options and changed size to maxSize

---
 lib/pool.js  | 10 +++++++---
 test/pool.js |  2 +-
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/lib/pool.js b/lib/pool.js
index ad5873b..6e58342 100644
--- a/lib/pool.js
+++ b/lib/pool.js
@@ -30,7 +30,11 @@ function now() {
  * ```
  *
  * @param {Network|String} network - The network to connect
- * @param {Object} options - Options object
+ * @param {Object} [options] - Options object
+ * @param {Boolean} [options.listenAddr=true] - Prevent new peers being added from addr messages
+ * @param {Boolean} [options.dnsSeed=true] - Prevent seeding with DNS discovered known peers
+ * @param {Boolean} [options.relay=true] - Prevent inventory announcements until a filter is loaded
+ * @param {Number} [options.maxSize=Pool.MaxConnectedPeers] - The max number of peers
  * @returns {Pool}
  * @constructor
  */
@@ -48,7 +52,7 @@ function Pool(network, options) {
   this.listenAddr = options.listenAddr === false ? false : true;
   this.dnsSeed = options.dnsSeed === false ? false : true;
   this.relay = options.relay === false ? false : true;
-  this.size = options.size || Pool.MaxConnectedPeers;
+  this.maxSize = options.maxSize || Pool.MaxConnectedPeers;
 
   if (options.addrs) {
     for(var i = 0; i < options.addrs.length; i++) {
@@ -147,7 +151,7 @@ Pool.prototype.numberConnected = function numberConnected() {
 Pool.prototype._fillConnections = function _fillConnections() {
   var length = this._addrs.length;
   for (var i = 0; i < length; i++) {
-    if (this.numberConnected() >= this.size) {
+    if (this.numberConnected() >= this.maxSize) {
       break;
     }
     var addr = this._addrs[i];
diff --git a/test/pool.js b/test/pool.js
index ff36399..a5641b4 100644
--- a/test/pool.js
+++ b/test/pool.js
@@ -194,7 +194,7 @@ describe('Pool', function() {
       this.emit('disconnect', this, {});
     });
 
-    var pool = new Pool(null, { size: 1 });
+    var pool = new Pool(null, { dnsSeed: false });
     pool._addAddr({ ip: { v4: 'localhost' } });
 
     // Not great, but needed so pool won't catch its on event and fail the test