Class PeekableIterator<T>

An iterator that can have its next item be peeked at without being advanced.

Type Parameters

T
type of the item

Hierarchy

IteratorBase
- PeekableIterator

Index

Constructors

Methods

Constructors

constructor

new PeekableIterator<T>(it: Iterator<T>): PeekableIterator<T>
Type Parameters
- T
Parameters
- it: Iterator<T>
Returns PeekableIterator<T>
Overrides IteratorBase.constructor
- Defined in src/peekable.ts:13

Methods

next

next(): IteratorResult<T, undefined>
Advances the iterator, returning the current item.

Returns IteratorResult<T, undefined>
- Defined in src/peekable.ts:22

peek

peek(): IteratorResult<T, undefined>
Peeks at the next item.

Returns IteratorResult<T, undefined>
- Defined in src/peekable.ts:34