Skip to content

Commit ec90a3c

Browse files
charmanderCorey Van Woert
andauthored
docs: keepAlive and keepAliveInitialDelayMillis (#3609)
Co-authored-by: Corey Van Woert <corey.vanwoert@helloalfred.com>
1 parent f2d7d11 commit ec90a3c

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

docs/pages/apis/client.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ type Config = {
2323
lock_timeout?: number, // number of milliseconds a query is allowed to be en lock state before it's cancelled due to lock timeout
2424
application_name?: string, // The name of the application that created this Client instance
2525
connectionTimeoutMillis?: number, // number of milliseconds to wait for connection, default is no timeout
26-
keepAliveInitialDelayMillis?: number, // set the initial delay before the first keepalive probe is sent on an idle socket
26+
keepAlive?: boolean, // if true, enable keepalive on the `net.Socket`
27+
keepAliveInitialDelayMillis?: number, // number of milliseconds between last data packet received and first keepalive probe, default is 0 (keep existing value);
28+
// no effect unless `keepAlive` is true
2729
idle_in_transaction_session_timeout?: number, // number of milliseconds before terminating any session with an open idle transaction, default is no timeout
2830
client_encoding?: string, // specifies the character set encoding that the database uses for sending data to the client
2931
fallback_application_name?: string, // provide an application name to use if application_name is not set

0 commit comments

Comments
 (0)