@goodware/mysql - npm Package Compare versions

Comparing version 2.0.10 to 2.0.11

index.js

@@ -31,3 +31,3 @@ /* eslint-disable no-param-reassign */
  * @description Schema for the 'options' object passed to MySqlConnector's constructor. See also
- * https://github.com/mysqljs/mysql#pool-options.
+ * [mysql pool options](https://github.com/mysqljs/mysql#pool-options).
  */
@@ -120,3 +120,4 @@ const optionsSchema = Joi.object({
    * @constructor
-   * @description Optionally call connect() afterward to check whether a connection can be acquired
+   * @description Optionally call connect() afterward to check whether a connection can be acquired. See also
+   * [mysql pool options](https://github.com/mysqljs/mysql#pool-options).
    * @param {Object} [options] Constructor options. Defaults are used if the provided value is falsy.
@@ -135,3 +136,4 @@ * @param {Integer} [options.connectionLimit] The maximum number of connections to keep in the connection pool when
    *   frequently (converted to milliseconds) connections are checked. Defaults to 10 seconds.
-   * @param {Object|Function} [options.logger] A logger object or function
+   * @param {Function|Object} [options.logger] A logger object or function. Can also be provided as the second
+   *   parameter.
    * @param {Number|String} [options.maxConnectDelay] The maximum amount of time (converted to milliseconds) to wait
@@ -149,2 +151,3 @@ *   between connection attempts. It starts at 10 ms and increases exponentially. Defaults to 100 seconds.
    * @param {Boolean} [options.usePool] true enables connection pooling
+   * @param {Function|Object} logger A logger object or function. Can also be provided via options.logger.
    */
@@ -151,0 +154,0 @@ constructor(options, logger) {

package.json

 {
   "name": "@goodware/mysql",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "A mysql2-based connection helper",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -1,2 +0,2 @@
-# @goodware/mysql: A mysql2-based connection helper
+# @goodware/mysql: A mysql2-promise helper
 
@@ -16,4 +16,4 @@ # Links
 - Creates database connections via mysql2-promise, optionally from a pool, with exponential backoff retry
-- Handles AWS RDS passwordless IAM connections
-- Optionally manages database transactions by wrapping begin end transaction comments around a function invocation
+- Handles AWS RDS IAM passwordless connections
+- Optionally manages database transactions by wrapping begin end transaction commands around a function invocation, with an exception handler that executes rollback
 - Same API whether using connection pooling or individual connections
@@ -20,0 +20,0 @@ - Same API whether using explicit or implicit transactions

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1512341

increased by0.09%

Lines of code

1362

increased by0.22%

No dependency changes