Interface Pool<TPoolItem, TDiagnostics>

Type Parameters

TPoolItem
TDiagnostics = GenericPoolDiagnostics

Hierarchy

Pool

Index

Methods

acquire drain getDiagnostics release retire

Methods

acquire

acquire(opts?): Promise<TPoolItem>
Acquires a resource from the pool, waits until a resource is available before resolving.
Parameters
- Optional opts: ActionOptions
Returns Promise<TPoolItem>
- Defined in src/common/types.ts:8

drain

drain(): Promise<void>
Destroys all resources in the pool.

Returns Promise<void>
- Defined in src/common/types.ts:14

getDiagnostics

getDiagnostics(): TDiagnostics
Returns information about the internal state of the pool.

Returns TDiagnostics
- Defined in src/common/types.ts:16

release

release(object, opts?): Promise<void>
Releases a resource back to the pool, waits until necessary cleanup has been performed before resolving.
Parameters
- object: TPoolItem
- Optional opts: ActionOptions
Returns Promise<void>
- Defined in src/common/types.ts:10

retire

retire(object, opts?): Promise<void>
Releases a resource back to the pool and retires it (makes it unavailable for future use).
Parameters
- object: TPoolItem
- Optional opts: ActionOptions
Returns Promise<void>
- Defined in src/common/types.ts:12

Generated using TypeDoc