Function toCircularQueue

toCircularQueue<TElement>(
    source: Iterable<TElement>,
    capacity: number,
    comparator?: EqualityComparator<TElement, TElement>,
): CircularQueue<TElement>
Materialises source into a 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 CircularQueue<TElement>
A 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 circularQueue = toCircularQueue(numbers, 3);
console.log(circularQueue.toArray()); // [3, 4, 5]
```
- Defined in src/enumerator/functions/toCircularQueue.ts:20
toCircularQueue<TElement>(
source: Iterable<TElement>,
comparator?: EqualityComparator<TElement, TElement>,
): CircularQueue<TElement>
Materialises source into a circular queue using 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 CircularQueue<TElement>
A circular queue containing the most recent elements from source, bounded by the default capacity.

Remarks
The entire sequence is enumerated immediately. Earlier items are discarded when the number of elements exceeds the queue's capacity.
- Defined in src/enumerator/functions/toCircularQueue.ts:34

Function toCircularQueue

Type Parameters

Parameters

Returns CircularQueue<TElement>

Remarks

Example

Type Parameters

Parameters

Returns CircularQueue<TElement>

Remarks

Settings