Updates [skip CI]

InfluxCommunity · Oct 2, 2023 · 8e469f9 · 8e469f9
1 parent fa9ac36
commit 8e469f9
Show file tree

Hide file tree

Showing 81 changed files with 1,617 additions and 157 deletions.
diff --git a/index.md b/index.md
@@ -5,7 +5,7 @@
 
 ## API Reference
 
-Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.2.0 _2023-08-11T10:25:16.169Z_).
+Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.3.0 _2023-10-02T04:09:43.626Z_).
 Use this client library with InfluxDB 3.
 For connecting to InfluxDB 1.8 or 2 instances, see the [influxdb-client-js](https://github.com/influxdata/influxdb-client-js) client library.
 For connecting to InfluxDB 1.7 or earlier instances, see the [node-influx](https://github.com/node-influx/node-influx) client library.

diff --git a/influxdb3-client.getfieldtypemissmatcherror._constructor_.md b/influxdb3-client.getfieldtypemissmatcherror._constructor_.md
@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [GetFieldTypeMissmatchError](./influxdb3-client.getfieldtypemissmatcherror.md) &gt; [(constructor)](./influxdb3-client.getfieldtypemissmatcherror._constructor_.md)
+
+## GetFieldTypeMissmatchError.(constructor)
+
+Constructs a new instance of the `GetFieldTypeMissmatchError` class
+
+**Signature:**
+
+```typescript
+constructor(fieldName: string, expectedType: PointFieldType, actualType: PointFieldType);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  fieldName | string |  |
+|  expectedType | [PointFieldType](./influxdb3-client.pointfieldtype.md) |  |
+|  actualType | [PointFieldType](./influxdb3-client.pointfieldtype.md) |  |
+
diff --git a/influxdb3-client.getfieldtypemissmatcherror.md b/influxdb3-client.getfieldtypemissmatcherror.md
@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [GetFieldTypeMissmatchError](./influxdb3-client.getfieldtypemissmatcherror.md)
+
+## GetFieldTypeMissmatchError class
+
+**Signature:**
+
+```typescript
+declare class GetFieldTypeMissmatchError extends Error 
+```
+**Extends:** Error
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(fieldName, expectedType, actualType)](./influxdb3-client.getfieldtypemissmatcherror._constructor_.md) |  | Constructs a new instance of the <code>GetFieldTypeMissmatchError</code> class |
+
diff --git a/influxdb3-client.influxdbclient.close.md b/influxdb3-client.influxdbclient.close.md
@@ -4,6 +4,8 @@
 
 ## InfluxDBClient.close() method
 
+Closes the client and all its resources (connections, ...)
+
 **Signature:**
 
 ```typescript

diff --git a/influxdb3-client.influxdbclient.md b/influxdb3-client.influxdbclient.md
@@ -22,7 +22,8 @@ declare class InfluxDBClient
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [close()](./influxdb3-client.influxdbclient.close.md) |  |  |
-|  [query(query, database, queryType)](./influxdb3-client.influxdbclient.query.md) |  |  |
-|  [write(data, database, org, writeOptions)](./influxdb3-client.influxdbclient.write.md) |  |  |
+|  [close()](./influxdb3-client.influxdbclient.close.md) |  | Closes the client and all its resources (connections, ...) |
+|  [query(query, database, queryType)](./influxdb3-client.influxdbclient.query.md) |  | Execute a query and return the results as an async generator. |
+|  [queryPoints(query, database, queryType)](./influxdb3-client.influxdbclient.querypoints.md) |  | Execute a query and return the results as an async generator. |
+|  [write(data, database, org, writeOptions)](./influxdb3-client.influxdbclient.write.md) |  | Write data into specified database. |
 
diff --git a/influxdb3-client.influxdbclient.query.md b/influxdb3-client.influxdbclient.query.md
@@ -4,6 +4,8 @@
 
 ## InfluxDBClient.query() method
 
+Execute a query and return the results as an async generator.
+
 **Signature:**
 
 ```typescript
@@ -14,11 +16,13 @@ query(query: string, database?: string, queryType?: QueryType): AsyncGenerator<R
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  query | string |  |
-|  database | string | _(Optional)_ |
-|  queryType | [QueryType](./influxdb3-client.querytype.md) | _(Optional)_ |
+|  query | string | The query string. |
+|  database | string | _(Optional)_ The name of the database to query. |
+|  queryType | [QueryType](./influxdb3-client.querytype.md) | _(Optional)_ The type of query (default: 'sql'). |
 
 **Returns:**
 
 AsyncGenerator&lt;Record&lt;string, any&gt;, void, void&gt;
 
+An async generator that yields maps of string keys to any values.
+
diff --git a/influxdb3-client.influxdbclient.querypoints.md b/influxdb3-client.influxdbclient.querypoints.md
@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [InfluxDBClient](./influxdb3-client.influxdbclient.md) &gt; [queryPoints](./influxdb3-client.influxdbclient.querypoints.md)
+
+## InfluxDBClient.queryPoints() method
+
+Execute a query and return the results as an async generator.
+
+**Signature:**
+
+```typescript
+queryPoints(query: string, database?: string, queryType?: QueryType): AsyncGenerator<PointValues, void, void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  query | string | The query string. |
+|  database | string | _(Optional)_ The name of the database to query. |
+|  queryType | [QueryType](./influxdb3-client.querytype.md) | _(Optional)_ The type of query (default: 'sql'). |
+
+**Returns:**
+
+AsyncGenerator&lt;[PointValues](./influxdb3-client.pointvalues.md)<!-- -->, void, void&gt;
+
+An async generator that yields PointValues object.
+
diff --git a/influxdb3-client.influxdbclient.write.md b/influxdb3-client.influxdbclient.write.md
@@ -4,6 +4,8 @@
 
 ## InfluxDBClient.write() method
 
+Write data into specified database.
+
 **Signature:**
 
 ```typescript
@@ -14,10 +16,10 @@ write(data: WritableData, database?: string, org?: string, writeOptions?: Partia
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | [WritableData](./influxdb3-client.writabledata.md) |  |
-|  database | string | _(Optional)_ |
-|  org | string | _(Optional)_ |
-|  writeOptions | Partial&lt;[WriteOptions](./influxdb3-client.writeoptions.md)<!-- -->&gt; | _(Optional)_ |
+|  data | [WritableData](./influxdb3-client.writabledata.md) | data to write |
+|  database | string | _(Optional)_ database to write into |
+|  org | string | _(Optional)_ organization to write into |
+|  writeOptions | Partial&lt;[WriteOptions](./influxdb3-client.writeoptions.md)<!-- -->&gt; | _(Optional)_ write options |
 
 **Returns:**
 

diff --git a/influxdb3-client.md b/influxdb3-client.md
@@ -9,10 +9,12 @@
 |  Class | Description |
 |  --- | --- |
 |  [AbortError](./influxdb3-client.aborterror.md) | AbortError indicates that the communication with the server was aborted |
+|  [GetFieldTypeMissmatchError](./influxdb3-client.getfieldtypemissmatcherror.md) |  |
 |  [HttpError](./influxdb3-client.httperror.md) | A general HTTP error. |
 |  [IllegalArgumentError](./influxdb3-client.illegalargumenterror.md) | IllegalArgumentError is thrown when illegal argument is supplied. |
 |  [InfluxDBClient](./influxdb3-client.influxdbclient.md) | <code>InfluxDBClient</code> for interacting with an InfluxDB server, simplifying common operations such as writing, querying. |
 |  [Point](./influxdb3-client.point.md) | Point defines values of a single measurement. |
+|  [PointValues](./influxdb3-client.pointvalues.md) | Point defines values of a single measurement. |
 |  [RequestTimedOutError](./influxdb3-client.requesttimedouterror.md) | RequestTimedOutError indicates request timeout in the communication with the server |
 
 ## Functions
@@ -59,11 +61,9 @@
 |  Type Alias | Description |
 |  --- | --- |
 |  [HttpHeaders](./influxdb3-client.httpheaders.md) | Type of HTTP headers. |
-|  [NotArrayLike](./influxdb3-client.notarraylike.md) | Prevents confusion with the ArrayLike type. Use with PointRecord |
-|  [NotPointRecord](./influxdb3-client.notpointrecord.md) | Prevents confusion with the PointRecord type. |
-|  [PointRecord](./influxdb3-client.pointrecord.md) |  |
+|  [PointFieldType](./influxdb3-client.pointfieldtype.md) |  |
 |  [QueryType](./influxdb3-client.querytype.md) |  |
 |  [ResponseStartedFn](./influxdb3-client.responsestartedfn.md) | Informs about a start of response processing. |
-|  [WritableData](./influxdb3-client.writabledata.md) | <p>The <code>WritableData</code> type represents different types of data that can be written. The data can either be a uniform ArrayLike collection or a single value of the following types:</p><p>- <code>Point</code>: Represents a [Point](./influxdb3-client.point.md) object.</p><p>- <code>string</code>: Represents lines of the [Line Protocol](https://bit.ly/2QL99fu)<!-- -->.</p><p>- <code>PointRecord</code>: Represents an anonymous object. Note that a single <code>PointRecord</code> should not have a property of name length, as it could be misinterpreted as ArrayLike. If unsure, encapsulate your record in an array, i.e. \[record\].</p> |
+|  [WritableData](./influxdb3-client.writabledata.md) | <p>The <code>WritableData</code> type represents different types of data that can be written. The data can either be a uniform ArrayLike collection or a single value of the following types:</p><p>- <code>Point</code>: Represents a [Point](./influxdb3-client.point.md) object.</p><p>- <code>string</code>: Represents lines of the [Line Protocol](https://bit.ly/2QL99fu)<!-- -->.</p> |
 |  [WritePrecision](./influxdb3-client.writeprecision.md) | Timestamp precision used in write operations. See [https://docs.influxdata.com/influxdb/latest/api/\#operation/PostWrite](https://docs.influxdata.com/influxdb/latest/api/#operation/PostWrite) |
 
diff --git a/influxdb3-client.notarraylike.md b/influxdb3-client.notarraylike.md
diff --git a/influxdb3-client.notpointrecord.md b/influxdb3-client.notpointrecord.md
diff --git a/influxdb3-client.point._constructor_.md b/influxdb3-client.point._constructor_.md
diff --git a/influxdb3-client.point.copy.md b/influxdb3-client.point.copy.md
@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [Point](./influxdb3-client.point.md) &gt; [copy](./influxdb3-client.point.copy.md)
+
+## Point.copy() method
+
+Creates a copy of this object.
+
+**Signature:**
+
+```typescript
+copy(): Point;
+```
+**Returns:**
+
+[Point](./influxdb3-client.point.md)
+
+A new instance with same values.
+
diff --git a/influxdb3-client.point.fields.md b/influxdb3-client.point.fields.md
diff --git a/influxdb3-client.point.fromvalues.md b/influxdb3-client.point.fromvalues.md
@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [Point](./influxdb3-client.point.md) &gt; [fromValues](./influxdb3-client.point.fromvalues.md)
+
+## Point.fromValues() method
+
+Creates new point from PointValues object. Can throw error if measurement missing.
+
+**Signature:**
+
+```typescript
+static fromValues(values: PointValues): Point;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  values | [PointValues](./influxdb3-client.pointvalues.md) | point values object with measurement |
+
+**Returns:**
+
+[Point](./influxdb3-client.point.md)
+
+new point from values
+
+## Exceptions
+
+missing measurement
+
diff --git a/influxdb3-client.point.getbooleanfield.md b/influxdb3-client.point.getbooleanfield.md
@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [Point](./influxdb3-client.point.md) &gt; [getBooleanField](./influxdb3-client.point.getbooleanfield.md)
+
+## Point.getBooleanField() method
+
+Gets the boolean field value associated with the specified name. Throws if actual type of field with given name is not boolean. If the field is not present, returns undefined.
+
+**Signature:**
+
+```typescript
+getBooleanField(name: string): boolean | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | field name |
+
+**Returns:**
+
+boolean \| undefined
+
+The boolean field value or undefined.
+
+## Exceptions
+
+[GetFieldTypeMissmatchError](./influxdb3-client.getfieldtypemissmatcherror.md) Actual type of field doesn't match boolean type.
+
diff --git a/influxdb3-client.point.getfield.md b/influxdb3-client.point.getfield.md
@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [Point](./influxdb3-client.point.md) &gt; [getField](./influxdb3-client.point.getfield.md)
+
+## Point.getField() method
+
+Get field of numeric type.
+
+**Signature:**
+
+```typescript
+getField(name: string, type: 'float' | 'integer' | 'uinteger'): number | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | field name |
+|  type | 'float' \| 'integer' \| 'uinteger' | field numeric type |
+
+**Returns:**
+
+number \| undefined
+
+this
+
+## Exceptions
+
+Field type doesn't match actual type
+
diff --git a/influxdb3-client.point.getfield_1.md b/influxdb3-client.point.getfield_1.md
@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [Point](./influxdb3-client.point.md) &gt; [getField](./influxdb3-client.point.getfield_1.md)
+
+## Point.getField() method
+
+Get field of string type.
+
+**Signature:**
+
+```typescript
+getField(name: string, type: 'string'): string | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | field name |
+|  type | 'string' | field string type |
+
+**Returns:**
+
+string \| undefined
+
+this
+
+## Exceptions
+
+Field type doesn't match actual type
+