Class: ResourceRentalPool

resource-rental/resource-rental-pool.ResourceRentalPool

Pool of resource rentals that can be borrowed, released or destroyed.

• constructor

• events

• acquire
• release
• destroy
• drainAndClear
• getSize
• getAvailableSize
• getBorrowedSize
• ready
• withRental

• new ResourceRentalPool(options): ResourceRentalPool

ResourceRentalPool

src/resource-rental/resource-rental-pool.ts:96

• Readonly events: EventEmitter<ResourceRentalPoolEvents, any>

src/resource-rental/resource-rental-pool.ts:59

▸ acquire(signalOrTimeout?): Promise<ResourceRental>

Borrow a resource rental from the pool. If there is no valid resource rental a new one will be created.

Promise<ResourceRental>

src/resource-rental/resource-rental-pool.ts:216

▸ release(resourceRental): Promise<void>

Promise<void>

src/resource-rental/resource-rental-pool.ts:255

▸ destroy(resourceRental): Promise<void>

Promise<void>

src/resource-rental/resource-rental-pool.ts:272

▸ drainAndClear(): Promise<void>

Sets the pool into draining mode and then clears it

When set to drain mode, no new acquires will be possible. At the same time, all agreements in the pool will be terminated with the Providers.

Promise<void>

Resolves when all agreements are terminated

src/resource-rental/resource-rental-pool.ts:327

▸ getSize(): number

Total size (available + borrowed)

number

src/resource-rental/resource-rental-pool.ts:340

▸ getAvailableSize(): number

Available size (how many resource rental are ready to be borrowed)

number

src/resource-rental/resource-rental-pool.ts:347

▸ getBorrowedSize(): number

Borrowed size (how many resource rental are currently out of the pool)

number

src/resource-rental/resource-rental-pool.ts:354

▸ ready(timeoutMs?): Promise<void>

Wait till the pool is ready to use (min number of items in pool are usable). If an error occurs while creating new resource rentals, it will be retried until the pool is ready (potentially indefinitely). To stop this process if it fails to reach the desired state in a given time, you can pass either a timeout in milliseconds or an AbortSignal.

Promise<void>

Example

await pool.ready(10_000); // If the pool is not ready in 10 seconds, an error will be thrown

Example

await pool.ready(AbortSignal.timeout(10_000)); // If the pool is not ready in 10 seconds, an error will be thrown

src/resource-rental/resource-rental-pool.ts:373

▸ ready(abortSignal?): Promise<void>

Promise<void>

src/resource-rental/resource-rental-pool.ts:374

▸ withRental<T>(callback, signalOrTimeout?): Promise<T>

Acquire a resource rental from the pool and release it after the callback is done

Promise<T>

Example

const result = await pool.withRental(async (rental) => {
 // Do something with the rented resources
 return result;
 // pool.release(rental) is called automatically
 // even if an error is thrown in the callback
});

src/resource-rental/resource-rental-pool.ts:428