Skip to content

Commit e096711

Browse files
authored
Merge pull request #1718 from G-Rath/patch-1
refactor: address some doc comment typos
2 parents 680be27 + da4b4d0 commit e096711

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

lib/base/request.js

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ class Request extends EventEmitter {
5353
* @param {Template literal} template
5454
* @return {String}
5555
*/
56+
5657
template () {
5758
const values = Array.prototype.slice.call(arguments)
5859
const strings = values.shift()
@@ -101,7 +102,7 @@ class Request extends EventEmitter {
101102
* Add an input parameter to the request.
102103
*
103104
* @param {String} name Name of the input parameter without @ char.
104-
* @param {*} [type] SQL data type of input parameter. If you omit type, module automaticaly decide which SQL data type should be used based on JS data type.
105+
* @param {*} [type] SQL data type of input parameter. If you omit type, module automatically decides which SQL data type should be used based on JS data type.
105106
* @param {*} value Input parameter value. `undefined` and `NaN` values are automatically converted to `null` values.
106107
* @return {Request}
107108
*/
@@ -147,7 +148,7 @@ class Request extends EventEmitter {
147148
* Replace an input parameter on the request.
148149
*
149150
* @param {String} name Name of the input parameter without @ char.
150-
* @param {*} [type] SQL data type of input parameter. If you omit type, module automaticaly decide which SQL data type should be used based on JS data type.
151+
* @param {*} [type] SQL data type of input parameter. If you omit type, module automatically decides which SQL data type should be used based on JS data type.
151152
* @param {*} value Input parameter value. `undefined` and `NaN` values are automatically converted to `null` values.
152153
* @return {Request}
153154
*/
@@ -253,7 +254,7 @@ class Request extends EventEmitter {
253254
return this
254255
}
255256

256-
// Check is method was called as tagged template
257+
// Check if method was called as tagged template
257258
if (typeof batch === 'object') {
258259
const values = Array.prototype.slice.call(arguments)
259260
const strings = values.shift()
@@ -376,6 +377,7 @@ class Request extends EventEmitter {
376377
* @param {Object} streamOptions - optional options to configure the readable stream with like highWaterMark
377378
* @return {Stream}
378379
*/
380+
379381
toReadableStream (streamOptions = {}) {
380382
this.stream = true
381383
this.pause()
@@ -407,6 +409,7 @@ class Request extends EventEmitter {
407409
* @param {Stream} stream Stream to pipe data into.
408410
* @return {Stream}
409411
*/
412+
410413
pipe (writableStream) {
411414
const readableStream = this.toReadableStream()
412415
return readableStream.pipe(writableStream)
@@ -450,7 +453,7 @@ class Request extends EventEmitter {
450453
return this
451454
}
452455

453-
// Check is method was called as tagged template
456+
// Check if method was called as tagged template
454457
if (typeof command === 'object') {
455458
const values = Array.prototype.slice.call(arguments)
456459
const strings = values.shift()

0 commit comments

Comments
 (0)