Determine if a specified object is an Array.

Syntax

bool
JS_IsArrayObject(JSContext *cx, JS::HandleValue value, bool *isArray);

bool
JS_IsArrayObject(JSContext *cx, JS::HandleObject obj, bool *isArray);

// Obsolete since JSAPI 44

bool
JS_IsArrayObject(JSContext *cx, JS::HandleValue value);

bool
JS_IsArrayObject(JSContext *cx, JS::HandleObject obj);
Name Type Description
cx JSContext * A context.
value JS::HandleValue The value to examine.
obj JS::HandleObject The object to examine.
isArray bool Whether the value/object is an array.

Description

JS_IsArrayObject determines if a specified object, obj or value, is an Array object.

On success, returns true and sets isArray indicating whether obj is an Array object or a wrapper around one. Otherwise returns false on failure.

See Also