Class default<T>

Enumrates an object source for values.

Type Parameters

T

Hierarchy

default<T>
- default

Implements

IEnumerator<T>

Index

Constructors

Properties

#baseArray #pointer return? throw?

Accessors

Methods

moveNext next peek reset throwOutOfBoundsException

Constructors

constructor

new default<T>(array, immutable?): default<T>
Enumerate an array.
Type Parameters
- T
Parameters
- array: T[]
  The array to enumerate.
- immutable: boolean = true
  True means the enumerator takes a copy of the array. False uses the array.
Returns default<T>
Overrides default.constructor
- Defined in src/Enumerators/ArrayEnumerator.ts:20

Properties

`Private` `Readonly` #baseArray

#baseArray: T[]

`Private` #pointer

#pointer: number = -1

`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/ArrayEnumerator.ts:36

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/ArrayEnumerator.ts:45

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>
Implementation of IEnumerator.peek
Overrides default.peek
- Defined in src/Enumerators/ArrayEnumerator.ts:55

reset

reset(): void
reset the pointer to the start

Returns void
Implementation of IEnumerator.reset
Overrides default.reset
- Defined in src/Enumerators/ArrayEnumerator.ts:65

`Private` throwOutOfBoundsException

throwOutOfBoundsException(): void
Returns void
- Defined in src/Enumerators/ArrayEnumerator.ts:70

Generated using TypeDoc