rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2025-12-26 14:49:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e5f42a850e7545e273c7eeae8740de49db6b47b0
lancedb/docs/src/js/interfaces/TimeoutConfig.md
Will Jones db125013fc docs: better formatting for Node API docs (#1892) 
* 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.
2024-12-09 17:04:09 -08:00

1.0 KiB
Raw Blame History

@lancedb/lancedb • Docs

@lancedb/lancedb / TimeoutConfig

Interface: TimeoutConfig

Timeout configuration for remote HTTP client.

Properties

connectTimeout?

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?

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?

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.