Skip to content

Commit cb8f51e

Browse files
committed
doc: add util.types.isArrayBufferView()
This function was added by nodejs#15663, but was never documented. This commit documents it.
1 parent b37ec37 commit cb8f51e

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

doc/api/util.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1255,6 +1255,25 @@ util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
12551255
util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
12561256
```
12571257

1258+
### `util.types.isArrayBufferView(value)`
1259+
<!-- YAML
1260+
added: v10.0.0
1261+
-->
1262+
1263+
* `value` {any}
1264+
* Returns: {boolean}
1265+
1266+
Returns `true` if the value is an instance of one of the [`ArrayBuffer`][]
1267+
views, such as typed array objects or [`DataView`][]. Equivalent to
1268+
[`ArrayBuffer.isView()`][].
1269+
1270+
```js
1271+
util.types.isArrayBufferView(new Int8Array()); // true
1272+
util.types.isArrayBufferView(Buffer.from('hello world')); // true
1273+
util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true
1274+
util.types.isArrayBufferView(new ArrayBuffer()); // false
1275+
```
1276+
12581277
### `util.types.isArgumentsObject(value)`
12591278
<!-- YAML
12601279
added: v10.0.0

0 commit comments

Comments
 (0)