Skip to content

Commit 7fd0e50

Browse files
committed
Regenerate docs
yarn run generate-docs
1 parent 2d638b0 commit 7fd0e50

32 files changed

+2649
-378
lines changed

docs/Client.html

Lines changed: 62 additions & 59 deletions
Large diffs are not rendered by default.

docs/QL.html

Lines changed: 118 additions & 115 deletions
Large diffs are not rendered by default.

docs/Reader.html

Lines changed: 141 additions & 117 deletions
Large diffs are not rendered by default.

docs/Writer.html

Lines changed: 35 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<![endif]-->
1414
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
1515
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
16+
<script src="scripts/nav.js" defer></script>
1617
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1718
</head>
1819
<body>
@@ -47,7 +48,7 @@ <h2>
4748
Writer
4849
</h2>
4950

50-
<div class="class-description"><p>Influxdb Writer</p></div>
51+
<div class="class-description usertext"><p>Influxdb Writer</p></div>
5152

5253

5354
</header>
@@ -62,7 +63,7 @@ <h2>
6263
<h2>Constructor</h2>
6364

6465

65-
<h4 class="name" id="Writer"><span class="type-signature"></span>new Writer<span class="signature">(client, queue)</span><span class="type-signature"></span></h4>
66+
<h4 class="name" id="Writer"><span class="type-signature"></span>new Writer<span class="signature">(client, queue)</span><span class="type-signature"> &rarr; {<a href="Writer.html">Writer</a>}</span></h4>
6667

6768

6869

@@ -81,6 +82,9 @@ <h4 class="name" id="Writer"><span class="type-signature"></span>new Writer<span
8182

8283

8384

85+
<dt class="tag-since">Since:</dt>
86+
<dd class="tag-since"><ul class="dummy"><li>2.2.0</li></ul></dd>
87+
8488

8589

8690

@@ -113,7 +117,7 @@ <h4 class="name" id="Writer"><span class="type-signature"></span>new Writer<span
113117

114118

115119

116-
<div class="description">
120+
<div class="description usertext">
117121
<p>Get the influxdb writer</p>
118122
</div>
119123

@@ -220,6 +224,24 @@ <h5>Parameters:</h5>
220224

221225

222226

227+
<h5>Returns:</h5>
228+
229+
230+
231+
232+
<dl class="param-type">
233+
<dt>
234+
Type
235+
</dt>
236+
<dd>
237+
238+
<span class="param-type"><a href="Writer.html">Writer</a></span>
239+
240+
241+
</dd>
242+
</dl>
243+
244+
223245

224246

225247

@@ -303,7 +325,7 @@ <h4 class="name" id="field"><span class="type-signature"></span>field<span class
303325

304326

305327

306-
<div class="description">
328+
<div class="description usertext">
307329
<p>Set the field for the write point</p>
308330
</div>
309331

@@ -503,7 +525,7 @@ <h4 class="name" id="queue"><span class="type-signature"></span>queue<span class
503525

504526

505527

506-
<div class="description">
528+
<div class="description usertext">
507529
<p>Add the writer to the queue</p>
508530
</div>
509531

@@ -627,7 +649,7 @@ <h4 class="name" id="set"><span class="type-signature"></span>set<span class="si
627649

628650

629651

630-
<div class="description">
652+
<div class="description usertext">
631653
<p>Set the internal value</p>
632654
</div>
633655

@@ -830,7 +852,7 @@ <h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="si
830852

831853

832854

833-
<div class="description">
855+
<div class="description usertext">
834856
<p>Set the tag for the write point</p>
835857
</div>
836858

@@ -1030,7 +1052,7 @@ <h4 class="name" id="then"><span class="type-signature"></span>then<span class="
10301052

10311053

10321054

1033-
<div class="description">
1055+
<div class="description usertext">
10341056
<p>Get the writer promise</p>
10351057
</div>
10361058

@@ -1210,7 +1232,7 @@ <h4 class="name" id="time"><span class="type-signature"></span>time<span class="
12101232

12111233

12121234

1213-
<div class="description">
1235+
<div class="description usertext">
12141236
<p>Set the timestamp for the write point</p>
12151237
</div>
12161238

@@ -1389,7 +1411,7 @@ <h4 class="name" id="toJSON"><span class="type-signature"></span>toJSON<span cla
13891411

13901412

13911413

1392-
<div class="description">
1414+
<div class="description usertext">
13931415
<p>Get the point data {measurement: String, tags: Object, fields: Object, time: String }]</p>
13941416
</div>
13951417

@@ -1478,12 +1500,14 @@ <h5>Returns:</h5>
14781500
<br class="clear">
14791501

14801502
<footer>
1481-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Mar 19 2019 17:31:33 GMT+1300 (New Zealand Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1503+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a> on Tue Aug 03 2021 10:03:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
14821504
</footer>
14831505

14841506
<script>prettyPrint();</script>
1507+
<script src="scripts/polyfill.js"></script>
14851508
<script src="scripts/linenumber.js"></script>
14861509

14871510

1511+
14881512
</body>
14891513
</html>
104 KB
Binary file not shown.
46 KB
Binary file not shown.
110 KB
Binary file not shown.
83.4 KB
Binary file not shown.
104 KB
Binary file not shown.
45.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)