Skip to content

Commit ed932c9

Browse files
committed
docs: Remove "--save" from npm install command
It hasn't been necessary since npm v5 was introduced. [ci skip]
1 parent 8bdff68 commit ed932c9

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ This module extends the popular [`mysql`](https://www.npmjs.com/package/mysql) m
3030
## Installation
3131

3232
```sh
33-
npm install mysql-plus --save
33+
npm install mysql-plus
34+
# or
35+
yarn add mysql-plus
3436
```
3537

3638
## Usage Example
@@ -142,8 +144,8 @@ an instance, use <a href="#PoolPlus+defineTable"><code>poolPlus.defineTable()</c
142144
## mysql-plus ⇐ <code>mysql</code>
143145
This module.
144146

145-
**Extends**: <code>mysql</code>
146-
**See**: [mysql](https://github.com/mysqljs/mysql#mysql)
147+
**Extends**: <code>mysql</code>
148+
**See**: [mysql](https://github.com/mysqljs/mysql#mysql)
147149

148150
* [mysql-plus](#module_mysql-plus) ⇐ <code>mysql</code>
149151
* [~ColTypes](#module_mysql-plus..ColTypes)
@@ -250,7 +252,7 @@ A function called with the results of a query.
250252
| results | <code>Array</code> &#124; <code>Object</code> | The results of the query. |
251253
| fields | <code>Array.&lt;Object&gt;</code> | Information about the returned results' fields (if any). |
252254

253-
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
255+
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
254256

255257
---
256258

@@ -260,8 +262,8 @@ A function called with the results of a query.
260262
A class that extends the `mysql` module's `Pool` class with the ability to define tables
261263
and perform queries and transactions using promises.
262264

263-
**Extends**: <code>Pool</code>
264-
**See**: [Pool](https://github.com/mysqljs/mysql#pooling-connections)
265+
**Extends**: <code>Pool</code>
266+
**See**: [Pool](https://github.com/mysqljs/mysql#pooling-connections)
265267

266268
* [PoolPlus](#PoolPlus) ⇐ <code>Pool</code>
267269
* _instance_
@@ -344,7 +346,7 @@ when it is used as a data-object value or `?` placeholder replacement.
344346
|:--- |:--- |:--- |
345347
| sql | <code>string</code> | SQL that should not be escaped. |
346348

347-
**Returns**: <code>Object</code> - An object that is turned into the provided `sql` string when `mysql` attempts to escape it.
349+
**Returns**: <code>Object</code> - An object that is turned into the provided `sql` string when `mysql` attempts to escape it.
348350
**See**: [(mysql) Escaping query values](https://github.com/mysqljs/mysql#escaping-query-values)
349351

350352
**Example**: Inserting a geometry Point
@@ -377,7 +379,7 @@ for querying the table with the given `name`.
377379
|:--- |:--- |:--- |
378380
| name | <code>string</code> | The name of the table. |
379381

380-
**Returns**: <code>[MySQLTable](#MySQLTable)</code> - A `MySQLTable` instance.
382+
**Returns**: <code>[MySQLTable](#MySQLTable)</code> - A `MySQLTable` instance.
381383

382384
---
383385

@@ -393,7 +395,7 @@ Defines a table to be created or updated in the database.
393395
| schema | <code>Object</code> | An object that defines the table's schema. See the [Defining Table Schemas](#defining-table-schemas) section. |
394396
| [migrationStrategy] | <code>string</code> | One of `safe`, `alter`, or `drop`. This will override the `migrationStrategy` value from the [`config`](#module_mysql-plus..createPool) (but is still subject to the same restrictions in production environments). |
395397

396-
**Returns**: <code>[MySQLTable](#MySQLTable)</code> - A `MySQLTable` instance that has methods for performing queries on the table.
398+
**Returns**: <code>[MySQLTable](#MySQLTable)</code> - A `MySQLTable` instance that has methods for performing queries on the table.
397399
**See**: [Defining Table Schemas](#defining-table-schemas)
398400

399401
**Example**:
@@ -463,7 +465,7 @@ callback it returns a promise that resolves with the results of the query.
463465
| [cb] | <code>[queryCallback](#module_mysql-plus..queryCallback)</code> | An optional callback that gets called with the results of the query. |
464466

465467
**Returns**: <code>?Promise</code> - If the `cb` parameter is omitted, a promise that will resolve with the results
466-
of the query is returned.
468+
of the query is returned.
467469
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
468470

469471
**Example**:
@@ -549,7 +551,7 @@ A function that will make queries during a transaction.
549551
If the promise resolves, the transaction will be committed, and if it rejects, the
550552
transaction will be rolled back. If this function does not return a promise, the
551553
`done` callback must be used or else the transaction will not be committed and
552-
the transaction connection will never be released.
554+
the transaction connection will never be released.
553555
**See**: [`poolPlus.transaction()`](#PoolPlus+transaction)
554556

555557
**Example**: To fail a transaction using the `done` callback
@@ -611,7 +613,7 @@ a promise that resolves with the results of the query.
611613
| [cb] | <code>[queryCallback](#module_mysql-plus..queryCallback)</code> | An optional callback that gets called with the results of the query. |
612614

613615
**Returns**: <code>?Promise</code> - If the `cb` parameter is omitted, a promise that will resolve with the results
614-
of the query is returned.
616+
of the query is returned.
615617
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
616618

617619
**Example**:
@@ -635,7 +637,7 @@ A class that provides convenient methods for performing queries.<br>To create
635637
an instance, use [`poolPlus.defineTable()`](#PoolPlus+defineTable) or
636638
[`poolPlus.basicTable()`](#PoolPlus+basicTable).
637639

638-
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
640+
**See**: [https://github.com/mysqljs/mysql#performing-queries](https://github.com/mysqljs/mysql#performing-queries)
639641

640642
* [MySQLTable](#MySQLTable)
641643
* [.name](#MySQLTable+name) : <code>string</code>
@@ -1037,7 +1039,7 @@ Returns a new `MySQLTable` instance that will perform queries using the provided
10371039
| trxn | <code>[Connection](#Connection)</code> | The transaction connection that will be used to perform queries. |
10381040

10391041
**Returns**: <code>[MySQLTable](#MySQLTable)</code> - A new `MySQLTable` instance that will perform queries using the provided transaction
1040-
connection instead of the `PoolPlus` instance that was used to create the original instance.
1042+
connection instead of the `PoolPlus` instance that was used to create the original instance.
10411043
**See**: [`pool.transaction()`](#PoolPlus+transaction)
10421044

10431045
**Example**:

jsdoc2md/README.hbs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ This module extends the popular [`mysql`](https://www.npmjs.com/package/mysql) m
3030
## Installation
3131

3232
```sh
33-
npm install mysql-plus --save
33+
npm install mysql-plus
34+
# or
35+
yarn add mysql-plus
3436
```
3537

3638
## Usage Example

0 commit comments

Comments
 (0)