JS::NewFunctionFromSpec

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

Create a new function based on the given JSFunctionSpec.

Syntax

JSFunction*
JS::NewFunctionFromSpec(JSContext* cx, const JSFunctionSpec* fs, HandleId id);
Name Type Description
cx JSContext * The context in which to define functions. Requires request. In a JS_THREADSAFE build, the caller must be in a request on this JSContext.
fs const JSFunctionSpec * A pointer to function specification.
behavior HandleId The result of a successful call to PropertySpecNameToPermanentId(cx, fs->name, &id).

Description

JS::NewFunctionFromSpec creates a new function based on the given JSFunctionSpec, *fs. id is the result of a successful call to PropertySpecNameToPermanentId(cx, fs->name, &id).

Unlike JS_DefineFunctions, this does not treat fs as an array. *fs must not be JS_FS_END.

On success, JS::NewFunctionFromSpec returns a pointer to newly created function. On error, it returns nullptr.

See Also

Document Tags and Contributors

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