Class TransportPool`Experimental`

Hands out connected transports. A connection that fails with a transient error is dropped, so the next operation gets a fresh one. An FTP server that answers 421 (too many connections) shrinks the pool for the rest of the run.

Index

Constructors

Accessors

Methods

capabilities close run runWithRetry

Constructors

constructor

new TransportPool(factory: () => Transport, options: PoolOptions): TransportPool
Experimental
Parameters
- factory: () => Transport
- options: PoolOptions
Returns TransportPool
- Defined in transport/pool.ts:48

Accessors

limit

get limit(): number
Experimental
The most operations the pool runs at once now.

Returns number
- Defined in transport/pool.ts:56

Methods

capabilities

capabilities(signal?: AbortSignal): Promise<Capabilities>
Experimental
What the server offers, connecting first when no connection is open yet.
Parameters
- Optionalsignal: AbortSignal
Returns Promise<Capabilities>
- Defined in transport/pool.ts:119

close

close(): Promise<void>
Experimental
Closes every idle connection; connections in use close when they are handed back.

Returns Promise<void>
- Defined in transport/pool.ts:132

run

run<T>(
operation: (transport: Transport) => Promise<T>,
signal?: AbortSignal,
): Promise<T>
Experimental
Runs operation on a connected transport.
Type Parameters
- T
Parameters
- operation: (transport: Transport) => Promise<T>
- Optionalsignal: AbortSignal
Returns Promise<T>
- Defined in transport/pool.ts:95

runWithRetry

runWithRetry<T>(
operation: (transport: Transport) => Promise<T>,
options?: RetryOptions,
): Promise<T>
Experimental
run with retries after transient failures, each on a fresh connection.
Type Parameters
- T
Parameters
- operation: (transport: Transport) => Promise<T>
- options: RetryOptions = {}
Returns Promise<T>
- Defined in transport/pool.ts:127