RentalPool <T>

Index

Constructors

• constructor

Properties

• builder
• cleaner

Methods

• grow
• rent
• return

Constructors

constructor

• new RentalPool<T>(builder: () => T, cleaner: (used: T) => T, preAllocate?: number): RentalPool<T>

• Type parameters

  • T

  Parameters

  • builder: () => T

  • cleaner: (used: T) => T

  • preAllocate: number = 1

  Returns RentalPool<T>

Properties

publicbuilder

builder: () => T

Type declaration

• • (): T

  • Returns T

publiccleaner

cleaner: (used: T) => T

Type declaration

• • (used: T): T

  • Parameters

    • used: T

    Returns T

Methods

grow

• grow(amount: number): void

• Grow the pool size by an amount

  ---

  Parameters

  • amount: number

  Returns void

rent

• rent(clean?: boolean): T

• Rent an object from the pool, optionally clean it. If not cleaned previous state may be set.

  The pool will automatically double if depleted

  ---

  Parameters

  • clean: boolean = false

  Returns T

return

• return(object: T): void

• Return an object to the pool

  ---

  Parameters

  • object: T

  Returns void