Class ConnectionPool<T>

Connection pool for managing persistent WebSocket connections.

Reuses connections efficiently and automatically refreshes them after max duration. Prevents creating too many connections in a single conversation.

Type Parameters

T

Index

Constructors

Methods

close get invalidate prewarm put remove withConnection

Constructors

constructor

new ConnectionPool<T>(options): ConnectionPool<T>
Type Parameters
- T
Parameters
- options: ConnectionPoolOptions<T>
Returns ConnectionPool<T>
- Defined in connection_pool.ts:67

Methods

close

close(): Promise<void>
Close all connections, draining any pending connection closures.

Returns Promise<void>
- Defined in connection_pool.ts:297

get

get(timeout?): Promise<T>
Get an available connection or create a new one if needed.
Parameters
- Optional timeout: number
  Connection timeout in milliseconds
Returns Promise<T>
An active connection object
- Defined in connection_pool.ts:123

invalidate

invalidate(): void
Clear all existing connections.

Marks all current connections to be closed during the next drain cycle.

Returns void
- Defined in connection_pool.ts:205

prewarm

prewarm(): void
Initiate prewarming of the connection pool without blocking.

This method starts a background task that creates a new connection if none exist. The task automatically cleans itself up when the connection pool is closed.

Returns void
- Defined in connection_pool.ts:219

put

put(conn): void
Mark a connection as available for reuse.

If connection has been removed, it will not be added to the pool.
Parameters
- conn: T
  The connection to make available
Returns void
- Defined in connection_pool.ts:166

remove

remove(conn): void
Remove a specific connection from the pool.

Marks the connection to be closed during the next drain cycle.
Parameters
- conn: T
  The connection to remove
Returns void
- Defined in connection_pool.ts:180

withConnection

withConnection<R>(fn, options?): Promise<R>
Get a connection from the pool and automatically return it when done. Handles abort signals and ensures proper cleanup.
Type Parameters
- R
Parameters
- fn: ((conn) => Promise<R>)
  Function to execute with the connection
  - - (conn): Promise<R>
    - Parameters
      conn: T
      Returns Promise<R>
- Optional options: {
  signal?: AbortSignal;
  timeout?: number;
  }
  Options including timeout and abort signal
  - Optional signal?: AbortSignal
  - Optional timeout?: number
Returns Promise<R>
The result of the function
- Defined in connection_pool.ts:257