Class TimedSet<T>

constructor

• new TimedSet<T>(_timeOut: number): TimedSet<T>

• Type Parameters

  • T

  Parameters

  • _timeOut: number

    Timeout in milliseconds

  Returns TimedSet<T>

Readonly[toStringTag]

rawSet

• get rawSet(): T[]

• Get the raw underlying set backing this times array. NOTE: this set is Immutable

  Returns T[]

size

• get size(): number

• Returns number

[iterator]

• "[iterator]"(): IterableIterator<T>

• Returns IterableIterator<T>

add

• add(key: T): this

• Parameters

  • key: T

  Returns this

clear

• clear(): void

• Returns void

delete

• delete(key: T): boolean

• Parameters

  • key: T

  Returns boolean

entries

• entries(): IterableIterator<[T, T]>

• Returns IterableIterator<[T, T]>

forEach

• forEach(
      callbackfn: (value: T, value2: T, set: ITimedSet<T>) => void,
      thisArg?: unknown,
  ): void

• Parameters

  • callbackfn: (value: T, value2: T, set: ITimedSet<T>) => void
  • OptionalthisArg: unknown

  Returns void

getTimeRemaining

• getTimeRemaining(key: T): number

• Get the time left until this item is removed from the set

  Parameters

  • key: T

  Returns number

has

• has(value: T): boolean

• Parameters

  • value: T

  Returns boolean

isEmpty

• isEmpty(): boolean

• checks if this set is empty

  Returns boolean

keys

• keys(): IterableIterator<T>

• Returns IterableIterator<T>

refresh

• refresh(key: T): boolean

• Refresh the timeout for this element (resets the timer for the items eviction)

  Parameters

  • key: T

    Key

  Returns boolean

values

• values(): IterableIterator<T>

• Returns IterableIterator<T>