JS_ThrowStopIteration

Throw a StopIteration exception.

Syntax

void JS_ThrowStopIteration(JSContext *cx);
Name Type Description
cx JSContext * The context in which to throw the StopIteration object.

Description

JS_ThrowStopIteration throws the appropriate StopIteration object for the function currently executing in cx.

In for…in and for each…in loops, the JavaScript engine can create an iterator object and call its .next method repeatedly, as described in New in JavaScript 1.7: Iterators. The .next method may throw StopIteration when there are no more values left to iterate. The engine automatically catches the exception and exits the loop.

JSClass.enumerate offers a simpler way to customize object iteration.

MXR ID Search for JS_ThrowStopIteration

Document Tags and Contributors

Contributors to this page: Jorend
Last updated by: Jorend,