Skip to content

Commit 4f01717

Browse files
committed
js doc fix
1 parent 95d997f commit 4f01717

3 files changed

Lines changed: 11 additions & 11 deletions

File tree

src/buffer/base.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ abstract class SenderBufferBase implements SenderBuffer {
131131
}
132132

133133
/**
134-
* Write the table name into the buffer.
134+
* Writes the table name into the buffer.
135135
*
136136
* @param {string} table - Table name.
137137
* @return {Sender} Returns with a reference to this sender.
@@ -151,7 +151,7 @@ abstract class SenderBufferBase implements SenderBuffer {
151151
}
152152

153153
/**
154-
* Write a symbol name and value into the buffer.
154+
* Writes a symbol name and value into the buffer.
155155
*
156156
* @param {string} name - Symbol name.
157157
* @param {unknown} value - Symbol value, toString() is called to extract the actual symbol value from the parameter.
@@ -178,7 +178,7 @@ abstract class SenderBufferBase implements SenderBuffer {
178178
}
179179

180180
/**
181-
* Write a string column with its value into the buffer.
181+
* Writes a string column with its value into the buffer.
182182
*
183183
* @param {string} name - Column name.
184184
* @param {string} value - Column value, accepts only string values.
@@ -200,7 +200,7 @@ abstract class SenderBufferBase implements SenderBuffer {
200200
}
201201

202202
/**
203-
* Write a boolean column with its value into the buffer.
203+
* Writes a boolean column with its value into the buffer.
204204
*
205205
* @param {string} name - Column name.
206206
* @param {boolean} value - Column value, accepts only boolean values.
@@ -220,7 +220,7 @@ abstract class SenderBufferBase implements SenderBuffer {
220220
}
221221

222222
/**
223-
* Write a float column with its value into the buffer.
223+
* Writes a float column with its value into the buffer.
224224
*
225225
* @param {string} name - Column name.
226226
* @param {number} value - Column value, accepts only number values.
@@ -229,7 +229,7 @@ abstract class SenderBufferBase implements SenderBuffer {
229229
abstract floatColumn(name: string, value: number): SenderBuffer;
230230

231231
/**
232-
* Write an integer column with its value into the buffer.
232+
* Writes an integer column with its value into the buffer.
233233
*
234234
* @param {string} name - Column name.
235235
* @param {number} value - Column value, accepts only number values.
@@ -250,7 +250,7 @@ abstract class SenderBufferBase implements SenderBuffer {
250250
}
251251

252252
/**
253-
* Write a timestamp column with its value into the buffer.
253+
* Writes a timestamp column with its value into the buffer.
254254
*
255255
* @param {string} name - Column name.
256256
* @param {number | bigint} value - Epoch timestamp, accepts numbers or BigInts.
@@ -276,7 +276,7 @@ abstract class SenderBufferBase implements SenderBuffer {
276276
}
277277

278278
/**
279-
* Closing the row after writing the designated timestamp into the buffer.
279+
* Closes the row after writing the designated timestamp into the buffer.
280280
*
281281
* @param {number | bigint} timestamp - Designated epoch timestamp, accepts numbers or BigInts.
282282
* @param {string} [unit=us] - Timestamp unit. Supported values: 'ns' - nanoseconds, 'us' - microseconds, 'ms' - milliseconds. Defaults to 'us'.
@@ -302,7 +302,7 @@ abstract class SenderBufferBase implements SenderBuffer {
302302
}
303303

304304
/**
305-
* Closing the row without writing designated timestamp into the buffer. <br>
305+
* Closes the row without writing designated timestamp into the buffer. <br>
306306
* Designated timestamp will be populated by the server on this record.
307307
*/
308308
atNow() {

src/buffer/bufferv1.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class SenderBufferV1 extends SenderBufferBase {
1313
}
1414

1515
/**
16-
* Write a float column with its value into the buffer using v1 serialization (text format).
16+
* Writes a float column with its value into the buffer using v1 serialization (text format).
1717
*
1818
* @param {string} name - Column name.
1919
* @param {number} value - Column value, accepts only number values.

src/buffer/bufferv2.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class SenderBufferV2 extends SenderBufferBase {
1616
}
1717

1818
/**
19-
* Write a float column with its value into the buffer using v2 serialization (binary format).
19+
* Writes a float column with its value into the buffer using v2 serialization (binary format).
2020
*
2121
* @param {string} name - Column name.
2222
* @param {number} value - Column value, accepts only number values.

0 commit comments

Comments
 (0)