Function toImmutableCircularQueue

toImmutableCircularQueue<TElement>(
source: Iterable<TElement>,
comparator?: EqualityComparator<TElement, TElement>,
): ImmutableCircularQueue<TElement>
Materialises source into an immutable circular queue that uses the implementation's default capacity.
Type Parameters
- TElement
  Type of elements within source.
Parameters
- source: Iterable<TElement>
  The source iterable.
- Optionalcomparator: EqualityComparator<TElement, TElement>
  Optional equality comparator used by the resulting queue.
Returns ImmutableCircularQueue<TElement>
An immutable circular queue containing the most recent elements from source, up to the default capacity.
Remarks
The entire sequence is enumerated immediately. Earlier items are discarded when the number of elements exceeds the queue's capacity (currently 32).
Example
```
const numbers = [1, 2, 3];
const immutableCircularQueue = toImmutableCircularQueue(numbers);
console.log(immutableCircularQueue.toArray()); // [1, 2, 3]
```
- Defined in src/enumerator/functions/toImmutableCircularQueue.ts:19
toImmutableCircularQueue<TElement>(
    source: Iterable<TElement>,
    capacity: number,
    comparator?: EqualityComparator<TElement, TElement>,
): ImmutableCircularQueue<TElement>
Materialises source into an immutable circular queue with the specified capacity.
Type Parameters
- TElement
  Type of elements within source.
Parameters
- source: Iterable<TElement>
  The source iterable.
- capacity: number
  Maximum number of elements retained by the resulting queue.
- Optionalcomparator: EqualityComparator<TElement, TElement>
  Optional equality comparator used by the resulting queue.
Returns ImmutableCircularQueue<TElement>
An immutable circular queue containing the most recent elements from source, bounded by capacity.
Remarks
The entire sequence is enumerated immediately. When source contains more than capacity elements, earlier items are discarded.
Example
```
const numbers = [1, 2, 3, 4, 5];
const immutableCircularQueue = toImmutableCircularQueue(numbers, 3);
console.log(immutableCircularQueue.toArray()); // [3, 4, 5]
```
- Defined in src/enumerator/functions/toImmutableCircularQueue.ts:39

Function toImmutableCircularQueue

Type Parameters

Parameters

Returns ImmutableCircularQueue<TElement>

Remarks

Example

Type Parameters

Parameters

Returns ImmutableCircularQueue<TElement>

Remarks

Example

Settings