Skip to content
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

Jump to bottom

[v9.x backport] doc: fix a typo in util.isDeepStrictEqual & doc: add missing Returns in fs & util #19127

Closed
wants to merge 2 commits into from
Closed

[v9.x backport] doc: fix a typo in util.isDeepStrictEqual & doc: add missing Returns in fs & util #19127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d01268
doc: fix a typo in util.isDeepStrictEqual
Feb 14, 2018
fde0d98
doc: add missing `Returns` in fs & util
Feb 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
16 changes: 16 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1198,6 +1198,7 @@ changes:
* `start` {integer}
* `end` {integer}
* `highWaterMark` {integer}
* Returns: {ReadStream}

Returns a new [`ReadStream`][] object. (See [Readable Streams][]).

Expand Down Expand Up @@ -1273,6 +1274,7 @@ changes:
* `mode` {integer}
* `autoClose` {boolean}
* `start` {integer}
* Returns: {WriteStream}

Returns a new [`WriteStream`][] object. (See [Writable Stream][]).

Expand Down Expand Up @@ -1428,6 +1430,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* Returns: {boolean}

Synchronous version of [`fs.exists()`][].
Returns `true` if the path exists, `false` otherwise.
Expand Down Expand Up @@ -1546,6 +1549,7 @@ added: v0.1.95
-->

* `fd` {integer}
* Returns: {fs.Stats}

Synchronous fstat(2). Returns an instance of [`fs.Stats`][].

Expand Down Expand Up @@ -1820,6 +1824,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* Returns: {fs.Stats}

Synchronous lstat(2). Returns an instance of [`fs.Stats`][].

Expand Down Expand Up @@ -1945,6 +1950,7 @@ added: v5.10.0
* `prefix` {string}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {string}

The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path.
Expand Down Expand Up @@ -2069,6 +2075,7 @@ changes:
* `path` {string|Buffer|URL}
* `flags` {string|number}
* `mode` {integer} **Default:** `0o666`
* Returns: {number}

Synchronous version of [`fs.open()`][]. Returns an integer representing the file
descriptor.
Expand Down Expand Up @@ -2159,6 +2166,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {Array} An array of filenames

Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`.
Expand Down Expand Up @@ -2260,6 +2268,7 @@ changes:
* `options` {Object|string}
* `encoding` {string|null} **Default:** `null`
* `flag` {string} **Default:** `'r'`
* Returns: {string|Buffer}

Synchronous version of [`fs.readFile()`][]. Returns the contents of the `path`.

Expand Down Expand Up @@ -2320,6 +2329,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {string|Buffer}

Synchronous readlink(2). Returns the symbolic link's string value.

Expand All @@ -2342,6 +2352,7 @@ changes:
* `offset` {integer}
* `length` {integer}
* `position` {integer}
* Returns: {number}

Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.

Expand Down Expand Up @@ -2452,6 +2463,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {string|Buffer}

Synchronously computes the canonical pathname by resolving `.`, `..` and
symbolic links.
Expand Down Expand Up @@ -2482,6 +2494,7 @@ added: v9.2.0
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
* Returns: {string|Buffer}

Synchronous realpath(3).

Expand Down Expand Up @@ -2619,6 +2632,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* Returns: {fs.Stats}

Synchronous stat(2). Returns an instance of [`fs.Stats`][].

Expand Down Expand Up @@ -3197,6 +3211,7 @@ changes:
* `offset` {integer}
* `length` {integer}
* `position` {integer}
* Returns: {number}

## fs.writeSync(fd, string[, position[, encoding]])
<!-- YAML
Expand All @@ -3211,6 +3226,7 @@ changes:
* `string` {string}
* `position` {integer}
* `encoding` {string}
* Returns: {number}

Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.

Expand Down
18 changes: 17 additions & 1 deletion doc/api/util.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ contains circular references.
Similar to `util.inspect()` without options.
This will show the full object not including non-enumerable symbols and properties.
* `%%` - single percent sign (`'%'`). This does not consume an argument.
* Returns: {string} The formatted string

If the placeholder does not have a corresponding argument, the placeholder is
not replaced.
Expand Down Expand Up @@ -491,7 +492,7 @@ added: v9.0.0
* `val2` {any}
* Returns: {boolean}

Returns `true` if there is deep strict equality between `val` and `val2`.
Returns `true` if there is deep strict equality between `val1` and `val2`.
Otherwise, returns `false`.

See [`assert.deepStrictEqual()`][] for more information about deep strict
Expand Down Expand Up @@ -806,6 +807,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Internal alias for [`Array.isArray`][].

Expand All @@ -831,6 +833,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Boolean`. Otherwise, returns `false`.

Expand All @@ -854,6 +857,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Buffer`. Otherwise, returns `false`.

Expand All @@ -877,6 +881,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Date`. Otherwise, returns `false`.

Expand All @@ -900,6 +905,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is an [`Error`][]. Otherwise, returns
`false`.
Expand Down Expand Up @@ -939,6 +945,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Function`. Otherwise, returns
`false`.
Expand Down Expand Up @@ -966,6 +973,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is strictly `null`. Otherwise, returns
`false`.
Expand All @@ -990,6 +998,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is `null` or `undefined`. Otherwise,
returns `false`.
Expand All @@ -1014,6 +1023,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Number`. Otherwise, returns `false`.

Expand All @@ -1039,6 +1049,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is strictly an `Object` **and** not a
`Function`. Otherwise, returns `false`.
Expand All @@ -1065,6 +1076,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a primitive type. Otherwise, returns
`false`.
Expand Down Expand Up @@ -1101,6 +1113,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `RegExp`. Otherwise, returns `false`.

Expand All @@ -1124,6 +1137,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `string`. Otherwise, returns `false`.

Expand All @@ -1149,6 +1163,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is a `Symbol`. Otherwise, returns `false`.

Expand All @@ -1172,6 +1187,7 @@ deprecated: v4.0.0
> Stability: 0 - Deprecated

* `object` {any}
* Returns: {boolean}

Returns `true` if the given `object` is `undefined`. Otherwise, returns `false`.

Expand Down