Skip to content

Commit

Permalink
Updates [skip CI]
Browse files Browse the repository at this point in the history
  • Loading branch information
bednar committed Nov 16, 2023
1 parent 6a312d2 commit 11c299a
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## API Reference

Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.4.0 _2023-11-03T09:29:39.615Z_).
Welcome to the API Reference Documentation of InfluxDB 3 JavaScript Client (version 0.4.1 _2023-11-16T13:52:30.835Z_).
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.
Expand Down
1 change: 1 addition & 0 deletions influxdb3-client.connectionoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ interface ConnectionOptions
| [headers?](./influxdb3-client.connectionoptions.headers.md) | | Record<string, string> | _(Optional)_ Default HTTP headers to send with every request. |
| [host](./influxdb3-client.connectionoptions.host.md) | | string | base host URL |
| [proxyUrl?](./influxdb3-client.connectionoptions.proxyurl.md) | | string | _(Optional)_ Full HTTP web proxy URL including schema, for example http://your-proxy:8080. |
| [queryTimeout?](./influxdb3-client.connectionoptions.querytimeout.md) | | number | _(Optional)_ stream timeout for query (grpc timeout). The gRPC doesn't apply the socket timeout to operations as is defined above. To successfully close a call to the gRPC endpoint, the queryTimeout must be specified. Without this timeout, a gRPC call might end up in an infinite wait state. |
| [timeout?](./influxdb3-client.connectionoptions.timeout.md) | | number | _(Optional)_ socket timeout, 10000 milliseconds by default in node.js |
| [token?](./influxdb3-client.connectionoptions.token.md) | | string | _(Optional)_ authentication token |
| [transportOptions?](./influxdb3-client.connectionoptions.transportoptions.md) | | { \[key: string\]: any; } | _(Optional)_ TransportOptions supply extra options for the transport layer, they differ between node.js and browser/deno. Node.js transport accepts options specified in [http.request](https://nodejs.org/api/http.html#http_http_request_options_callback) or [https.request](https://nodejs.org/api/https.html#https_https_request_options_callback)<!-- -->. For example, an <code>agent</code> property can be set to [setup HTTP/HTTPS proxy](https://www.npmjs.com/package/proxy-http-agent)<!-- -->, [rejectUnauthorized](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback) property can disable TLS server certificate verification. Additionally, [follow-redirects](https://github.com/follow-redirects/follow-redirects) property can be also specified in order to follow redirects in node.js. [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch) is used under the hood in browser/deno. For example, [redirect](https://developer.mozilla.org/en-US/docs/Web/API/fetch) property can be set to 'error' to abort request if a redirect occurs. |
Expand Down
13 changes: 13 additions & 0 deletions influxdb3-client.connectionoptions.querytimeout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@influxdata/influxdb3-client](./influxdb3-client.md) &gt; [ConnectionOptions](./influxdb3-client.connectionoptions.md) &gt; [queryTimeout](./influxdb3-client.connectionoptions.querytimeout.md)

## ConnectionOptions.queryTimeout property

stream timeout for query (grpc timeout). The gRPC doesn't apply the socket timeout to operations as is defined above. To successfully close a call to the gRPC endpoint, the queryTimeout must be specified. Without this timeout, a gRPC call might end up in an infinite wait state.

**Signature:**

```typescript
queryTimeout?: number;
```

0 comments on commit 11c299a

Please sign in to comment.