ezobjects-mysql - npm Package Compare versions

Comparing version 10.0.7 to 10.0.8

generate-docs.js

 const docket = require(`docket-parser`);
 
-docket.title(`EZ Objects v10.0.7`);
+docket.title(`EZ Objects v10.0.8`);
 docket.linkClass(`text-success`);
 docket.parseFiles([`index.js`]);
 docket.generateDocs(`docs`);

package.json

 {
   "name": "ezobjects-mysql",
-  "version": "10.0.7",
+  "version": "10.0.8",
   "description": "Easy dynamic object generation with optional MySQL table linking",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,2 @@
-# EZ Objects - MySQL Edition - v10.0.7
+# EZ Objects - MySQL Edition - v10.0.8
 
@@ -12,4 +12,4 @@ EZ Objects (MySQL Edition) is a Node.js module (that can also be usefully browserify'd) that aims to save
 * [Basic Example](#basic-example)
-* [Module Exports](#module-exports)
 * [EZ Object Types](#ez-object-types)
+* [Exported Functions](#exported-functions)
 * [Basic EZ Object Method Signatures](#basic-ez-object-method-signatures)
@@ -225,15 +225,2 @@ * [MySQL EZ Object Method Signatures](#mysql-ez-object-method-signatures)
 
-## Module Exports
-
-The EZ Objects module exports three functions:
-
-### ezobjects.createTable(objectConfig, db)
-A function that creates a MySQL table corresponding to the configuration outlined in `objectConfig`, if it doesn't already exist.
-
-### ezobjects.createClass(objectConfig)
-A function that creates an ES6 class corresponding to the configuration outlined in `objectConfig`, with constructor, initializer, getters, setters, and also delete, insert, load, and update if `tableName` is configured.  The resulting class is both returned from the function and exported from the `ezobjects-mysql` module.
-
-### ezobjects.instanceOf(obj, constructorName)
-A function that tests whether a given class `obj` is an instance of `constructorName`, meaning `constructorName` is the name of the object's constructor, or the name of any constructor in the object's prototype chain.
-
 ## EZ Object Types
@@ -305,2 +292,20 @@
 
+## Module Exports
+
+The EZ Objects module exports three functions:
+
+### ezobjects.createTable(objectConfig, db)
+ * **Parameter:** objectConfig - `Object`
+ * **Parameter:** db - `MySQLConnection` - Created using `mysql-await` module
+ * **Description:** A function that creates a MySQL table corresponding to the configuration outlined in `objectConfig`, if it doesn't already exist.
+
+### ezobjects.createClass(objectConfig)
+ * **Parameter:** objectConfig - `Object`
+ * **Description:** A function that creates an ES6 class corresponding to the configuration outlined in `objectConfig`, with constructor, initializer, getters, setters, and also delete, insert, load, and update if `tableName` is configured.  The resulting class is both returned from the function and exported from the `ezobjects-mysql` module.
+ 
+### ezobjects.instanceOf(obj, constructorName)
+ * **Parameter:** obj - `mixed` - Any object created using an EZ Object class
+ * **Parameter:** constructorName - `string`
+ * **Description:** A function that tests whether a given object `obj` is an instance of class `constructorName`, meaning `constructorName` is the name of the object's constructor, or the name of any constructor in the object's prototype chain.
+
 ## Basic EZ Object Method Signatures
@@ -787,3 +792,3 @@
 
-* [Example Nested Server](example-nested.js) - An example where client-side loading of EZ Objects is demonstrated by way of a browserify'd EZ Object model configurations, including loading of custom child objects.
+* [Example Nested Server](example-nested.js)
 * [Example Nested Models](example-nested-models.js)
@@ -790,0 +795,0 @@ * [Example Nested Client](example-nested.html)

No alert changes

Improved metrics

Total package byte prevSize

794081

increased by0.03%

Number of lines in readme file

802

increased by0.63%

No dependency changes