summaryrefslogtreecommitdiff
path: root/doc/api/util.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-08-26 19:02:27 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-08-29 16:53:03 +0300
commit1a25f9639a9668d8ea90022b0f3d3b47d29971b6 (patch)
treeceba486d64311f7d40be3ad57db6bb217f9213fa /doc/api/util.md
parentb2f0cfa6b0e139a2f990d4e1e7104abf015fe8e7 (diff)
downloadandroid-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.tar.gz
android-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.tar.bz2
android-node-v8-1a25f9639a9668d8ea90022b0f3d3b47d29971b6.zip
doc: remove redundant 'Example:' and similar notes
Some nits were also fixed in passing. PR-URL: https://github.com/nodejs/node/pull/22537 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/util.md')
-rw-r--r--doc/api/util.md74
1 files changed, 0 insertions, 74 deletions
diff --git a/doc/api/util.md b/doc/api/util.md
index 2fadc6b9ef..a9340847c5 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -948,8 +948,6 @@ Returns `true` if the value is a built-in [`ArrayBuffer`][] or
See also [`util.types.isArrayBuffer()`][] and
[`util.types.isSharedArrayBuffer()`][].
-For example:
-
```js
util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
@@ -965,8 +963,6 @@ added: v10.0.0
Returns `true` if the value is an `arguments` object.
-For example:
-
<!-- eslint-disable prefer-rest-params -->
```js
function foo() {
@@ -986,8 +982,6 @@ Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
This does *not* include [`SharedArrayBuffer`][] instances. Usually, it is
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
-For example:
-
```js
util.types.isArrayBuffer(new ArrayBuffer()); // Returns true
util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
@@ -1006,8 +1000,6 @@ Note that this only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if
a transpilation tool was used.
-For example:
-
```js
util.types.isAsyncFunction(function foo() {}); // Returns false
util.types.isAsyncFunction(async function foo() {}); // Returns true
@@ -1023,8 +1015,6 @@ added: v10.0.0
Returns `true` if the value is a `BigInt64Array` instance.
-For example:
-
```js
util.types.isBigInt64Array(new BigInt64Array()); // Returns true
util.types.isBigInt64Array(new BigUint64Array()); // Returns false
@@ -1040,8 +1030,6 @@ added: v10.0.0
Returns `true` if the value is a `BigUint64Array` instance.
-For example:
-
```js
util.types.isBigUint64Array(new BigInt64Array()); // Returns false
util.types.isBigUint64Array(new BigUint64Array()); // Returns true
@@ -1058,8 +1046,6 @@ added: v10.0.0
Returns `true` if the value is a boolean object, e.g. created
by `new Boolean()`.
-For example:
-
```js
util.types.isBooleanObject(false); // Returns false
util.types.isBooleanObject(true); // Returns false
@@ -1079,8 +1065,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`DataView`][] instance.
-For example:
-
```js
const ab = new ArrayBuffer(20);
util.types.isDataView(new DataView(ab)); // Returns true
@@ -1099,8 +1083,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Date`][] instance.
-For example:
-
```js
util.types.isDate(new Date()); // Returns true
```
@@ -1125,8 +1107,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Float32Array`][] instance.
-For example:
-
```js
util.types.isFloat32Array(new ArrayBuffer()); // Returns false
util.types.isFloat32Array(new Float32Array()); // Returns true
@@ -1143,8 +1123,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Float64Array`][] instance.
-For example:
-
```js
util.types.isFloat64Array(new ArrayBuffer()); // Returns false
util.types.isFloat64Array(new Uint8Array()); // Returns false
@@ -1164,8 +1142,6 @@ Note that this only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if
a transpilation tool was used.
-For example:
-
```js
util.types.isGeneratorFunction(function foo() {}); // Returns false
util.types.isGeneratorFunction(function* foo() {}); // Returns true
@@ -1185,8 +1161,6 @@ Note that this only reports back what the JavaScript engine is seeing;
in particular, the return value may not match the original source code if
a transpilation tool was used.
-For example:
-
```js
function* foo() {}
const generator = foo();
@@ -1203,8 +1177,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Int8Array`][] instance.
-For example:
-
```js
util.types.isInt8Array(new ArrayBuffer()); // Returns false
util.types.isInt8Array(new Int8Array()); // Returns true
@@ -1221,8 +1193,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Int16Array`][] instance.
-For example:
-
```js
util.types.isInt16Array(new ArrayBuffer()); // Returns false
util.types.isInt16Array(new Int16Array()); // Returns true
@@ -1239,8 +1209,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Int32Array`][] instance.
-For example:
-
```js
util.types.isInt32Array(new ArrayBuffer()); // Returns false
util.types.isInt32Array(new Int32Array()); // Returns true
@@ -1257,8 +1225,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Map`][] instance.
-For example:
-
```js
util.types.isMap(new Map()); // Returns true
```
@@ -1274,8 +1240,6 @@ added: v10.0.0
Returns `true` if the value is an iterator returned for a built-in
[`Map`][] instance.
-For example:
-
```js
const map = new Map();
util.types.isMapIterator(map.keys()); // Returns true
@@ -1294,8 +1258,6 @@ added: v10.0.0
Returns `true` if the value is an instance of a [Module Namespace Object][].
-For example:
-
<!-- eslint-skip -->
```js
import * as ns from './a.js';
@@ -1313,8 +1275,6 @@ added: v10.0.0
Returns `true` if the value is an instance of a built-in [`Error`][] type.
-For example:
-
```js
util.types.isNativeError(new Error()); // Returns true
util.types.isNativeError(new TypeError()); // Returns true
@@ -1332,8 +1292,6 @@ added: v10.0.0
Returns `true` if the value is a number object, e.g. created
by `new Number()`.
-For example:
-
```js
util.types.isNumberObject(0); // Returns false
util.types.isNumberObject(new Number(0)); // Returns true
@@ -1349,8 +1307,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Promise`][].
-For example:
-
```js
util.types.isPromise(Promise.resolve(42)); // Returns true
```
@@ -1365,8 +1321,6 @@ added: v10.0.0
Returns `true` if the value is a [`Proxy`][] instance.
-For example:
-
```js
const target = {};
const proxy = new Proxy(target, {});
@@ -1384,8 +1338,6 @@ added: v10.0.0
Returns `true` if the value is a regular expression object.
-For example:
-
```js
util.types.isRegExp(/abc/); // Returns true
util.types.isRegExp(new RegExp('abc')); // Returns true
@@ -1401,8 +1353,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Set`][] instance.
-For example:
-
```js
util.types.isSet(new Set()); // Returns true
```
@@ -1418,8 +1368,6 @@ added: v10.0.0
Returns `true` if the value is an iterator returned for a built-in
[`Set`][] instance.
-For example:
-
```js
const set = new Set();
util.types.isSetIterator(set.keys()); // Returns true
@@ -1440,8 +1388,6 @@ Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
This does *not* include [`ArrayBuffer`][] instances. Usually, it is
desirable to test for both; See [`util.types.isAnyArrayBuffer()`][] for that.
-For example:
-
```js
util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false
util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
@@ -1458,8 +1404,6 @@ added: v10.0.0
Returns `true` if the value is a string object, e.g. created
by `new String()`.
-For example:
-
```js
util.types.isStringObject('foo'); // Returns false
util.types.isStringObject(new String('foo')); // Returns true
@@ -1476,8 +1420,6 @@ added: v10.0.0
Returns `true` if the value is a symbol object, created
by calling `Object()` on a `Symbol` primitive.
-For example:
-
```js
const symbol = Symbol('foo');
util.types.isSymbolObject(symbol); // Returns false
@@ -1494,8 +1436,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`TypedArray`][] instance.
-For example:
-
```js
util.types.isTypedArray(new ArrayBuffer()); // Returns false
util.types.isTypedArray(new Uint8Array()); // Returns true
@@ -1514,8 +1454,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Uint8Array`][] instance.
-For example:
-
```js
util.types.isUint8Array(new ArrayBuffer()); // Returns false
util.types.isUint8Array(new Uint8Array()); // Returns true
@@ -1532,8 +1470,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
-For example:
-
```js
util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true
@@ -1550,8 +1486,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Uint16Array`][] instance.
-For example:
-
```js
util.types.isUint16Array(new ArrayBuffer()); // Returns false
util.types.isUint16Array(new Uint16Array()); // Returns true
@@ -1568,8 +1502,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`Uint32Array`][] instance.
-For example:
-
```js
util.types.isUint32Array(new ArrayBuffer()); // Returns false
util.types.isUint32Array(new Uint32Array()); // Returns true
@@ -1586,8 +1518,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`WeakMap`][] instance.
-For example:
-
```js
util.types.isWeakMap(new WeakMap()); // Returns true
```
@@ -1602,8 +1532,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`WeakSet`][] instance.
-For example:
-
```js
util.types.isWeakSet(new WeakSet()); // Returns true
```
@@ -1618,8 +1546,6 @@ added: v10.0.0
Returns `true` if the value is a built-in [`WebAssembly.Module`][] instance.
-For example:
-
```js
const module = new WebAssembly.Module(wasmBuffer);
util.types.isWebAssemblyCompiledModule(module); // Returns true