From 483e2c638baae0288d3afd45e3a9114b43da3722 Mon Sep 17 00:00:00 2001 From: rcanedo Date: Mon, 8 Oct 2012 14:23:59 +0200 Subject: [PATCH] update doc --- README.md | 6 ++++-- lib/connection-pool.js | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76c5d9b..346f235 100644 --- a/README.md +++ b/README.md @@ -39,8 +39,10 @@ It is then available to be reused. ### new ConnectionPool(poolConfig, connectionConfig) * `poolConfig` {Object} - * `maxSize` {Number} The maximum number of connections there can be in the pool. - Default = `10` + * `max` {Number} The maximum number of connections there can be in the pool. Default = `10` + * `min` {Number} The minimun of connections there can be in the pool. Default = `0` + * `idleTimeoutMillis` {Number} The Number of milliseconds before closing an unused connection. Default = `30000` + * `connectionConfig` {Object} The same configuration that would be used to [create a tedious Connection](http://pekim.github.com/tedious/api-connection.html#function_newConnection). diff --git a/lib/connection-pool.js b/lib/connection-pool.js index 829fb08..3c0af44 100644 --- a/lib/connection-pool.js +++ b/lib/connection-pool.js @@ -38,7 +38,7 @@ function ConnectionPool(poolConfig, connectionConfig) { }, max: poolConfig.max || 10, min: poolConfig.min || 0, - idleTimeoutMillis: poolConfig.idleTimeoutMillis || 3000 + idleTimeoutMillis: poolConfig.idleTimeoutMillis || 30000 }; this.pool = PoolModule.Pool(param);