Interface IEnumerator<T>

Type parameters

T

Hierarchy

IIterator<T>
IDisposable
- IEnumerator

Implemented by

Index

Properties

Methods

Properties

current

current: T

The current value within the enumeration.

Optional isEndless

isEndless: boolean

Provides a way of flagging endless enumerations that may cause issues.

Methods

dispose

dispose(): void

Inherited from IDisposable.dispose
- Defined in source/System/Disposable/IDisposable.d.ts:9
Returns void

moveNext

moveNext(value?: any): boolean

- Defined in source/System/Collections/Enumeration/IEnumerator.d.ts:22
Safely moves to the next entry and returns true if there is one.

Parameters
- Optional value: any
Returns boolean

next

next(value?: any): IIteratorResult<T>

Inherited from IIterator.next
- Defined in source/System/Collections/Enumeration/IIterator.d.ts:17
Parameters
- Optional value: any
Returns IIteratorResult<T>

nextValue

nextValue(value?: any): T

- Defined in source/System/Collections/Enumeration/IEnumerator.d.ts:32
Calls .moveNext() and returns .current

Parameters
- Optional value: any
Returns T

reset

reset(): void

- Defined in source/System/Collections/Enumeration/IEnumerator.d.ts:27
Restarts the enumeration.

Returns void

Optional return

return<TReturn>(value?: TReturn): IIteratorResult<TReturn>

Inherited from IIterator.return
- Defined in source/System/Collections/Enumeration/IIterator.d.ts:18
Type parameters
- TReturn
Parameters
- Optional value: TReturn
Returns IIteratorResult<TReturn>

Optional throw

throw(e?: any): IIteratorResult<T>

Inherited from IIterator.throw
- Defined in source/System/Collections/Enumeration/IIterator.d.ts:19
Parameters
- Optional e: any
Returns IIteratorResult<T>

Generated using TypeDoc