Skip to content

doc: declare all parameter types #21782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rubys wants to merge 6 commits into from
Closed

doc: declare all parameter types #21782

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3ea7324
doc: declare all parameter types
rubys Jul 12, 2018
252c4bc
consistently use '*' for parameter lists
rubys Jul 12, 2018
f681244
{object} => {Object}, {function} => {Function}
rubys Jul 12, 2018
3ffc671
address GitHub comments
rubys Jul 13, 2018
16cee69
address more comments
rubys Jul 13, 2018
888f667
setuid may be a string
rubys Jul 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
address GitHub comments
  • Loading branch information
@rubys
rubys committed Jul 14, 2018
commit 3ffc6716c04e56850628420ccf9dfd45a516cc22
2 changes: 1 addition & 1 deletion doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,7 @@ added: v0.1.90
-->

* `data` {string|Buffer|Uint8Array}
* `encoding` {string} Only used when data is `string`. **Default:** `utf8`.
* `encoding` {string} Only used when data is `string`. **Default:** `'utf8'`.
* Returns: {net.Socket} The socket itself.

Half-closes the socket. i.e., it sends a FIN packet. It is possible the
Expand Down
2 changes: 1 addition & 1 deletion doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1691,7 +1691,7 @@ This feature is not available in [`Worker`][] threads.
<!-- YAML
added: v0.1.28
-->
* `id` {integer[]}
* `id` {integer}

The `process.setuid(id)` method sets the user identity of the process. (See
setuid(2).) The `id` can be passed as either a numeric ID or a username string.
Expand Down
76 changes: 38 additions & 38 deletions doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -939,7 +939,7 @@ useful for addon developers who prefer to do type checking in JavaScript.
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`ArrayBuffer`][] or
Expand All @@ -960,7 +960,7 @@ util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an `arguments` object.
Expand All @@ -979,7 +979,7 @@ function foo() {
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`ArrayBuffer`][] instance.
Expand All @@ -998,7 +998,7 @@ util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an [async function][].
Expand All @@ -1018,7 +1018,7 @@ util.types.isAsyncFunction(async function foo() {}); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a `BigInt64Array` instance. The
Expand All @@ -1038,7 +1038,7 @@ util.types.isBigInt64Array(new BigUint64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a `BigUint64Array` instance. The
Expand All @@ -1058,7 +1058,7 @@ util.types.isBigUint64Array(new BigUint64Array()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a boolean object, e.g. created
Expand All @@ -1080,7 +1080,7 @@ util.types.isBooleanObject(Boolean(true)); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`DataView`][] instance.
Expand All @@ -1100,7 +1100,7 @@ See also [`ArrayBuffer.isView()`][].
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Date`][] instance.
Expand All @@ -1116,7 +1116,7 @@ util.types.isDate(new Date()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a native `External` value.
Expand All @@ -1126,7 +1126,7 @@ Returns `true` if the value is a native `External` value.
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Float32Array`][] instance.
Expand All @@ -1144,7 +1144,7 @@ util.types.isFloat32Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Float64Array`][] instance.
Expand All @@ -1162,7 +1162,7 @@ util.types.isFloat64Array(new Float64Array()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a generator function.
Expand All @@ -1182,7 +1182,7 @@ util.types.isGeneratorFunction(function* foo() {}); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a generator object as returned from a
Expand All @@ -1204,7 +1204,7 @@ util.types.isGeneratorObject(generator); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Int8Array`][] instance.
Expand All @@ -1222,7 +1222,7 @@ util.types.isInt8Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Int16Array`][] instance.
Expand All @@ -1240,7 +1240,7 @@ util.types.isInt16Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Int32Array`][] instance.
Expand All @@ -1258,7 +1258,7 @@ util.types.isInt32Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Map`][] instance.
Expand All @@ -1274,7 +1274,7 @@ util.types.isMap(new Map()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an iterator returned for a built-in
Expand All @@ -1295,7 +1295,7 @@ util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an instance of a [Module Namespace Object][].
Expand All @@ -1314,7 +1314,7 @@ util.types.isModuleNamespaceObject(ns); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an instance of a built-in [`Error`][] type.
Expand All @@ -1332,7 +1332,7 @@ util.types.isNativeError(new RangeError()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a number object, e.g. created
Expand All @@ -1350,7 +1350,7 @@ util.types.isNumberObject(new Number(0)); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Promise`][].
Expand All @@ -1366,7 +1366,7 @@ util.types.isPromise(Promise.resolve(42)); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a [`Proxy`][] instance.
Expand All @@ -1385,7 +1385,7 @@ util.types.isProxy(proxy); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a regular expression object.
Expand All @@ -1402,7 +1402,7 @@ util.types.isRegExp(new RegExp('abc')); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Set`][] instance.
Expand All @@ -1418,7 +1418,7 @@ util.types.isSet(new Set()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is an iterator returned for a built-in
Expand All @@ -1439,7 +1439,7 @@ util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`SharedArrayBuffer`][] instance.
Expand All @@ -1458,7 +1458,7 @@ util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a string object, e.g. created
Expand All @@ -1476,7 +1476,7 @@ util.types.isStringObject(new String('foo')); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a symbol object, created
Expand All @@ -1495,7 +1495,7 @@ util.types.isSymbolObject(Object(symbol)); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`TypedArray`][] instance.
Expand All @@ -1515,7 +1515,7 @@ See also [`ArrayBuffer.isView()`][].
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Uint8Array`][] instance.
Expand All @@ -1533,7 +1533,7 @@ util.types.isUint8Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Uint8ClampedArray`][] instance.
Expand All @@ -1551,7 +1551,7 @@ util.types.isUint8ClampedArray(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Uint16Array`][] instance.
Expand All @@ -1569,7 +1569,7 @@ util.types.isUint16Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`Uint32Array`][] instance.
Expand All @@ -1587,7 +1587,7 @@ util.types.isUint32Array(new Float64Array()); // Returns false
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`WeakMap`][] instance.
Expand All @@ -1603,7 +1603,7 @@ util.types.isWeakMap(new WeakMap()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`WeakSet`][] instance.
Expand All @@ -1619,7 +1619,7 @@ util.types.isWeakSet(new WeakSet()); // Returns true
added: v10.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {boolean}

Returns `true` if the value is a built-in [`WebAssembly.Module`][] instance.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/v8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ changes to the API or wire format) may occur until this warning is removed.
added: v8.0.0
-->

* `value` {Object}
* `value` {any}
* Returns: {Buffer}

Uses a [`DefaultSerializer`][] to serialize `value` into a buffer.
Expand Down