Skip to main content

IteratorObject

Describes an Iterator produced by the runtime that inherits from the intrinsic Iterator.prototype.

Extends

Extended by

Type Parameters

Type ParameterDefault type
T-
TReturnunknown
TNextunknown

Methods

[iterator]()

iterator: IteratorObject<T, TReturn, TNext>;

Returns

IteratorObject<T, TReturn, TNext>


next()

next(...__namedParameters): IteratorResult<T, TReturn>;

Parameters

ParameterType
...__namedParameters[] | [TNext]

Returns

IteratorResult<T, TReturn>

Inherited from

Iterator.next


return()?

optional return(value?): IteratorResult<T, TReturn>;

Parameters

ParameterType
value?TReturn

Returns

IteratorResult<T, TReturn>

Inherited from

Iterator.return


throw()?

optional throw(e?): IteratorResult<T, TReturn>;

Parameters

ParameterType
e?any

Returns

IteratorResult<T, TReturn>

Inherited from

Iterator.throw