ezobjects-mysql
Advanced tools
Comparing version 4.0.1 to 4.0.2
const docket = require(`docket-parser`); | ||
docket.title(`EZ Objects v4.0.1`); | ||
docket.title(`EZ Objects v4.0.2`); | ||
docket.linkClass(`text-success`); | ||
docket.parseFiles([`index.js`, `mysql-connection.js`]); | ||
docket.generateDocs(`docs`); |
{ | ||
"name": "ezobjects-mysql", | ||
"version": "4.0.1", | ||
"version": "4.0.2", | ||
"description": "Easy dynamic object generation with optional MySQL table linking", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,2 +0,2 @@ | ||
# EZ Objects - MySQL Edition - v4.0.1 | ||
# EZ Objects - MySQL Edition - v4.0.2 | ||
@@ -246,5 +246,5 @@ EZ Objects (MySQL Edition) is a Node.js module (that can also be usefully browserify'd) that aims to save | ||
### MyObject.load(mysqlRow[, db]) | ||
* **Parameter:** mysqlRow `RowDataPacket` A MySQL `RowDataPacket` returned as part of a MySQL result set | ||
* **Parameter:** mysqlRow `RowDataPacket` - A MySQL `RowDataPacket` returned as part of a MySQL result set | ||
* **Parameter:** db - `MySQLConnection` | ||
* **Description:** Load any configured properties from key/value pairs in `mysqlRow`. You can optionally pass the database `db` if you need it to be provided as a third argument to any loadTransform methods on configured properties. | ||
* **Description:** Load any configured properties from key/value pairs in `mysqlRow`. You can optionally pass the database `db` if you need it to be provided as a third argument to any custom loadTransform handlers defined for configured properties. | ||
@@ -254,3 +254,3 @@ ### MyObject.load(obj[, db]) | ||
* **Parameter:** db - `MySQLConnection` | ||
* **Description:** Load any configured properties from key/value pairs in `obj`. You can optionally pass the database `db` if you need it to be provided as a third argument to any loadTransform methods on configured properties. | ||
* **Description:** Load any configured properties from key/value pairs in `obj`. You can optionally pass the database `db` if you need it to be provided as a third argument to any custom loadTransform handlers defined for configured properties. | ||
@@ -271,3 +271,3 @@ | ||
* **Parameter:** db - `MySQLConnection` | ||
* **Description:** Load any configured properties from the JSON-encoded key/value pairs obtained from `url`. You can optionally pass the database `db` if you need it to be provided as a third argument to any loadTransform methods on configured properties. | ||
* **Description:** Load any configured properties from the JSON-encoded key/value pairs obtained from `url`. You can optionally pass the database `db` if you need it to be provided as a third argument to any custom loadTransform handlers defined for configured properties. | ||
* **Note:** This signature is useful only when your classes are standalone browserify'd and requires you to implement a backend at `url` that will output the JSON. This signature also requires you have jQuery loaded prior to use. | ||
@@ -318,3 +318,3 @@ | ||
* **allowNull** - `boolean` - (optional) Indicates the property can be null, default is that only plain objects and custom object types are nullable | ||
* **arrayOf** - `object` - (required for type `array`) A plain object containing he EZ Object `type` or `instanceOf` of the elements of the array -- types can be `bit`, `tinyint`, `smallint`, `mediumint`, `int`, `integer`, `bigint`, `real`, `double`, `float`, `decimal`, `numeric`, `date`, `time`, | ||
* **arrayOf** - `object` - (required for type `array`) A plain object containing he EZ Object `type` or `instanceOf` of the elements of the array -- types can be `bit`, `tinyint`, `smallint`, `mediumint`, `int`, `integer`, `bigint`, `real`, `double`, `float`, `decimal`, `numeric`, `date`, `time`. Should also include any other relevant MySQL attributes for the stored properties, such as allowNull, length, unsigned, etc, though not all specifics will be used as the current practice is to store arrays using the family of MySQL `text`-type fields. That may change in future versions though where they may be stored in transparent sub-tables, so it's best practice to include the MySQL specifics if you desire future compatability. Important Note: Arrays also therefore don't yet have unlimited size capability, and if the MySQL type used by default isn't big enough, it will be up to you to manually override the `mysqlType` of the `array` property configuration. | ||
`timestamp`, `datetime`, `year`, `char`, `varchar`, `binary`, `varbinary`, `tinyblob`, `blob`, `mediumblob`, `longblob`, `tinytext`, | ||
@@ -321,0 +321,0 @@ `text`, `mediumtext`, `longtext`, `enum`, `set`, `boolean`, `function`, `object`, or any other valid object constructor name (which can alternatively be used with `instanceOf` instead). \[either **type** or **instanceOf** is required] |
Sorry, the diff of this file is not supported yet
412288