Interface IterableIterator<T, TReturn, TNext>

Describes a user-defined Iterator that is also iterable.

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

Type Parameters

T
TReturn = any
TNext = any

Index

Methods

[iterator] next return? throw?

Methods

[iterator]

"[iterator]"(): IterableIterator<T>
Returns IterableIterator<T>
Zh
返回此对象的可迭代迭代器。

En
Returns an iterable iterator for this object.
- Defined in server/types/GameAPI.d.ts:1478

next

next(...args: [] | [TNext]): IteratorResult<T, TReturn>
Parameters
- ...args: [] | [TNext]
Returns IteratorResult<T, TReturn>
Zh
移至迭代器的下一个值。

En
Moves to the next value in the iterator.
Inherited from Iterator.next
- Defined in server/types/GameAPI.d.ts:1452

`Optional`return

return(value?: TReturn): IteratorResult<T, TReturn>
Parameters
- Optionalvalue: TReturn
Returns IteratorResult<T, TReturn>
Zh
结束迭代器并返回值。

En
Ends the iterator and returns a value.
Inherited from Iterator.return
- Defined in server/types/GameAPI.d.ts:1457

`Optional`throw

throw(e?: any): IteratorResult<T, TReturn>
Parameters
- Optionale: any
Returns IteratorResult<T, TReturn>
Zh
在迭代器中引发错误。

En
Throws an error in the iterator.
Inherited from Iterator.throw
- Defined in server/types/GameAPI.d.ts:1462