tryError API Documentation v0.0.1-alpha.1

---

tryError API Documentation / ErrorPool

Class: ErrorPool

Defined in: pool.ts:48

Object pool for TryError instances

Constructors

Constructor

new ErrorPool(maxSize): ErrorPool;

Defined in: pool.ts:59

Parameters

maxSize

number = 100

Returns

ErrorPool

Methods

acquire()

acquire<T>(): PoolableError<T> & TryError<T>;

Defined in: pool.ts:106

Acquire an error from the pool

Type Parameters

T

T extends string = string

Returns

PoolableError<T> & TryError<T>

---

clear()

clear(): void;

Defined in: pool.ts:156

Clear the pool

Returns

void

---

getStats()

getStats(): {
  activeCount: number;
  creates: number;
  hitRate: number;
  hits: number;
  maxSize: number;
  misses: number;
  poolSize: number;
  returns: number;
};

Defined in: pool.ts:143

Get pool statistics

Returns

{
  activeCount: number;
  creates: number;
  hitRate: number;
  hits: number;
  maxSize: number;
  misses: number;
  poolSize: number;
  returns: number;
}

activeCount

activeCount: number;

creates

creates: number = 0;

hitRate

hitRate: number;

hits

hits: number = 0;

maxSize

maxSize: number;

misses

misses: number = 0;

poolSize

poolSize: number;

returns

returns: number = 0;

---

release()

release(error): void;

Defined in: pool.ts:125

Release an error back to the pool

Parameters

error

TryError

Returns

void

---

resize()

resize(newSize): void;

Defined in: pool.ts:164

Resize the pool

Parameters

newSize

number

Returns

void