JS_GC

Performs garbage collection in the JS memory pool.

Syntax

void
JS_GC(JSContext *cx); // Added in SpiderMonkey 52
void
JS_GC(JSRuntime *rt); // Obsolete since JSAPI 50
void
JS_GC(JSContext *cx); // Obsolete since JSAPI 14
Name Type Description
cx JSContext * The context to for which to perform garbage collection. Added in SpiderMonkey 52
rt JSRuntime * The runtime to for which to perform garbage collection. Obsolete since JSAPI 50

Description

JS_GC performs garbage collection of JS objects, strings and other internal data structures that are no longer reachable in the specified context or runtime. Garbage collection frees memory so that it can be reused by the system.

When your scripts create many objects, you may want to call JS_GC directly in your code, particularly when a script terminates or when the application has idle time. To perform garbage collection only if needed, call JS_MaybeGC instead.

Use JS_SetGCCallback to add hooks that are called during garbage collection.

See Also

Document Tags and Contributors

Tags: 
 Contributors to this page: arai, JonCoppeard, fscholz, Jorend, Dria, MMondor, Nickolay, Tservo
 Last updated by: arai,