Interface Iterator<T, TReturn, TNext>

interface Iterator<T, TReturn, TNext> {
    next(...args: [] | [TNext]): IteratorResult<T, TReturn>;
    return?(value?: TReturn): IteratorResult<T, TReturn>;
    throw?(e?: any): IteratorResult<T, TReturn>;
}

Type Parameters

T
TReturn = any
TNext = undefined

Hierarchy (view full)

Iterator
- IterableIterator

Index

Methods

next return? throw?

Methods

next

next(...args): IteratorResult<T, TReturn>
Parameters
- Rest...args: [] | [TNext]
Returns IteratorResult<T, TReturn>
- Defined in node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:43

`Optional`return

return(value?): IteratorResult<T, TReturn>
Parameters
- Optionalvalue: TReturn
Returns IteratorResult<T, TReturn>
- Defined in node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:44

`Optional`throw

throw(e?): IteratorResult<T, TReturn>
Parameters
- Optionale: any
Returns IteratorResult<T, TReturn>
- Defined in node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:45