Class default<T>

A flexible Object Pool that trims the pool down to the specified max size after a specified delay.

Type Parameters

Hierarchy

default
- default

Index

Constructors

constructor

new default<T>(_generator?: ((...args: any[]) => T), _recycler?: ((o: T) => void), _maxSize?: number): default<T>
A transient amount of object to exist over _maxSize until trim() is called. But any added objects over _localAbsMaxSize will be disposed immediately.
Type Parameters
- T
Parameters
- Optional _generator: ((...args: any[]) => T)
  
  The delegate to create new items.
  - - (...args: any[]): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
- Optional _recycler: ((o: T) => void)
  
  An optional delegate to clean/process items before returning to the pool.
  - - (o: T): void
    - Parameters
      
      o: T
      
      Returns void
- _maxSize: number = DEFAULT_MAX_SIZE
  
  The soft ceiling by which the pool is trimmed. Default is 1000.
Returns default<T>
Overrides DisposableBase.constructor
- Defined in ObjectPool.ts:41

Accessors

count

get count(): number
Current number of objects in the pool.

Returns

Returns number
- Defined in ObjectPool.ts:69

maxSize

get maxSize(): number
The soft ceiling by which the pool is trimmed.

Returns

Returns number
- Defined in ObjectPool.ts:60

Methods

`Protected` _cancelAutoTrim

_cancelAutoTrim(): void
Returns void
- Defined in ObjectPool.ts:280

`Protected` _onDispose

_onDispose(): void
Returns void
Overrides DisposableBase._onDispose
- Defined in ObjectPool.ts:290

`Protected` _recycle

_recycle(): void
Returns void
- Defined in ObjectPool.ts:267

autoTrim

autoTrim(msLater?: number, max?: number): void
Signals the pool to trim after a delay.
Parameters
- msLater: number = AUTO_REDUCE_DEFAULT_MS
- max: number = NaN
Returns void
- Defined in ObjectPool.ts:144

clear

clear(): void
Clears out the pool.

Returns void
- Defined in ObjectPool.ts:159

dump

dump(): T[]
Shortcut for toArrayAndClear();

Returns T[]
- Defined in ObjectPool.ts:181

give

give(entry: T): void
Gives an item to the pool. If recyclable, will be added to the recycler.
Parameters
- entry: T
Returns void
- Defined in ObjectPool.ts:190

rent

rent(closure: ((entry: T) => void)): void
Short term renting of an item.
Parameters
- closure: ((entry: T) => void)
  - - (entry: T): void
    - Parameters
      
      entry: T
      
      Returns void
Returns void
- Defined in ObjectPool.ts:260

take

take(factory?: (() => T)): T
Returns an item from the pool or creates one using the provided factory or the default factory configured with the pool.

Returns
Parameters
- Optional factory: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in ObjectPool.ts:246

toArrayAndClear

toArrayAndClear(): T[]
Empties the pool into an array and returns it.

Returns

Returns T[]
- Defined in ObjectPool.ts:168

trim

trim(max?: number): void
Trims the pool to the optional specified max (or the default).
Parameters
- Optional max: number
Returns void
- Defined in ObjectPool.ts:108

tryTake

tryTake(): undefined | T
Attempts to get an item from the pool. Returns undefined if none available.

Returns

Returns undefined | T
- Defined in ObjectPool.ts:228

`Static` create

create<T>(generator?: ((...args: any[]) => T), recycler?: ((o: T) => void), max?: number): default<T>
Creates a pool using the specified generator and optional recycler.

Returns
Type Parameters
- T
Parameters
- Optional generator: ((...args: any[]) => T)
  - - (...args: any[]): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
- Optional recycler: ((o: T) => void)
  - - (o: T): void
    - Parameters
      
      o: T
      
      Returns void
- max: number = DEFAULT_MAX_SIZE
Returns default<T>
- Defined in ObjectPool.ts:83

`Static` createAutoRecycled

createAutoRecycled<T>(generator?: ((...args: any[]) => T), max?: number): default<T>
Creates an auto-recycled pool using the specified generator.

Returns
Type Parameters
- T extends Recyclable
Parameters
- Optional generator: ((...args: any[]) => T)
  - - (...args: any[]): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
- max: number = DEFAULT_MAX_SIZE
Returns default<T>
- Defined in ObjectPool.ts:97

Class default<T>

Type Parameters

T

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

Optional _generator: ((...args: any[]) => T)

Parameters

Rest ...args: any[]

Returns T

Optional _recycler: ((o: T) => void)

Parameters

o: T

Returns void

_maxSize: number = DEFAULT_MAX_SIZE

Returns default<T>

Accessors

count

Returns

Returns number

maxSize

Returns

Returns number

Methods

Protected _cancelAutoTrim

Returns void

Protected _onDispose

Returns void

Protected _recycle

Returns void

autoTrim

Parameters

msLater: number = AUTO_REDUCE_DEFAULT_MS

max: number = NaN

Returns void

clear

Returns void

dump

Returns T[]

give

Parameters

entry: T

Returns void

rent

Parameters

closure: ((entry: T) => void)

Parameters

entry: T

Returns void

Returns void

take

Returns

Parameters

Optional factory: (() => T)

Returns T

Returns T

toArrayAndClear

Returns

Returns T[]

trim

Parameters

Optional max: number

Returns void

tryTake

Returns

Returns undefined | T

Static create

Returns

Type Parameters

T

Parameters

Optional generator: ((...args: any[]) => T)

Parameters

`Optional` _generator: ((...args: any[]) => T)

`Rest` ...args: any[]

`Optional` _recycler: ((o: T) => void)

`Protected` _cancelAutoTrim

`Protected` _onDispose

`Protected` _recycle

`Optional` factory: (() => T)

`Optional` max: number

`Static` create

`Optional` generator: ((...args: any[]) => T)

`Rest` ...args: any[]

`Optional` recycler: ((o: T) => void)

`Static` createAutoRecycled

`Optional` generator: ((...args: any[]) => T)

`Rest` ...args: any[]