Class Pool<EntryType>

constructor

• new Pool<EntryType>(entries?, rng?): Pool<EntryType>

• Type Parameters

  • EntryType

  Parameters

  • entries: EntryType[] = []
  • Optionalrng: RngInterface

  Returns Pool<EntryType>

rng

entries

• get entries(): EntryType[]

• Returns EntryType[]

• set entries(entries): void

• Parameters

  • entries: EntryType[]

  Returns void

length

• get length(): number

• Returns number

add

• add(entry): void

• Parameters

  • entry: EntryType

  Returns void

draw

• draw(): EntryType

• Draw an element from the pool, without replacement.

  Returns EntryType

  Throws

  PoolEmptyError if the pool is empty

drawMany

• drawMany(n): EntryType[]

• Draw n elements from the pool, without replacement.

  Parameters

  • n: number

  Returns EntryType[]

  Throws

  PoolEmptyError if the pool is empty

  Throws

  PoolNotEnoughElementsError if the pool does not have enough elements to draw n values

empty

• empty(): this

• Returns this

getEntries

• getEntries(): EntryType[]

• Returns EntryType[]

getRng

• getRng(): RngInterface

• Returns RngInterface

isEmpty

• isEmpty(): boolean

• Returns boolean

setEntries

• setEntries(entries): this

• Parameters

  • entries: EntryType[]

  Returns this

setRng

• setRng(rng): this

• Parameters

  • rng: RngInterface

  Returns this