Skip to content

Commit 62143b5

Browse files
kevinoidtargos
authored andcommitted
doc: add util.types.isArrayBufferView()
This function was added by #15663, but was never documented. This commit documents it. PR-URL: #33092 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Masashi Hirano <shisama07@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com>
1 parent f127ae3 commit 62143b5

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/api/util.md

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

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

0 commit comments

Comments
 (0)