mirror of
https://github.com/lancedb/lancedb.git
synced 2026-01-10 13:52:58 +00:00
* Sets `"useCodeBlocks": true` * Adds a post-processing script `nodejs/typedoc_post_process.js` that puts the parameter description on the same line as the parameter name, like it is in our Python docs. This makes the text hierarchy clearer in those sections and also makes the sections shorter.
47 lines
1.0 KiB
Markdown
47 lines
1.0 KiB
Markdown
[**@lancedb/lancedb**](../README.md) • **Docs**
|
|
|
|
***
|
|
|
|
[@lancedb/lancedb](../globals.md) / TimeoutConfig
|
|
|
|
# Interface: TimeoutConfig
|
|
|
|
Timeout configuration for remote HTTP client.
|
|
|
|
## Properties
|
|
|
|
### connectTimeout?
|
|
|
|
```ts
|
|
optional connectTimeout: number;
|
|
```
|
|
|
|
The timeout for establishing a connection in seconds. Default is 120
|
|
seconds (2 minutes). This can also be set via the environment variable
|
|
`LANCE_CLIENT_CONNECT_TIMEOUT`, as an integer number of seconds.
|
|
|
|
***
|
|
|
|
### poolIdleTimeout?
|
|
|
|
```ts
|
|
optional poolIdleTimeout: number;
|
|
```
|
|
|
|
The timeout for keeping idle connections in the connection pool in seconds.
|
|
Default is 300 seconds (5 minutes). This can also be set via the
|
|
environment variable `LANCE_CLIENT_CONNECTION_TIMEOUT`, as an integer
|
|
number of seconds.
|
|
|
|
***
|
|
|
|
### readTimeout?
|
|
|
|
```ts
|
|
optional readTimeout: number;
|
|
```
|
|
|
|
The timeout for reading data from the server in seconds. Default is 300
|
|
seconds (5 minutes). This can also be set via the environment variable
|
|
`LANCE_CLIENT_READ_TIMEOUT`, as an integer number of seconds.
|