JS_BufferIsCompilableUnit

This article needs a technical review. How you can help.

Determine whether a buffer is compilable unit.

Syntax

bool
JS_BufferIsCompilableUnit(JSContext *cx, JS::Handle<JSObject*> obj,
                          const char *utf8, size_t length);
Name Type Description
cx JSContext * Pointer to a JS context from which to derive runtime information. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
obj JS::HandleObject The global object, or NULL.
utf8 const char * String containing the script to compile.
length size_t The length of utf8 in characters.

Description

Given a buffer, return false if the buffer might become a valid JavaScript statement with the addition of more lines. Otherwise return true. The intent is to support interactive compilation - accumulate lines in a buffer until JS_BufferIsCompilableUnit is true, then pass it to the compiler.

See Also

Document Tags and Contributors

 Contributors to this page: fscholz, arai
 Last updated by: fscholz,