@goodware/mysql - npm Package Compare versions

Comparing version 1.0.4 to 1.0.5

package.json

 {
   "name": "@goodware/mysql",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Database connection and execution utility for the mysql2 npm package",
@@ -13,3 +13,4 @@ "keywords": [
     "pub": "npm publish --access=public",
-    "test": "node tests/test.js"
+    "test": "node tests/test.js",
+    "docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose -R README.md *.js"
   },
@@ -23,3 +24,3 @@ "main": "MySql.js",
   "dependencies": {
-    "aws-sdk": "^2.741.0",
+    "aws-sdk": "^2.747.0",
     "humanize-duration": "^3.23.1",
@@ -32,8 +33,10 @@ "joi": "^17.2.1",
     "dotenv": "^8.2.0",
-    "eslint": "^7.7.0",
+    "eslint": "^7.8.1",
     "eslint-config-airbnb-base": "^14.2.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-import": "^2.22.0",
+    "jsdoc": "^3.6.5",
+    "minami": "^1.2.3",
     "prettier": "^2.1.1"
   }
 }

README.md

@@ -1,7 +0,23 @@
-Documentation tbd
+# mysql2 utility for NodeJS
 
-mysql2 utility for NodeJS
+Better Documentation is coming
 
+# Links
+
+- [npm](https://www.npmjs.com/package/@goodware/mysql)
+- [git](https://github.com/good-ware/js-mysql)
+- [API](https://good-ware.github.io/js-mysql/)
+
+# Requirements
+
+ECMAScript 2017
+
+# Installation
+
+`npm i --save @goodware/mysql`
+
+# Features
+
 - Creates mysql2-promise Connections, optionally from a pool
-- Optionally manages database transactions by wrapping begin/end around a function invocation
-
+- Handles AWS RDS passwordless IAM connections
+- Manages database transactions by wrapping begin/end around a function invocation

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 14 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

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

1486217

increased by8209.85%

Number of package files

49

increased by345.45%

Lines of code

1334

increased by199.1%

Number of lines in readme file

24

increased by200%

Worsened metrics

Dev dependency count

9

increased by28.57%

Number of low license alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

15

increased byInfinity%

Dependency changes

• Updatedaws-sdk@^2.747.0