editor › Globals › ExpiringSet
Class: ExpiringSet ‹T›
This class implements a Set, that lets you add elements with an expiry date. Elements will be removed automatically, when they expire.
Type parameters
▪ T
Hierarchy
- Set‹T›
↳ ExpiringSet
Index
Constructors
Properties
Methods
Constructors
constructor
+ new ExpiringSet(iterable?: any): ExpiringSet
Defined in src/util/ExpiringSet.ts:8
Parameters:
| Name | Type |
|---|---|
iterable? |
any |
Returns: ExpiringSet
Properties
Readonly [Symbol.toStringTag]
• [Symbol.toStringTag]: string
Inherited from ExpiringSet.[Symbol.toStringTag]
Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:138
Private Readonly _add
• _add: function
Defined in src/util/ExpiringSet.ts:8
Type declaration:
▸ (T: any): this
Parameters:
| Name | Type |
|---|---|
T |
any |
Readonly size
• size: number
Inherited from ExpiringSet.size
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:64
Private timeoutIds
• timeoutIds: Map‹T, number› = new Map()
Defined in src/util/ExpiringSet.ts:6
Static Set
▪ Set: SetConstructor
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:71
Methods
[Symbol.iterator]
▸ [Symbol.iterator](): IterableIterator‹T›
Inherited from ExpiringSet.[Symbol.iterator]
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:171
Iterates over values in the set.
Returns: IterableIterator‹T›
Private _forbiddenAdd
▸ _forbiddenAdd(element: T): this
Defined in src/util/ExpiringSet.ts:44
Parameters:
| Name | Type |
|---|---|
element |
T |
Returns: this
add
▸ add(value: T): this
Inherited from ExpiringSet.add
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:59
Parameters:
| Name | Type |
|---|---|
value |
T |
Returns: this
addExpiring
▸ addExpiring(element: T, timeLeft: number): this
Defined in src/util/ExpiringSet.ts:26
Parameters:
| Name | Type | Description |
|---|---|---|
element |
T | the element to add |
timeLeft |
number | the time left until the element will be removed, in ms |
Returns: this
clear
▸ clear(): void
Inherited from ExpiringSet.clear
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:60
Returns: void
delete
▸ delete(element: any): boolean
Overrides void
Defined in src/util/ExpiringSet.ts:17
Parameters:
| Name | Type |
|---|---|
element |
any |
Returns: boolean
entries
▸ entries(): IterableIterator‹[T, T]›
Inherited from ExpiringSet.entries
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:175
Returns an iterable of [v,v] pairs for every value v in the set.
Returns: IterableIterator‹[T, T]›
forEach
▸ forEach(callbackfn: function, thisArg?: any): void
Inherited from ExpiringSet.forEach
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:62
Parameters:
▪ callbackfn: function
▸ (value: T, value2: T, set: Set‹T›): void
Parameters:
| Name | Type |
|---|---|
value |
T |
value2 |
T |
set |
Set‹T› |
▪Optional thisArg: any
Returns: void
has
▸ has(value: T): boolean
Inherited from ExpiringSet.has
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:63
Parameters:
| Name | Type |
|---|---|
value |
T |
Returns: boolean
keys
▸ keys(): IterableIterator‹T›
Inherited from ExpiringSet.keys
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:179
Despite its name, returns an iterable of the values in the set,
Returns: IterableIterator‹T›
values
▸ values(): IterableIterator‹T›
Inherited from ExpiringSet.values
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:184
Returns an iterable of values in the set.
Returns: IterableIterator‹T›