docs: updates documentation [skip CI]

influxdata · Feb 3, 2025 · 6ebbc7b · 6ebbc7b
1 parent d6c28d1
commit 6ebbc7b
Show file tree

Hide file tree

Showing 641 changed files with 1,846 additions and 1,850 deletions.
diff --git a/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html b/classes/_influxdata_influxdb-client-apis.AuthorizationsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.BackupAPI.html b/classes/_influxdata_influxdb-client-apis.BackupAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.BucketsAPI.html b/classes/_influxdata_influxdb-client-apis.BucketsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ChecksAPI.html b/classes/_influxdata_influxdb-client-apis.ChecksAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ConfigAPI.html b/classes/_influxdata_influxdb-client-apis.ConfigAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html b/classes/_influxdata_influxdb-client-apis.DashboardsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html b/classes/_influxdata_influxdb-client-apis.DbrpsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.DebugAPI.html b/classes/_influxdata_influxdb-client-apis.DebugAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.DeleteAPI.html b/classes/_influxdata_influxdb-client-apis.DeleteAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.FlagsAPI.html b/classes/_influxdata_influxdb-client-apis.FlagsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html b/classes/_influxdata_influxdb-client-apis.FluxScriptInvocationAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.HealthAPI.html b/classes/_influxdata_influxdb-client-apis.HealthAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.LabelsAPI.html b/classes/_influxdata_influxdb-client-apis.LabelsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.MeAPI.html b/classes/_influxdata_influxdb-client-apis.MeAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.MetricsAPI.html b/classes/_influxdata_influxdb-client-apis.MetricsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html b/classes/_influxdata_influxdb-client-apis.NotificationEndpointsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html b/classes/_influxdata_influxdb-client-apis.NotificationRulesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.OrgsAPI.html b/classes/_influxdata_influxdb-client-apis.OrgsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.PingAPI.html b/classes/_influxdata_influxdb-client-apis.PingAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.QueryAPI.html b/classes/_influxdata_influxdb-client-apis.QueryAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ReadyAPI.html b/classes/_influxdata_influxdb-client-apis.ReadyAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.RemotesAPI.html b/classes/_influxdata_influxdb-client-apis.RemotesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html b/classes/_influxdata_influxdb-client-apis.ReplicationsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html b/classes/_influxdata_influxdb-client-apis.ResourcesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.RestoreAPI.html b/classes/_influxdata_influxdb-client-apis.RestoreAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.RootAPI.html b/classes/_influxdata_influxdb-client-apis.RootAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html b/classes/_influxdata_influxdb-client-apis.ScrapersAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html b/classes/_influxdata_influxdb-client-apis.ScriptsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.SetupAPI.html b/classes/_influxdata_influxdb-client-apis.SetupAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.SigninAPI.html b/classes/_influxdata_influxdb-client-apis.SigninAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.SignoutAPI.html b/classes/_influxdata_influxdb-client-apis.SignoutAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.SourcesAPI.html b/classes/_influxdata_influxdb-client-apis.SourcesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.StacksAPI.html b/classes/_influxdata_influxdb-client-apis.StacksAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.TasksAPI.html b/classes/_influxdata_influxdb-client-apis.TasksAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html b/classes/_influxdata_influxdb-client-apis.TelegrafAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html b/classes/_influxdata_influxdb-client-apis.TelegrafsAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html b/classes/_influxdata_influxdb-client-apis.TemplatesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.UsersAPI.html b/classes/_influxdata_influxdb-client-apis.UsersAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.VariablesAPI.html b/classes/_influxdata_influxdb-client-apis.VariablesAPI.html
diff --git a/classes/_influxdata_influxdb-client-apis.WriteAPI.html b/classes/_influxdata_influxdb-client-apis.WriteAPI.html
diff --git a/classes/_influxdata_influxdb-client.AbortError.html b/classes/_influxdata_influxdb-client.AbortError.html
diff --git a/classes/_influxdata_influxdb-client.HttpError.html b/classes/_influxdata_influxdb-client.HttpError.html
diff --git a/classes/_influxdata_influxdb-client.IllegalArgumentError.html b/classes/_influxdata_influxdb-client.IllegalArgumentError.html
diff --git a/classes/_influxdata_influxdb-client.InfluxDB.html b/classes/_influxdata_influxdb-client.InfluxDB.html
diff --git a/classes/_influxdata_influxdb-client.LineSplitter.html b/classes/_influxdata_influxdb-client.LineSplitter.html
diff --git a/classes/_influxdata_influxdb-client.Point.html b/classes/_influxdata_influxdb-client.Point.html
diff --git a/classes/_influxdata_influxdb-client.RequestTimedOutError.html b/classes/_influxdata_influxdb-client.RequestTimedOutError.html
diff --git a/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html b/functions/_influxdata_influxdb-client-giraffe.acceptMaxTableLength.html
@@ -2,4 +2,4 @@
 if the table reaches the specified max rows.</p>
 </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">max</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>maximum processed rows</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/_influxdata_influxdb-client-giraffe.AcceptRowFunction.html" class="tsd-signature-type tsd-kind-type-alias">AcceptRowFunction</a></h4><p>AcceptRowFunction that enforces that most max rows are processed</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/influxdata/influxdb-client-js/blob/c702f96db58c98beb90901964ae65f582f2b322d/packages/giraffe/src/csvToTable.ts#L122">csvToTable.ts:122</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/influxdata/influxdb-client-js/blob/141efbb0f3f9b4c1d1f2e1dd60fee7349a6f885b/packages/giraffe/src/csvToTable.ts#L122">csvToTable.ts:122</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
diff --git a/functions/_influxdata_influxdb-client-giraffe.createCollector.html b/functions/_influxdata_influxdb-client-giraffe.createCollector.html
@@ -3,4 +3,4 @@
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">reject</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>called upon error</p>
 </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">tableFactory</span>: <a href="../types/_influxdata_influxdb-client-giraffe.GiraffeTableFactory.html" class="tsd-signature-type tsd-kind-type-alias">GiraffeTableFactory</a></span></li><li><span><span class="tsd-kind-parameter">tableOptions</span>: <a href="../interfaces/_influxdata_influxdb-client-giraffe.TableOptions.html" class="tsd-signature-type tsd-kind-interface">TableOptions</a><span class="tsd-signature-symbol"> = {}</span></span><div class="tsd-comment tsd-typography"><p>tableOptions allow to filter or even stop the processing of rows, or restrict the columns to collect</p>
 </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../interfaces/_influxdata_influxdb-client.FluxResultObserver.html" class="tsd-signature-type tsd-kind-interface">FluxResultObserver</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>FluxResultObserver that collects table data from result rows</p>
-<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/influxdata/influxdb-client-js/blob/c702f96db58c98beb90901964ae65f582f2b322d/packages/giraffe/src/csvToTable.ts#L230">csvToTable.ts:230</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/influxdata/influxdb-client-js/blob/141efbb0f3f9b4c1d1f2e1dd60fee7349a6f885b/packages/giraffe/src/csvToTable.ts#L230">csvToTable.ts:230</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Documentation</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>