Class default<T>

Enumrates an object source for values.

Type Parameters

T

Hierarchy

default<T>
- default

Implements

IEnumerator<T>

Index

Constructors

Properties

#current? #items #iterable #peak? return? throw?

Accessors

Methods

moveNext next peek reset items

Constructors

constructor

new default<T>(iterable): default<T>
Type Parameters
- T
Parameters
- iterable: Iterable<T>
Returns default<T>
Overrides default.constructor
- Defined in src/Enumerators/IterableEnumerator.ts:17

Properties

`Private` `Optional` #current

#current?: IteratorResult<T, void>

`Private` #items

#items: Generator<T, void, unknown>

`Private` `Readonly` #iterable

#iterable: Iterable<T>

`Private` `Optional` #peak

#peak?: IteratorResult<T, void>

`Optional` `Readonly` return

return?: ((value?) => IteratorResult<T, T>)

Type declaration

- (value?): IteratorResult<T, T>
- Parameters
  - Optional value: T
  Returns IteratorResult<T, T>

`Optional` `Readonly` throw

throw?: ((e?) => IteratorResult<T, T>)

Type declaration

- (e?): IteratorResult<T, T>
- Parameters
  - Optional e: T
  Returns IteratorResult<T, T>

Accessors

current

get current(): T
value of the current element

Returns T
Implementation of IEnumerator.current
Overrides EnumeratorBase.current
- Defined in src/Enumerators/IterableEnumerator.ts:24

Methods

moveNext

moveNext(): boolean
move to the next element. Returns false if there is no next element

Returns boolean
Implementation of IEnumerator.moveNext
Overrides default.moveNext
- Defined in src/Enumerators/IterableEnumerator.ts:39

next

next(): IteratorResult<T, T>
Returns IteratorResult<T, T>
Implementation of IEnumerator.next
Inherited from default.next
- Defined in src/Enumerators/EnumeratorBase.ts:12

peek

peek(): Undefinable<T>
returns the next element without moving the pointer forwards

Returns Undefinable<T>
Throws
Iterables cannot be peeked. Consider using BufferedIterableEnumerator.
Implementation of IEnumerator.peek
Overrides default.peek
- Defined in src/Enumerators/IterableEnumerator.ts:57

reset

reset(): void
reset the pointer to the start

Returns void
Throws
Iterables cannot be reset. Consider using BufferedIterableEnumerator.
Implementation of IEnumerator.reset
Overrides default.reset
- Defined in src/Enumerators/IterableEnumerator.ts:66

`Static` `Private` items

items<T>(iterable): Generator<T, void, unknown>
Type Parameters
- T
Parameters
- iterable: Iterable<T>
Returns Generator<T, void, unknown>
- Defined in src/Enumerators/IterableEnumerator.ts:71

Generated using TypeDoc