JS_ThrowStopIteration

This article covers features introduced in SpiderMonkey js1.8

Throw a StopIteration exception.

Syntax

bool
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.

See Also