Class SeekableIterator<T>

Wraps iterator to allow for seeking backwards and forwards. An internal cache of length maxLength is kept and progressively added to when iterating forwards.

Type Parameters

  • T

Implements

  • IterableIterator<T>

Constructors

constructor

Properties

base cache i iterator iteratorDone maxLength

Accessors

done elements

Methods

[iterator] next peek seek

Constructors

constructor

Properties

Protectedbase

base: number = 0

Absolute index of cache[0]. Increments when the cache evicts its oldest entry.

Protectedcache

cache: T[] = []

Protectedi

i: number = 0

Absolute index of the next value next() will return.

Protectediterator

iterator: Iterator<T>

ProtectediteratorDone

iteratorDone: boolean = false

ProtectedmaxLength

maxLength: number = Infinity

Accessors

done

elements

Methods

[iterator]

next

peek

  • peek<N extends number = 1>(ahead?: N): Tuple<T, N>

    Peek ahead of where the current iteration is. This doesn't consume any values of the iterator.

    Type Parameters

    • N extends number = 1

    Parameters

    • ahead: N = ...

      optional, the number of elements to peek ahead.

    Returns Tuple<T, N>

seek

  • seek(i: number): void

    Seeks forward/backwards to the index i. i may be any positive or negative number. Negative numbers seek starting from the end of the internal cache (e.g. -1 is the last element).

    Parameters

    • i: number

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods