Interface StringIterator<T>

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

interface StringIterator<T> {
    [iterator](): StringIterator<T>;
    next(...__namedParameters): IteratorResult<T, undefined>;
    return?(value?): IteratorResult<T, undefined>;
    throw?(e?): IteratorResult<T, undefined>;
}

Type Parameters

T

Hierarchy (view full)

IteratorObject<T, BuiltinIteratorReturn, unknown>
- StringIterator

Index

Methods

[iterator] next return? throw?

Methods

[iterator]

[iterator](): StringIterator<T>
Returns StringIterator<T>
Overrides IteratorObject.[iterator]

next

next(...__namedParameters): IteratorResult<T, undefined>
Parameters
- Rest ...__namedParameters: [] | [unknown]
Returns IteratorResult<T, undefined>
Inherited from IteratorObject.next

`Optional` return

return(value?): IteratorResult<T, undefined>
Parameters
- Optional value: undefined
Returns IteratorResult<T, undefined>
Inherited from IteratorObject.return

`Optional` throw

throw(e?): IteratorResult<T, undefined>
Parameters
- Optional e: any
Returns IteratorResult<T, undefined>
Inherited from IteratorObject.throw