util: add types.isFloat16Array()

LiviaMedeiros · RafaelGSS · commit ec79f7686d2b · 2025-05-02T17:06:29.000-03:00
PR-URL: #57879 Reviewed-By: Jordan Harband <ljharb@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/doc/api/util.md b/doc/api/util.md
@@ -3102,6 +3102,23 @@ types.isExternal(new String('foo')); // returns false
 For further information on `napi_create_external`, refer to
 [`napi_create_external()`][].
 
+### `util.types.isFloat16Array(value)`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+* `value` {any}
+* Returns: {boolean}
+
+Returns `true` if the value is a built-in {Float16Array} instance.
+
+```js
+util.types.isFloat16Array(new ArrayBuffer());  // Returns false
+util.types.isFloat16Array(new Float16Array());  // Returns true
+util.types.isFloat16Array(new Float32Array());  // Returns false
+```
+
 ### `util.types.isFloat32Array(value)`
 
 <!-- YAML
diff --git a/lib/internal/util/types.js b/lib/internal/util/types.js
@@ -38,6 +38,10 @@ function isInt32Array(value) {
   return TypedArrayPrototypeGetSymbolToStringTag(value) === 'Int32Array';
 }
 
+function isFloat16Array(value) {
+  return TypedArrayPrototypeGetSymbolToStringTag(value) === 'Float16Array';
+}
+
 function isFloat32Array(value) {
   return TypedArrayPrototypeGetSymbolToStringTag(value) === 'Float32Array';
 }
@@ -65,6 +69,7 @@ module.exports = {
   isInt8Array,
   isInt16Array,
   isInt32Array,
+  isFloat16Array,
   isFloat32Array,
   isFloat64Array,
   isBigInt64Array,
diff --git a/test/parallel/test-util-types.js b/test/parallel/test-util-types.js
@@ -1,4 +1,5 @@
-// Flags: --experimental-vm-modules --expose-internals --allow-natives-syntax
+// Flags: --experimental-vm-modules --expose-internals --allow-natives-syntax --js-float16array
+// TODO(LiviaMedeiros): once `Float16Array` is unflagged in v8, remove `--js-float16array` above
 'use strict';
 const common = require('../common');
 const assert = require('assert');
@@ -9,6 +10,9 @@ const { JSStream } = internalBinding('js_stream');
 
 const external = (new JSStream())._externalStream;
 
+// TODO(LiviaMedeiros): once linter recognizes `Float16Array`, remove next line
+const { Float16Array } = globalThis;
+
 for (const [ value, _method ] of [
   [ external, 'isExternal' ],
   [ new Date() ],
@@ -38,6 +42,7 @@ for (const [ value, _method ] of [
   [ new Int8Array() ],
   [ new Int16Array() ],
   [ new Int32Array() ],
+  [ new Float16Array() ],
   [ new Float32Array() ],
   [ new Float64Array() ],
   [ new BigInt64Array() ],
@@ -102,6 +107,9 @@ for (const [ value, _method ] of [
   assert(!types.isInt32Array({ [Symbol.toStringTag]: 'Int32Array' }));
   assert(types.isInt32Array(vm.runInNewContext('new Int32Array')));
 
+  assert(!types.isFloat16Array({ [Symbol.toStringTag]: 'Float16Array' }));
+  assert(types.isFloat16Array(vm.runInNewContext('new Float16Array')));
+
   assert(!types.isFloat32Array({ [Symbol.toStringTag]: 'Float32Array' }));
   assert(types.isFloat32Array(vm.runInNewContext('new Float32Array')));
 
@@ -127,6 +135,7 @@ for (const [ value, _method ] of [
   const int8Array = new Int8Array(arrayBuffer);
   const int16Array = new Int16Array(arrayBuffer);
   const int32Array = new Int32Array(arrayBuffer);
+  const float16Array = new Float16Array(arrayBuffer);
   const float32Array = new Float32Array(arrayBuffer);
   const float64Array = new Float64Array(arrayBuffer);
   const bigInt64Array = new BigInt64Array(arrayBuffer);
@@ -141,6 +150,7 @@ for (const [ value, _method ] of [
   const fakeInt8Array = { __proto__: Int8Array.prototype };
   const fakeInt16Array = { __proto__: Int16Array.prototype };
   const fakeInt32Array = { __proto__: Int32Array.prototype };
+  const fakeFloat16Array = { __proto__: Float16Array.prototype };
   const fakeFloat32Array = { __proto__: Float32Array.prototype };
   const fakeFloat64Array = { __proto__: Float64Array.prototype };
   const fakeBigInt64Array = { __proto__: BigInt64Array.prototype };
@@ -164,6 +174,10 @@ for (const [ value, _method ] of [
     Object.setPrototypeOf(new Int16Array(arrayBuffer), Int16Array.prototype);
   const stealthyInt32Array =
     Object.setPrototypeOf(new Int32Array(arrayBuffer), Int32Array.prototype);
+  const stealthyFloat16Array =
+    Object.setPrototypeOf(
+      new Float16Array(arrayBuffer), Float16Array.prototype
+    );
   const stealthyFloat32Array =
     Object.setPrototypeOf(
       new Float32Array(arrayBuffer), Float32Array.prototype
@@ -191,6 +205,7 @@ for (const [ value, _method ] of [
     int8Array, fakeInt8Array, stealthyInt8Array,
     int16Array, fakeInt16Array, stealthyInt16Array,
     int32Array, fakeInt32Array, stealthyInt32Array,
+    float16Array, fakeFloat16Array, stealthyFloat16Array,
     float32Array, fakeFloat32Array, stealthyFloat32Array,
     float64Array, fakeFloat64Array, stealthyFloat64Array,
     bigInt64Array, fakeBigInt64Array, stealthyBigInt64Array,
@@ -208,6 +223,7 @@ for (const [ value, _method ] of [
       int8Array, stealthyInt8Array,
       int16Array, stealthyInt16Array,
       int32Array, stealthyInt32Array,
+      float16Array, stealthyFloat16Array,
       float32Array, stealthyFloat32Array,
       float64Array, stealthyFloat64Array,
       bigInt64Array, stealthyBigInt64Array,
@@ -222,6 +238,7 @@ for (const [ value, _method ] of [
       int8Array, stealthyInt8Array,
       int16Array, stealthyInt16Array,
       int32Array, stealthyInt32Array,
+      float16Array, stealthyFloat16Array,
       float32Array, stealthyFloat32Array,
       float64Array, stealthyFloat64Array,
       bigInt64Array, stealthyBigInt64Array,
@@ -248,6 +265,9 @@ for (const [ value, _method ] of [
     isInt32Array: [
       int32Array, stealthyInt32Array,
     ],
+    isFloat16Array: [
+      float16Array, stealthyFloat16Array,
+    ],
     isFloat32Array: [
       float32Array, stealthyFloat32Array,
     ],
diff --git a/tools/doc/type-parser.mjs b/tools/doc/type-parser.mjs
@@ -19,7 +19,7 @@ const jsGlobalTypes = [
   'TypeError', 'URIError', 'WeakMap', 'WeakSet',
 
   'TypedArray',
-  'Float32Array', 'Float64Array',
+  'Float16Array', 'Float32Array', 'Float64Array',
   'Int8Array', 'Int16Array', 'Int32Array',
   'Uint8Array', 'Uint8ClampedArray', 'Uint16Array', 'Uint32Array',
 ];
