Skip to content

Commit 591d004

Browse files
committed
doc: Document how to create an instance of MySQLTable
[ci skip]
1 parent 172cd6b commit 591d004

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,8 @@ and perform queries and transactions using promises.</p>
127127
passed to <a href="#PoolPlus..transactionHandler"><code>transactionHandler</code></a>.</p>
128128
</dd>
129129
<dt><a href="#MySQLTable">MySQLTable</a></dt>
130-
<dd><p>A class that provides convenient methods for performing queries.</p>
130+
<dd><p>A class that provides convenient methods for performing queries.<br>To create
131+
an instance, use <a href="#PoolPlus+defineTable"><code>poolPlus.defineTable()</code></a>.</p>
131132
</dd>
132133
</dl>
133134

@@ -511,7 +512,8 @@ connection.pquery('SELECT * FROM `books` WHERE `author` = "David"')
511512
<a name="MySQLTable"></a>
512513

513514
## MySQLTable
514-
A class that provides convenient methods for performing queries.
515+
A class that provides convenient methods for performing queries.<br>To create
516+
an instance, use [`poolPlus.defineTable()`](#PoolPlus+defineTable).
515517

516518
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
517519

lib/MySQLTable.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
'use strict';
22

33
/**
4-
* A class that provides convenient methods for performing queries.
4+
* A class that provides convenient methods for performing queries.<br>To create
5+
* an instance, use {@link PoolPlus#defineTable|`poolPlus.defineTable()`}.
56
*
67
* @see {@link https://github.com/mysqljs/mysql#performing-queries}
78
*/

0 commit comments

Comments
 (0)