Skip to content

Commit

Permalink
Updates [skip CI]
Browse files Browse the repository at this point in the history
  • Loading branch information
bednar committed Apr 16, 2024
1 parent 9ba6873 commit 5fd2bdf
Show file tree
Hide file tree
Showing 103 changed files with 6,080 additions and 504 deletions.
25 changes: 21 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,31 @@

## API Reference

Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.7.0 _2024-03-01T09:19:21.224Z_).
Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.8.0 _2024-04-16T19:05:46.085Z_).
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.

## Packages

| Package | Description |
| --- | --- |
| [@influxdata/influxdb3-client](./influxdb3-client.md) | |
<table><thead><tr><th>

Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[@influxdata/influxdb3-client](./influxdb3-client.md)


</td><td>


</td></tr>
</tbody></table>
33 changes: 30 additions & 3 deletions influxdb3-client.aborterror.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,34 @@ declare class AbortError extends Error
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)()](./influxdb3-client.aborterror._constructor_.md) | | Constructs a new instance of the <code>AbortError</code> class |
<table><thead><tr><th>
Constructor
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[(constructor)()](./influxdb3-client.aborterror._constructor_.md)
</td><td>
</td><td>
Constructs a new instance of the `AbortError` class
</td></tr>
</tbody></table>
35 changes: 31 additions & 4 deletions influxdb3-client.cancellable.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,35 @@ interface Cancellable

## Methods

| Method | Description |
| --- | --- |
| [cancel()](./influxdb3-client.cancellable.cancel.md) | Cancels execution. |
| [isCancelled()](./influxdb3-client.cancellable.iscancelled.md) | |
<table><thead><tr><th>

Method


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[cancel()](./influxdb3-client.cancellable.cancel.md)


</td><td>

Cancels execution.


</td></tr>
<tr><td>

[isCancelled()](./influxdb3-client.cancellable.iscancelled.md)


</td><td>


</td></tr>
</tbody></table>
52 changes: 48 additions & 4 deletions influxdb3-client.chunkcombiner.concat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,55 @@ concat(first: Uint8Array, second: Uint8Array): Uint8Array;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| first | Uint8Array | first chunk |
| second | Uint8Array | second chunk |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

first


</td><td>

Uint8Array


</td><td>

first chunk


</td></tr>
<tr><td>

second


</td><td>

Uint8Array


</td><td>

second chunk


</td></tr>
</tbody></table>
**Returns:**

Uint8Array
Expand Down
69 changes: 64 additions & 5 deletions influxdb3-client.chunkcombiner.copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,71 @@ copy(chunk: Uint8Array, start: number, end: number): Uint8Array;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| chunk | Uint8Array | chunk to copy |
| start | number | start index |
| end | number | end index |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

chunk


</td><td>

Uint8Array


</td><td>

chunk to copy


</td></tr>
<tr><td>

start


</td><td>

number


</td><td>

start index


</td></tr>
<tr><td>

end


</td><td>

number


</td><td>

end index


</td></tr>
</tbody></table>
**Returns:**

Uint8Array
Expand Down
49 changes: 44 additions & 5 deletions influxdb3-client.chunkcombiner.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,48 @@ interface ChunkCombiner

## Methods

| Method | Description |
| --- | --- |
| [concat(first, second)](./influxdb3-client.chunkcombiner.concat.md) | Concatenates first and second chunk. |
| [copy(chunk, start, end)](./influxdb3-client.chunkcombiner.copy.md) | Creates a new chunk from the supplied chunk. |
| [toUtf8String(chunk, start, end)](./influxdb3-client.chunkcombiner.toutf8string.md) | Converts chunk into a string. |
<table><thead><tr><th>

Method


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[concat(first, second)](./influxdb3-client.chunkcombiner.concat.md)


</td><td>

Concatenates first and second chunk.


</td></tr>
<tr><td>

[copy(chunk, start, end)](./influxdb3-client.chunkcombiner.copy.md)


</td><td>

Creates a new chunk from the supplied chunk.


</td></tr>
<tr><td>

[toUtf8String(chunk, start, end)](./influxdb3-client.chunkcombiner.toutf8string.md)


</td><td>

Converts chunk into a string.


</td></tr>
</tbody></table>
69 changes: 64 additions & 5 deletions influxdb3-client.chunkcombiner.toutf8string.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,71 @@ toUtf8String(chunk: Uint8Array, start: number, end: number): string;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| chunk | Uint8Array | chunk |
| start | number | start index |
| end | number | end index |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

chunk


</td><td>

Uint8Array


</td><td>

chunk


</td></tr>
<tr><td>

start


</td><td>

number


</td><td>

start index


</td></tr>
<tr><td>

end


</td><td>

number


</td><td>

end index


</td></tr>
</tbody></table>
**Returns:**

string
Expand Down
Loading

0 comments on commit 5fd2bdf

Please sign in to comment.