JSAPI Reference

  • Revision slug: SpiderMonkey/JSAPI_Reference/JSAPI_Reference
  • Revision title: JSAPI Reference
  • Revision id: 147807
  • Created:
  • Creator: MMondor
  • Is current revision? No
  • Comment /* Macros */

Revision Content

Initial Notes

We are migrating the JSAPI Reference from here. If you are inclined to help with this migration, your help would be very much appreciated.

Note that the naming scheme has just changed once more. We now use *longer* article titles, like JSAPI:JSClass, instead of JSClass.

For pages that require underscores in the title, please see the documentation for the Title Override Extension.

Please add {{jsapiref}} right after breadcrumbs. This will add temporary link back to this page (until we can use breadcrumbs extension for that again).


Alphabetical List

Data Structures

Functions

Macros

Deprecated

Revision Source

<h3 name="Initial_Notes"> Initial Notes </h3>
<div class="note">
<p>We are migrating the JSAPI Reference from <a class="external" href="http://www.mozilla.org/js/spidermonkey/apidoc/complete-frameset.html">here</a>.  If you are inclined to help with this migration, your help would be very much appreciated.
</p><p><b>Note that the naming scheme has just changed once more. We now use *longer* article titles, like <a href="en/JSAPI/JSClass">JSAPI:JSClass</a>, instead of <a href="en/JSClass">JSClass</a>.</b>
</p>
</div>
<p>For pages that require underscores in the title, please see the documentation for the <a href="Help:en/Wiki_Markup_Reference#Title_Override_Extension">Title Override Extension</a>. 
</p><p>Please add <span class="plain">{{jsapiref}}</span> right after breadcrumbs. This will add temporary link back to this page (until we can use breadcrumbs extension for that again).
</p><p><br>
<a href="en/JSAPI_Reference/Alphabetical_List">Alphabetical List</a>
</p>
<h3 name="Data_Structures"> Data Structures </h3>
<ul><li> <a href="en/JSClass">JSClass</a>
</li><li> <a href="en/JSConstDoubleSpec">JSConstDoubleSpec</a>	 
</li><li> <a href="en/JSErrorReport">JSErrorReport</a>
</li><li> <a href="en/JSFunctionSpec">JSFunctionSpec</a>
</li><li> <a href="en/JSIdArray">JSIdArray</a>
</li><li> <a href="en/JSObjectOps">JSObjectOps</a>
</li><li> <a href="en/JSPrincipals">JSPrincipals</a>
</li><li> <a href="en/JSProperty">JSProperty</a>
</li><li> <a href="en/JSPropertySpec">JSPropertySpec</a>
</li></ul>
<h3 name="Functions"> Functions </h3>
<ul><li> <a href="en/JS_AddNamedRoot">JS_AddNamedRoot</a>
</li><li> <a href="en/JS_AddRoot">JS_AddRoot</a>
</li><li> <a href="en/JS_AliasElement">JS_AliasElement</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_AliasProperty">JS_AliasProperty</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_BeginRequest">JS_BeginRequest</a>
</li><li> <a href="en/JS_CallFunction">JS_CallFunction</a>
</li><li> <a href="en/JS_CallFunctionName">JS_CallFunctionName</a>
</li><li> <a href="en/JS_CallFunctionValue">JS_CallFunctionValue</a>
</li><li> <a href="en/JS_CheckAccess">JS_CheckAccess</a>
</li><li> <a href="en/JS_ClearContextThread">JS_ClearContextThread</a>
</li><li> <a href="en/JS_ClearScope">JS_ClearScope</a>
</li><li> <a href="en/JS_CloneFunctionObject">JS_CloneFunctionObject</a>
</li><li> <a href="en/JS_CompareStrings">JS_CompareStrings</a>
</li><li> <a href="en/JS_CompileFile">JS_CompileFile</a>
</li><li> <a href="en/JS_CompileFunction">JS_CompileFunction</a>
</li><li> <a href="en/JS_CompileFunctionForPrincipals">JS_CompileFunctionForPrincipals</a>
</li><li> <a href="en/JS_CompileScript">JS_CompileScript</a>
</li><li> <a href="en/JS_CompileScriptForPrincipals">JS_CompileScriptForPrincipals</a>
</li><li> <a href="en/JS_CompileUCFunction">JS_CompileUCFunction</a>
</li><li> <a href="en/JS_CompileUCFunctionForPrincipals">JS_CompileUCFunctionForPrincipals</a>
</li><li> <a href="en/JS_CompileUCScript">JS_CompileUCScript</a>
</li><li> <a href="en/JS_CompileUCScriptForPrincipals">JS_CompileUCScriptForPrincipals</a>
</li><li> <a href="en/JS_ConstructObject">JS_ConstructObject</a>
</li><li> <a href="en/JS_ContextIterator">JS_ContextIterator</a>
</li><li> <a href="en/JS_ConvertArguments">JS_ConvertArguments</a>
</li><li> <a href="en/JS_ConvertStub">JS_ConvertStub</a>
</li><li> <a href="en/JS_ConvertValue">JS_ConvertValue</a>
</li><li> <a href="en/JS_DecompileFunction">JS_DecompileFunction</a>
</li><li> <a href="en/JS_DecompileFunctionBody">JS_DecompileFunctionBody</a>
</li><li> <a href="en/JS_DecompileScript">JS_DecompileScript</a>
</li><li> <a href="en/JS_DefineConstDoubles">JS_DefineConstDoubles</a>
</li><li> <a href="en/JS_DefineElement">JS_DefineElement</a>
</li><li> <a href="en/JS_DefineFunction">JS_DefineFunction</a>
</li><li> <a href="en/JS_DefineFunctions">JS_DefineFunctions</a>
</li><li> <a href="en/JS_DefineObject">JS_DefineObject</a>
</li><li> <a href="en/JS_DefineProperties">JS_DefineProperties</a>
</li><li> <a href="en/JS_DefineProperty">JS_DefineProperty</a>
</li><li> <a href="en/JS_DefinePropertyWithTinyId">JS_DefinePropertyWithTinyId</a>
</li><li> <a href="en/JS_DefineUCProperty">JS_DefineUCProperty</a>
</li><li> <a href="en/JS_DefineUCPropertyWithTinyID">JS_DefineUCPropertyWithTinyID</a>
</li><li> <a href="en/JS_DeleteElement">JS_DeleteElement</a>
</li><li> <a href="en/JS_DeleteElement2">JS_DeleteElement2</a>
</li><li> <a href="en/JS_DeleteProperty">JS_DeleteProperty</a>
</li><li> <a href="en/JS_DeleteProperty2">JS_DeleteProperty2</a>
</li><li> <a href="en/JS_DeleteUCProperty2">JS_DeleteUCProperty2</a>
</li><li> <a href="en/JS_DestroyContext">JS_DestroyContext</a>
</li><li> <a href="en/JS_DestroyIdArray">JS_DestroyIdArray</a>
</li><li> <a href="en/JS_DestroyRuntime">JS_DestroyRuntime</a>
</li><li> <a href="en/JS_DestroyScript">JS_DestroyScript</a>
</li><li> <a href="en/JS_DumpNamedRoots">JS_DumpNamedRoots</a>
</li><li> <a href="en/JS_EndRequest">JS_EndRequest</a>
</li><li> <a href="en/JS_Enumerate">JS_Enumerate</a>
</li><li> <a href="en/JS_EnumerateStub">JS_EnumerateStub</a>
</li><li> <a href="en/JS_EvaluateScript">JS_EvaluateScript</a>
</li><li> <a href="en/JS_EvaluateScriptForPrincipals">JS_EvaluateScriptForPrincipals</a>
</li><li> <a href="en/JS_EvaluateUCScript">JS_EvaluateUCScript</a>
</li><li> <a href="en/JS_EvaluateUCScriptForPrincipals">JS_EvaluateUCScriptForPrincipals</a>
</li><li> <a href="en/JS_ExecuteScript">JS_ExecuteScript</a>
</li><li> <a href="en/JS_FinalizeStub">JS_FinalizeStub</a>
</li><li> <a href="en/JS_Finish">JS_Finish</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_GC">JS_GC</a>
</li><li> <a href="en/JS_GetArrayLength">JS_GetArrayLength</a>
</li><li> <a href="en/JS_GetClass">JS_GetClass</a>
</li><li> <a href="en/JS_GetConstructor">JS_GetConstructor</a>
</li><li> <a href="en/JS_GetContextPrivate">JS_GetContextPrivate</a>
</li><li> <a href="en/JS_GetContextThread">JS_GetContextThread</a>
</li><li> <a href="en/JS_GetElement">JS_GetElement</a>
</li><li> <a href="en/JS_GetEmptyStringValue">JS_GetEmptyStringValue</a>
</li><li> <a href="en/JS_GetFunctionName">JS_GetFunctionName</a>
</li><li> <a href="en/JS_GetFunctionObject">JS_GetFunctionObject</a>
</li><li> <a href="en/JS_GetGlobalObject">JS_GetGlobalObject</a>
</li><li> <a href="en/JS_GetImplementationVersion">JS_GetImplementationVersion</a>
</li><li> <a href="en/JS_GetInstancePrivate">JS_GetInstancePrivate</a>
</li><li> <a href="en/JS_GetNaNValue">JS_GetNaNValue</a>
</li><li> <a href="en/JS_GetNegativeInfinityValue">JS_GetNegativeInfinityValue</a>
</li><li> <a href="en/JS_GetParent">JS_GetParent</a>
</li><li> <a href="en/JS_GetPositiveInfinityValue">JS_GetPositiveInfinityValue</a>	 
</li><li> <a href="en/JS_GetPrivate">JS_GetPrivate</a>
</li><li> <a href="en/JS_GetProperty">JS_GetProperty</a>
</li><li> <a href="en/JS_GetPropertyAttributes">JS_GetPropertyAttributes</a>
</li><li> <a href="en/JS_GetPrototype">JS_GetPrototype</a>
</li><li> <a href="en/JS_GetRuntime">JS_GetRuntime</a>
</li><li> <a href="en/JS_GetScopeChain">JS_GetScopeChain</a>
</li><li> <a href="en/JS_GetStringBytes">JS_GetStringBytes</a>
</li><li> <a href="en/JS_GetStringChars">JS_GetStringChars</a>
</li><li> <a href="en/JS_GetStringLength">JS_GetStringLength</a>
</li><li> <a href="en/JS_GetUCProperty">JS_GetUCProperty</a>
</li><li> <a href="en/JS_GetVersion">JS_GetVersion</a>
</li><li> <a href="en/JS_HasArrayLength">JS_HasArrayLength</a>
</li><li> <a href="en/JS_IdToValue">JS_IdToValue</a>
</li><li> <a href="en/JS_Init">JS_Init</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_InitClass">JS_InitClass</a>
</li><li> <a href="en/JS_InitStandardClasses">JS_InitStandardClasses</a>
</li><li> <a href="en/JS_InstanceOf">JS_InstanceOf</a>
</li><li> <a href="en/JS_InternString">JS_InternString</a>
</li><li> <a href="en/JS_InternUCString">JS_InternUCString</a>
</li><li> <a href="en/JS_InternUCStringN">JS_InternUCStringN</a>
</li><li> <a href="en/JS_IsArrayObject">JS_IsArrayObject</a>
</li><li> <a href="en/JS_IsConstructing">JS_IsConstructing</a>
</li><li> <a href="en/JS_IsRunning">JS_IsRunning</a>
</li><li> <a href="en/JS_Lock">JS_Lock</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_LockGCThing">JS_LockGCThing</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_LookupElement">JS_LookupElement</a>
</li><li> <a href="en/JS_LookupProperty">JS_LookupProperty</a>
</li><li> <a href="en/JS_LookupUCProperty">JS_LookupUCProperty</a>
</li><li> <a href="en/JS_MaybeGC">JS_MaybeGC</a>
</li><li> <a href="en/JS_NewArrayObject">JS_NewArrayObject</a>
</li><li> <a href="en/JS_NewContext">JS_NewContext</a>
</li><li> <a href="en/JS_NewDouble">JS_NewDouble</a>
</li><li> <a href="en/JS_NewDoubleValue">JS_NewDoubleValue</a>
</li><li> <a href="en/JS_NewFunction">JS_NewFunction</a>
</li><li> <a href="en/JS_NewIdArray">JS_NewIdArray</a>
</li><li> <a href="en/JS_NewNumberValue">JS_NewNumberValue</a>
</li><li> <a href="en/JS_NewObject">JS_NewObject</a>
</li><li> <a href="en/JS_NewRuntime">JS_NewRuntime</a>
</li><li> <a href="en/JS_NewScriptObject">JS_NewScriptObject</a>
</li><li> <a href="en/JS_NewString">JS_NewString</a>
</li><li> <a href="en/JS_NewStringCopyN">JS_NewStringCopyN</a>
</li><li> <a href="en/JS_NewStringCopyZ">JS_NewStringCopyZ</a>
</li><li> <a href="en/JS_NewUCString">JS_NewUCString</a>
</li><li> <a href="en/JS_NewUCStringCopyN">JS_NewUCStringCopyN</a>
</li><li> <a href="en/JS_NewUCStringCopyZ">JS_NewUCStringCopyZ</a>
</li><li> <a href="en/JS_PropertyStub">JS_PropertyStub</a>
</li><li> <a href="en/JS_RemoveRoot">JS_RemoveRoot</a>
</li><li> <a href="en/JS_ReportError">JS_ReportError</a>
</li><li> <a href="en/JS_ReportOutOfMemory">JS_ReportOutOfMemory</a>
</li><li> <a href="en/JS_ResolveStub">JS_ResolveStub</a>
</li><li> <a href="en/JS_ResumeRequest">JS_ResumeRequest</a>
</li><li> <a href="en/JS_SetArrayLength">JS_SetArrayLength</a>
</li><li> <a href="en/JS_SetBranchCallback">JS_SetBranchCallback</a>
</li><li> <a href="en/JS_SetContextPrivate">JS_SetContextPrivate</a>
</li><li> <a href="en/JS_SetContextThread">JS_SetContextThread</a>
</li><li> <a href="en/JS_SetElement">JS_SetElement</a>
</li><li> <a href="en/JS_SetErrorReporter">JS_SetErrorReporter</a>
</li><li> <a href="en/JS_SetGCCallback">JS_SetGCCallback</a>
</li><li> <a href="en/JS_SetGlobalObject">JS_SetGlobalObject</a>
</li><li> <a href="en/JS_SetParent">JS_SetParent</a>
</li><li> <a href="en/JS_SetPrivate">JS_SetPrivate</a>
</li><li> <a href="en/JS_SetProperty">JS_SetProperty</a>
</li><li> <a href="en/JS_SetPropertyAttributes">JS_SetPropertyAttributes</a>
</li><li> <a href="en/JS_SetPrototype">JS_SetPrototype</a>
</li><li> <a href="en/JS_SetUCProperty">JS_SetUCProperty</a>
</li><li> <a href="en/JS_SetVersion">JS_SetVersion</a>
</li><li> <a href="en/JS_SuspendRequest">JS_SuspendRequest</a>
</li><li> <a href="en/JS_TypeOfValue">JS_TypeOfValue</a>
</li><li> <a href="en/JS_Unlock">JS_Unlock</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_UnlockGCThing">JS_UnlockGCThing</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_ValueToBoolean">JS_ValueToBoolean</a>
</li><li> <a href="en/JS_ValueToECMAInt32">JS_ValueToECMAInt32</a>
</li><li> <a href="en/JS_ValueToECMAUint32">JS_ValueToECMAUint32</a>
</li><li> <a href="en/JS_ValueToFunction">JS_ValueToFunction</a>
</li><li> <a href="en/JS_ValueToId">JS_ValueToId</a>
</li><li> <a href="en/JS_ValueToInt32">JS_ValueToInt32</a>
</li><li> <a href="en/JS_ValueToNumber">JS_ValueToNumber</a>
</li><li> <a href="en/JS_ValueToObject">JS_ValueToObject</a>
</li><li> <a href="en/JS_ValueToString">JS_ValueToString</a>
</li><li> <a href="en/JS_ValueToUint16">JS_ValueToUint16</a>
</li><li> <a href="en/JS_free">JS_free</a>
</li><li> <a href="en/JS_malloc">JS_malloc</a>
</li><li> <a href="en/JS_realloc">JS_realloc</a>
</li><li> <a href="en/JS_strdup">JS_strdup</a>
</li></ul>
<h3 name="Macros"> Macros </h3>
<ul><li> <a href="en/BOOLEAN_TO_JSVAL">BOOLEAN_TO_JSVAL</a>
</li><li> <a href="en/DOUBLE_TO_JSVAL">DOUBLE_TO_JSVAL</a>
</li><li> <a href="en/INT_FITS_IN_JSVAL">INT_FITS_IN_JSVAL</a>
</li><li> <a href="en/INT_TO_JSVAL">INT_TO_JSVAL</a>
</li><li> <a href="en/JSCLASS_HAS_PRIVATE">JSCLASS_HAS_PRIVATE</a>
</li><li> <a href="en/JSCLASS_NEW_ENUMERATE">JSCLASS_NEW_ENUMERATE</a>
</li><li> <a href="en/JSCLASS_NEW_RESOLVE">JSCLASS_NEW_RESOLVE</a>
</li><li> <a href="en/JSFUN_BOUND_METHOD">JSFUN_BOUND_METHOD</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSFUN_GLOBAL_PARENT">JSFUN_GLOBAL_PARENT</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSPRINCIPALS_DROP">JSPRINCIPALS_DROP</a>
</li><li> <a href="en/JSPRINCIPALS_HOLD">JSPRINCIPALS_HOLD</a>
</li><li> <a href="en/JSPROP_ENUMERATE">JSPROP_ENUMERATE</a>
</li><li> <a href="en/JSPROP_EXPORTED">JSPROP_EXPORTED</a>
</li><li> <a href="en/JSPROP_INDEX">JSPROP_INDEX</a>
</li><li> <a href="en/JSPROP_PERMANENT">JSPROP_PERMANENT</a>
</li><li> <a href="en/JSPROP_READONLY">JSPROP_READONLY</a>
</li><li> <a href="en/JSRESOLVE_ASSIGNING">JSRESOLVE_ASSIGNING</a>
</li><li> <a href="en/JSRESOLVE_QUALIFIED">JSRESOLVE_QUALIFIED</a>
</li><li> <a href="en/JSVAL_FALSE">JSVAL_FALSE</a>
</li><li> <a href="en/JSVAL_IS_BOOLEAN">JSVAL_IS_BOOLEAN</a>
</li><li> <a href="en/JSVAL_IS_DOUBLE">JSVAL_IS_DOUBLE</a>
</li><li> <a href="en/JSVAL_IS_GCTHING">JSVAL_IS_GCTHING</a>
</li><li> <a href="en/JSVAL_IS_INT">JSVAL_IS_INT</a>
</li><li> <a href="en/JSVAL_IS_NULL">JSVAL_IS_NULL</a>
</li><li> <a href="en/JSVAL_IS_NUMBER">JSVAL_IS_NUMBER</a>
</li><li> <a href="en/JSVAL_IS_OBJECT">JSVAL_IS_OBJECT</a>
</li><li> <a href="en/JSVAL_IS_PRIMITIVE">JSVAL_IS_PRIMITIVE</a>
</li><li> <a href="en/JSVAL_IS_STRING">JSVAL_IS_STRING</a>
</li><li> <a href="en/JSVAL_IS_VOID">JSVAL_IS_VOID</a>
</li><li> <a href="en/JSVAL_LOCK">JSVAL_LOCK</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSVAL_NULL">JSVAL_NULL</a>
</li><li> <a href="en/JSVAL_ONE">JSVAL_ONE</a>
</li><li> <a href="en/JSVAL_TO_BOOLEAN">JSVAL_TO_BOOLEAN</a>
</li><li> <a href="en/JSVAL_TO_DOUBLE">JSVAL_TO_DOUBLE</a>
</li><li> <a href="en/JSVAL_TO_GCTHING">JSVAL_TO_GCTHING</a>
</li><li> <a href="en/JSVAL_TO_INT">JSVAL_TO_INT</a>
</li><li> <a href="en/JSVAL_TO_OBJECT">JSVAL_TO_OBJECT</a>
</li><li> <a href="en/JSVAL_TO_PRIVATE">JSVAL_TO_PRIVATE</a>
</li><li> <a href="en/JSVAL_TO_STRING">JSVAL_TO_STRING</a>
</li><li> <a href="en/JSVAL_TRUE">JSVAL_TRUE</a>
</li><li> <a href="en/JSVAL_UNLOCK">JSVAL_UNLOCK</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSVAL_VOID">JSVAL_VOID</a>
</li><li> <a href="en/JSVAL_ZERO">JSVAL_ZERO</a>
</li><li> <a href="en/OBJECT_TO_JSVAL">OBJECT_TO_JSVAL</a>
</li><li> <a href="en/PRIVATE_TO_JSVAL">PRIVATE_TO_JSVAL</a>
</li><li> <a href="en/STRING_TO_JSVAL">STRING_TO_JSVAL</a>
</li></ul>
<h3 name="Deprecated"> Deprecated </h3>
<ul><li> <a href="en/JSFUN_BOUND_METHOD">JSFUN_BOUND_METHOD</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSFUN_GLOBAL_PARENT">JSFUN_GLOBAL_PARENT</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSVAL_LOCK">JSVAL_LOCK</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JSVAL_UNLOCK">JSVAL_UNLOCK</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_AliasElement">JS_AliasElement</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_AliasProperty">JS_AliasProperty</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_Finish">JS_Finish</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_Init">JS_Init</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_Lock">JS_Lock</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_LockGCThing">JS_LockGCThing</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_Unlock">JS_Unlock</a> {{template.Deprecated_inline()}}
</li><li> <a href="en/JS_UnlockGCThing">JS_UnlockGCThing</a> {{template.Deprecated_inline()}}
</li></ul>
Revert to this revision