Skip to content

Commit a509792

Browse files
glasstigerglasstiger
committed
chore(nodejs): doc fix
1 parent 163dbd4 commit a509792

File tree

8 files changed

+22
-22
lines changed

8 files changed

+22
-22
lines changed

‎docs/Sender.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -772,10 +772,10 @@ <h5>Parameters:</h5>
772772
<td class="type">
773773

774774

775-
<span class="param-type">NetConnectOpts</span>
775+
<span class="param-type">net.NetConnectOpts</span>
776776
|
777777

778-
<span class="param-type">ConnectionOptions</span>
778+
<span class="param-type">tls.ConnectionOptions</span>
779779

780780

781781

@@ -2359,7 +2359,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
23592359
<br class="clear">
23602360

23612361
<footer>
2362-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
2362+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
23632363
</footer>
23642364

23652365
<script> prettyPrint(); </script>

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
176176
<br class="clear">
177177

178178
<footer>
179-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
179+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
180180
</footer>
181181

182182
<script> prettyPrint(); </script>

‎docs/index.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
5353
<br class="clear">
5454

5555
<footer>
56-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
56+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
5757
</footer>
5858

5959
<script> prettyPrint(); </script>

‎docs/module-@questdb_nodejs-client.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
156156
<br class="clear">
157157

158158
<footer>
159-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
159+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
160160
</footer>
161161

162162
<script> prettyPrint(); </script>

‎docs/src_sender.js.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ <h1 class="page-title">Source: src/sender.js</h1>
3030

3131
const { Buffer } = require("buffer");
3232
const { validateTableName, validateColumnName, validateDesignatedTimestamp } = require("./validation");
33-
const { connect, NetConnectOpts } = require("net");
34-
const { connect: connectTLS, ConnectionOptions} = require("tls");
33+
const net = require("net");
34+
const tls = require("tls");
3535
const crypto = require('crypto');
3636

3737
const DEFAULT_BUFFER_SIZE = 8192;
@@ -114,7 +114,7 @@ <h1 class="page-title">Source: src/sender.js</h1>
114114
/**
115115
* Creates a connection to the database.
116116
*
117-
* @param {NetConnectOpts | ConnectionOptions} options - Connection options, host and port are required.
117+
* @param {net.NetConnectOpts | tls.ConnectionOptions} options - Connection options, host and port are required.
118118
* @param {boolean} [secure = false] - If true connection will use TLS encryption.
119119
*/
120120
async connect(options, secure = false) {
@@ -128,8 +128,8 @@ <h1 class="page-title">Source: src/sender.js</h1>
128128
throw new Error("Sender connected already");
129129
}
130130
this.socket = !secure
131-
? connect(options)
132-
: connectTLS(options, async () => {
131+
? net.connect(options)
132+
: tls.connect(options, async () => {
133133
if (!self.socket.authorized) {
134134
reject(new Error("Problem with server's certificate"));
135135
await self.close();
@@ -508,7 +508,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-@q
508508
<br class="clear">
509509

510510
<footer>
511-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 11:54:33 GMT+0100 (British Summer Time)
511+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Mon Aug 15 2022 15:25:19 GMT+0100 (British Summer Time)
512512
</footer>
513513

514514
<script> prettyPrint(); </script>

‎src/sender.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
const { Buffer } = require("buffer");
44
const { validateTableName, validateColumnName, validateDesignatedTimestamp } = require("./validation");
5-
const { connect, NetConnectOpts } = require("net");
6-
const { connect: connectTLS, ConnectionOptions} = require("tls");
5+
const net = require("net");
6+
const tls = require("tls");
77
const crypto = require('crypto');
88

99
const DEFAULT_BUFFER_SIZE = 8192;
@@ -86,7 +86,7 @@ class Sender {
8686
/**
8787
* Creates a connection to the database.
8888
*
89-
* @param {NetConnectOpts | ConnectionOptions} options - Connection options, host and port are required.
89+
* @param {net.NetConnectOpts | tls.ConnectionOptions} options - Connection options, host and port are required.
9090
* @param {boolean} [secure = false] - If true connection will use TLS encryption.
9191
*/
9292
async connect(options, secure = false) {
@@ -100,8 +100,8 @@ class Sender {
100100
throw new Error("Sender connected already");
101101
}
102102
this.socket = !secure
103-
? connect(options)
104-
: connectTLS(options, async () => {
103+
? net.connect(options)
104+
: tls.connect(options, async () => {
105105
if (!self.socket.authorized) {
106106
reject(new Error("Problem with server's certificate"));
107107
await self.close();

‎types/src/sender.d.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ export class Sender {
5757
/**
5858
* Creates a connection to the database.
5959
*
60-
* @param {NetConnectOpts | ConnectionOptions} options - Connection options, host and port are required.
60+
* @param {net.NetConnectOpts | tls.ConnectionOptions} options - Connection options, host and port are required.
6161
* @param {boolean} [secure = false] - If true connection will use TLS encryption.
6262
*/
63-
connect(options: NetConnectOpts | ConnectionOptions, secure?: boolean): Promise<any>;
63+
connect(options: net.NetConnectOpts | tls.ConnectionOptions, secure?: boolean): Promise<any>;
6464
/**
6565
* Closes the connection to the database. <br>
6666
* Data sitting in the Sender's buffer will be lost unless flush() is called before close().
@@ -145,7 +145,7 @@ export class Sender {
145145
*/
146146
atNow(): void;
147147
}
148-
import { NetConnectOpts } from "net";
149-
import { ConnectionOptions } from "tls";
148+
import net = require("net");
149+
import tls = require("tls");
150150
import { Buffer } from "buffer";
151151
//# sourceMappingURL=sender.d.ts.map

‎types/src/sender.d.ts.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)