Bug 1493806 clarify JS_IsArrayObject documentation re proxies r=jwalden
authorKarl Tomlinson <karlt+@karlt.net>
Mon, 08 Oct 2018 21:02:26 +0000
changeset 440040 cd94fba048645c2e73776138aac06c1b85ad334b
parent 440039 ffb0915bb97ef25af60e1f1cf021bafc0ba2d0c3
child 440041 0c2d8b9fe4a7eb428be7cbb44757ce1b1558f0dc
child 440136 adf7408d9bc64caec663921f7a21e43164b0a387
push id70560
push userktomlinson@mozilla.com
push dateTue, 09 Oct 2018 00:47:04 +0000
treeherderautoland@cd94fba04864 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersjwalden
bugs1493806
milestone64.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1493806 clarify JS_IsArrayObject documentation re proxies r=jwalden Differential Revision: https://phabricator.services.mozilla.com/D6703
js/src/jsapi.h
--- a/js/src/jsapi.h
+++ b/js/src/jsapi.h
@@ -2705,31 +2705,33 @@ JS_AlreadyHasOwnElement(JSContext* cx, J
 
 extern JS_PUBLIC_API(JSObject*)
 JS_NewArrayObject(JSContext* cx, const JS::HandleValueArray& contents);
 
 extern JS_PUBLIC_API(JSObject*)
 JS_NewArrayObject(JSContext* cx, size_t length);
 
 /**
- * Returns true and sets |*isArray| indicating whether |value| is an Array
- * object or a wrapper around one, otherwise returns false on failure.
+ * On success, returns true, setting |*isArray| to true if |value| is an Array
+ * object or a wrapper around one, or to false if not.  Returns false on
+ * failure.
  *
- * This method returns true with |*isArray == false| when passed a proxy whose
- * target is an Array, or when passed a revoked proxy.
+ * This method returns true with |*isArray == false| when passed an ES6 proxy
+ * whose target is an Array, or when passed a revoked proxy.
  */
 extern JS_PUBLIC_API(bool)
 JS_IsArrayObject(JSContext* cx, JS::HandleValue value, bool* isArray);
 
 /**
- * Returns true and sets |*isArray| indicating whether |obj| is an Array object
- * or a wrapper around one, otherwise returns false on failure.
+ * On success, returns true, setting |*isArray| to true if |obj| is an Array
+ * object or a wrapper around one, or to false if not.  Returns false on
+ * failure.
  *
- * This method returns true with |*isArray == false| when passed a proxy whose
- * target is an Array, or when passed a revoked proxy.
+ * This method returns true with |*isArray == false| when passed an ES6 proxy
+ * whose target is an Array, or when passed a revoked proxy.
  */
 extern JS_PUBLIC_API(bool)
 JS_IsArrayObject(JSContext* cx, JS::HandleObject obj, bool* isArray);
 
 extern JS_PUBLIC_API(bool)
 JS_GetArrayLength(JSContext* cx, JS::Handle<JSObject*> obj, uint32_t* lengthp);
 
 extern JS_PUBLIC_API(bool)