Class Pool

constructor

• new Pool(): Pool

  Returns Pool

cID

list

type

_getList

• _getList(uid?: string): Poolable[]

  Gets the pool mapped to the UID.

  Parameters

  • Optionaluid: string

  Returns Poolable[]

canCloneObject

• canCloneObject(object: unknown): boolean

  Determines if the object is able to be cloned or not.

  Parameters

  • object: unknown

  Returns boolean

canCreateNewObject

• canCreateNewObject(object: unknown): boolean

  Determines if a new object is able to be created.

  Parameters

  • object: unknown

  Returns boolean

canInstantiateObject

• canInstantiateObject(object: unknown): boolean

  Determines if the object is able to be instantiated or not.

  Parameters

  • object: unknown

  Returns boolean

create

• create(functionOrObject: unknown, ...constructorArgs: unknown[]): unknown

  Attempts to create a new object either by creating a new instance or calling its clone method.

  Parameters

  • functionOrObject: unknown
  • ...constructorArgs: unknown[]

  Returns unknown

destroy

• destroy(): void

  Destroys all pools.

  Returns void

expire

• expire(obj: unknown): number

  Pushes an object into the pool.

  Parameters

  • obj: unknown

  Returns number

get

• get<T>(obj: T | (new (...args: never[]) => T), ...args: unknown[]): T

  Gets an object either by creating a new one or retrieving it from the pool. The pooled object is either constructed from obj (when it is a class) or a clone of obj; either way the result is a T, so callers no longer cast.

  Type Parameters

  • T

  Parameters

  • obj: T | (new (...args: never[]) => T)
  • ...args: unknown[]

  Returns T

getCount

• getCount(): number

  Gets a count of all objects in the pool.

  Returns number