FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: use serial comma in fs docs · nodejs/node@ac9cbba · GitHub

/ node Public

Commit ac9cbba

Browse files
tniessen
authored and
juanarbol
committed
doc: use serial comma in fs docs
Refs: #11321 Refs: #17384 PR-URL: #43104 Reviewed-By: LiviaMedeiros <livia@cirno.name> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
1 parent ec10ae7 commit ac9cbba

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

‎doc/api/fs.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ changes:
184184
- v15.14.0
185185
- v14.18.0
186186
pr-url: https://github.com/nodejs/node/pull/37490
187-
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
187+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
188188
- version: v14.0.0
189189
pr-url: https://github.com/nodejs/node/pull/31030
190190
description: The `data` parameter won't coerce unsupported input to
@@ -688,7 +688,7 @@ added: v10.0.0
688688
changes:
689689
- version: v15.14.0
690690
pr-url: https://github.com/nodejs/node/pull/37490
691-
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
691+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
692692
- version: v14.0.0
693693
pr-url: https://github.com/nodejs/node/pull/31030
694694
description: The `data` parameter won't coerce unsupported input to
@@ -702,7 +702,7 @@ changes:
702702
* Returns: {Promise}
703703
704704
Asynchronously writes data to a file, replacing the file if it already exists.
705-
`data` can be a string, a buffer, an {AsyncIterable} or {Iterable} object.
705+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
706706
The promise is resolved with no arguments upon success.
707707
708708
If `options` is a string, then it specifies the `encoding`.
@@ -1466,7 +1466,7 @@ The `atime` and `mtime` arguments follow these rules:
14661466
14671467
* Values can be either numbers representing Unix epoch time, `Date`s, or a
14681468
numeric string like `'123456789.0'`.
1469-
* If the value can not be converted to a number, or is `NaN`, `Infinity` or
1469+
* If the value can not be converted to a number, or is `NaN`, `Infinity`, or
14701470
`-Infinity`, an `Error` will be thrown.
14711471
14721472
### `fsPromises.watch(filename[, options])`
@@ -1526,7 +1526,7 @@ added: v10.0.0
15261526
changes:
15271527
- version: v15.14.0
15281528
pr-url: https://github.com/nodejs/node/pull/37490
1529-
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
1529+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
15301530
- version:
15311531
- v15.2.0
15321532
- v14.17.0
@@ -1549,7 +1549,7 @@ changes:
15491549
* Returns: {Promise} Fulfills with `undefined` upon success.
15501550
15511551
Asynchronously writes data to a file, replacing the file if it already exists.
1552-
`data` can be a string, a buffer, an {AsyncIterable} or {Iterable} object.
1552+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
15531553
15541554
The `encoding` option is ignored if `data` is a buffer.
15551555
@@ -1669,7 +1669,7 @@ access(file, constants.R_OK | constants.W_OK, (err) => {
16691669
```
16701670
16711671
Do not use `fs.access()` to check for the accessibility of a file before calling
1672-
`fs.open()`, `fs.readFile()` or `fs.writeFile()`. Doing
1672+
`fs.open()`, `fs.readFile()`, or `fs.writeFile()`. Doing
16731673
so introduces a race condition, since other processes may change the file's
16741674
state between the two calls. Instead, user code should open/read/write the
16751675
file directly and handle the error raised if the file is not accessible.
@@ -1946,17 +1946,17 @@ specifies the permissions for others.
19461946
19471947
For example, the octal value `0o765` means:
19481948
1949-
* The owner may read, write and execute the file.
1949+
* The owner may read, write, and execute the file.
19501950
* The group may read and write the file.
19511951
* Others may read and execute the file.
19521952
19531953
When using raw numbers where file modes are expected, any value larger than
19541954
`0o777` may result in platform-specific behaviors that are not supported to work
1955-
consistently. Therefore constants like `S_ISVTX`, `S_ISGID` or `S_ISUID` are not
1956-
exposed in `fs.constants`.
1955+
consistently. Therefore constants like `S_ISVTX`, `S_ISGID`, or `S_ISUID` are
1956+
not exposed in `fs.constants`.
19571957
19581958
Caveats: on Windows only the write permission can be changed, and the
1959-
distinction among the permissions of group, owner or others is not
1959+
distinction among the permissions of group, owner, or others is not
19601960
implemented.
19611961
19621962
### `fs.chown(path, uid, gid, callback)`
@@ -2305,7 +2305,7 @@ By default, the stream will emit a `'close'` event after it has been
23052305
destroyed. Set the `emitClose` option to `false` to change this behavior.
23062306
23072307
By providing the `fs` option it is possible to override the corresponding `fs`
2308-
implementations for `open`, `write`, `writev` and `close`. Overriding `write()`
2308+
implementations for `open`, `write`, `writev`, and `close`. Overriding `write()`
23092309
without `writev()` can reduce performance as some optimizations (`_writev()`)
23102310
will be disabled. When providing the `fs` option, overrides for at least one of
23112311
`write` and `writev` are required. If no `fd` option is supplied, an override
@@ -2355,7 +2355,7 @@ has only one boolean parameter. This is one reason `fs.access()` is recommended
23552355
instead of `fs.exists()`.
23562356
23572357
Using `fs.exists()` to check for the existence of a file before calling
2358-
`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing
2358+
`fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended. Doing
23592359
so introduces a race condition, since other processes may change the file's
23602360
state between the two calls. Instead, user code should open/read/write the
23612361
file directly and handle the error raised if the file does not exist.
@@ -2670,7 +2670,7 @@ changes:
26702670
it will emit a deprecation warning with id DEP0013.
26712671
- version: v4.1.0
26722672
pr-url: https://github.com/nodejs/node/pull/2387
2673-
description: Numeric strings, `NaN` and `Infinity` are now allowed
2673+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
26742674
time specifiers.
26752675
-->
26762676
@@ -3114,7 +3114,7 @@ changes:
31143114
- v12.17.0
31153115
pr-url: https://github.com/nodejs/node/pull/31402
31163116
description: Options object can be passed in
3117-
to make Buffer, offset, length and position optional.
3117+
to make buffer, offset, length, and position optional.
31183118
-->
31193119
31203120
* `fd` {integer}
@@ -3441,7 +3441,7 @@ changes:
34413441
* `err` {Error}
34423442
* `resolvedPath` {string|Buffer}
34433443

3444-
Asynchronously computes the canonical pathname by resolving `.`, `..` and
3444+
Asynchronously computes the canonical pathname by resolving `.`, `..`, and
34453445
symbolic links.
34463446

34473447
A canonical pathname is not necessarily unique. Hard links and bind mounts can
@@ -3680,7 +3680,7 @@ Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
36803680
In case of an error, the `err.code` will be one of [Common System Errors][].
36813681

36823682
Using `fs.stat()` to check for the existence of a file before calling
3683-
`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended.
3683+
`fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended.
36843684
Instead, user code should open/read/write the file directly and handle the
36853685
error raised if the file is not available.
36863686

@@ -3944,7 +3944,7 @@ changes:
39443944
it will emit a deprecation warning with id DEP0013.
39453945
- version: v4.1.0
39463946
pr-url: https://github.com/nodejs/node/pull/2387
3947-
description: Numeric strings, `NaN` and `Infinity` are now allowed
3947+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
39483948
time specifiers.
39493949
-->
39503950

@@ -3960,7 +3960,7 @@ The `atime` and `mtime` arguments follow these rules:
39603960

39613961
* Values can be either numbers representing Unix epoch time in seconds,
39623962
`Date`s, or a numeric string like `'123456789.0'`.
3963-
* If the value can not be converted to a number, or is `NaN`, `Infinity` or
3963+
* If the value can not be converted to a number, or is `NaN`, `Infinity`, or
39643964
`-Infinity`, an `Error` will be thrown.
39653965

39663966
### `fs.watch(filename[, options][, listener])`
@@ -4835,7 +4835,7 @@ added: v0.4.2
48354835
changes:
48364836
- version: v4.1.0
48374837
pr-url: https://github.com/nodejs/node/pull/2387
4838-
description: Numeric strings, `NaN` and `Infinity` are now allowed
4838+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
48394839
time specifiers.
48404840
-->
48414841
@@ -5195,7 +5195,7 @@ changes:
51955195
- v12.17.0
51965196
pr-url: https://github.com/nodejs/node/pull/32460
51975197
description: Options object can be passed in
5198-
to make offset, length and position optional.
5198+
to make offset, length, and position optional.
51995199
-->
52005200
52015201
* `fd` {integer}
@@ -5498,7 +5498,7 @@ changes:
54985498
protocol.
54995499
- version: v4.1.0
55005500
pr-url: https://github.com/nodejs/node/pull/2387
5501-
description: Numeric strings, `NaN` and `Infinity` are now allowed
5501+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
55025502
time specifiers.
55035503
-->
55045504
@@ -6119,7 +6119,7 @@ changes:
61196119
61206120
A {fs.Stats} object provides information about a file.
61216121
6122-
Objects returned from [`fs.stat()`][], [`fs.lstat()`][] and [`fs.fstat()`][] and
6122+
Objects returned from [`fs.stat()`][], [`fs.lstat()`][], [`fs.fstat()`][], and
61236123
their synchronous counterparts are of this type.
61246124
If `bigint` in the `options` passed to those methods is true, the numeric values
61256125
will be `bigint` instead of `number`, and the object will contain additional
@@ -6766,7 +6766,7 @@ The following constants are meant for use with `fs.open()`.
67666766
</table>
67676767
67686768
On Windows, only `O_APPEND`, `O_CREAT`, `O_EXCL`, `O_RDONLY`, `O_RDWR`,
6769-
`O_TRUNC`, `O_WRONLY` and `UV_FS_O_FILEMAP` are available.
6769+
`O_TRUNC`, `O_WRONLY`, and `UV_FS_O_FILEMAP` are available.
67706770
67716771
##### File type constants
67726772
@@ -7277,7 +7277,7 @@ fs.open('<directory>', 'a+', (err, fd) => {
72777277
```
72787278
72797279
On Windows, opening an existing hidden file using the `'w'` flag (either
7280-
through `fs.open()` or `fs.writeFile()` or `fsPromises.open()`) will fail with
7280+
through `fs.open()`, `fs.writeFile()`, or `fsPromises.open()`) will fail with
72817281
`EPERM`. Existing hidden files can be opened for writing with the `'r+'` flag.
72827282
72837283
A call to `fs.ftruncate()` or `filehandle.truncate()` can be used to reset

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL