From d8c0bfb03a145f6b6dc8926d6b51365d12c0afb9 Mon Sep 17 00:00:00 2001
From: Christos Dimitroulas <c.dimitroulas@gmail.com>
Date: Mon, 9 Jul 2018 11:58:39 +0100
Subject: [PATCH] improve docs for createConnection

---
 src/eventStoreConnection.js | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/src/eventStoreConnection.js b/src/eventStoreConnection.js
index 92bdbc6..5769457 100644
--- a/src/eventStoreConnection.js
+++ b/src/eventStoreConnection.js
@@ -121,6 +121,27 @@ function createFromGossipSeeds(connectionSettings, gossipSeeds, connectionName)
  * @public
  * @alias createConnection
  * @param {object} settings
+ * @param {boolean} [settings.verboseLogging=false]
+ * @param {number} [settings.maxQueueSize=5000]
+ * @param {number} [settings.maxConcurrentItems=5000]
+ * @param {number} [settings.maxRetries=10]
+ * @param {number} [settings.maxReconnections=10]
+ * @param {boolean} [settings.requireMaster=true]
+ * @param {number} [settings.reconnectionDelay=100]
+ * @param {number} [settings.operationTimeout=7000]
+ * @param {number} [settings.operationTimeoutCheckPeriod=1000]
+ * @param {object} [settings.defaultUserCredentials=null] - The default user credentials to use for requests
+ * @param {boolean} [settings.useSslConnection=false] - Whether to use SSL or not
+ * @param {object} [settings.targetHost=null]
+ * @param {boolean} [settings.validateServer=false]
+ * @param {boolean} [settings.failOnNoServerResponse=false]
+ * @param {number} [settings.heartbeatInterval=750]
+ * @param {number} [settings.heartbeatTimeout=1500]
+ * @param {number} [settings.clientConnectionTimeout=1000]
+ * @param {string} [settings.clusterDns='']
+ * @param {number} [settings.maxDiscoverAttempts=10]
+ * @param {number} [settings.externalGossipPort=0]
+ * @param {number} [settings.gossipTimeout=1000]
  * @param {string|object|array} endPointOrGossipSeeds
  * @param {string} [connectionName]
  * @returns {EventStoreNodeConnection}
@@ -130,4 +151,4 @@ module.exports.create = function(settings, endPointOrGossipSeeds, connectionName
   if (typeof endPointOrGossipSeeds === 'object') return createFromTcpEndpoint(settings, endPointOrGossipSeeds, connectionName);
   if (typeof endPointOrGossipSeeds === 'string') return createFromStringEndpoint(settings, endPointOrGossipSeeds, connectionName);
   throw new TypeError('endPointOrGossipSeeds must be an object, a string or an array.');
-};
\ No newline at end of file
+};