editor › Globals › RetainableQueue
Class: RetainableQueue ‹T›
This is a queue implementation that allows retaining elements and restoring those retained elements.
Type parameters
▪ T
Hierarchy
- RetainableQueue
Index
Constructors
Properties
Methods
Constructors
constructor
+ new RetainableQueue(retentionPolicy: RetentionPolicy): RetainableQueue
Defined in src/util/RetainableQueue.ts:26
Parameters:
| Name | Type |
|---|---|
retentionPolicy |
RetentionPolicy |
Returns: RetainableQueue
Properties
Private queue
• queue: T[] = []
Defined in src/util/RetainableQueue.ts:24
Private retainedElements
• retainedElements: T[] = []
Defined in src/util/RetainableQueue.ts:25
Private Readonly retentionPolicy
• retentionPolicy: RetentionPolicy
Defined in src/util/RetainableQueue.ts:26
Methods
Private _retain
▸ _retain(element: T): void
Defined in src/util/RetainableQueue.ts:64
Parameters:
| Name | Type |
|---|---|
element |
T |
Returns: void
clone
▸ clone(): RetainableQueue‹unknown›
Defined in src/util/RetainableQueue.ts:57
Returns: RetainableQueue‹unknown›
a shallow clone of this RetainableQueue. Shallow means that the elements are not cloned.
dequeue
▸ dequeue(): T
Defined in src/util/RetainableQueue.ts:37
Returns: T
enqueue
▸ enqueue(element: T): void
Defined in src/util/RetainableQueue.ts:32
Parameters:
| Name | Type |
|---|---|
element |
T |
Returns: void
isEmpty
▸ isEmpty(): boolean
Defined in src/util/RetainableQueue.ts:42
Returns: boolean
resetRetained
▸ resetRetained(): void
Defined in src/util/RetainableQueue.ts:50
Returns: void
restoreRetained
▸ restoreRetained(): void
Defined in src/util/RetainableQueue.ts:46
Returns: void