40 lines
1.4 KiB
Plaintext
40 lines
1.4 KiB
Plaintext
import Client from './client'
|
|
import TPoolStats from './pool-stats'
|
|
import { URL } from 'node:url'
|
|
import Dispatcher from './dispatcher'
|
|
|
|
export default Pool
|
|
|
|
type PoolConnectOptions = Omit<Dispatcher.ConnectOptions, 'origin'>
|
|
|
|
declare class Pool extends Dispatcher {
|
|
constructor (url: string | URL, options?: Pool.Options)
|
|
/** `true` after `pool.close()` has been called. */
|
|
closed: boolean
|
|
/** `true` after `pool.destroyed()` has been called or `pool.close()` has been called and the pool shutdown has completed. */
|
|
destroyed: boolean
|
|
/** Aggregate stats for a Pool. */
|
|
readonly stats: TPoolStats
|
|
|
|
// Override dispatcher APIs.
|
|
override connect (
|
|
options: PoolConnectOptions
|
|
): Promise<Dispatcher.ConnectData>
|
|
override connect (
|
|
options: PoolConnectOptions,
|
|
callback: (err: Error | null, data: Dispatcher.ConnectData) => void
|
|
): void
|
|
}
|
|
|
|
declare namespace Pool {
|
|
export type PoolStats = TPoolStats
|
|
export interface Options extends Client.Options {
|
|
/** Default: `(origin, opts) => new Client(origin, opts)`. */
|
|
factory?(origin: URL, opts: object): Dispatcher;
|
|
/** The max number of clients to create. `null` if no limit. Default `null`. */
|
|
connections?: number | null;
|
|
/** The amount of time before a client is removed from the pool and closed. `null` if no time limit. Default `null` */
|
|
clientTtl?: number | null;
|
|
}
|
|
}
|