Skip to content

Commit f53ed9d

Browse files
tniessenBethGriggs
authored andcommitted
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 839824a commit f53ed9d

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

doc/api/fs.md

+25-25
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
@@ -690,7 +690,7 @@ changes:
690690
- v15.14.0
691691
- v14.18.0
692692
pr-url: https://github.com/nodejs/node/pull/37490
693-
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
693+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
694694
- version: v14.0.0
695695
pr-url: https://github.com/nodejs/node/pull/31030
696696
description: The `data` parameter won't coerce unsupported input to
@@ -704,7 +704,7 @@ changes:
704704
* Returns: {Promise}
705705
706706
Asynchronously writes data to a file, replacing the file if it already exists.
707-
`data` can be a string, a buffer, an {AsyncIterable} or {Iterable} object.
707+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
708708
The promise is resolved with no arguments upon success.
709709
710710
If `options` is a string, then it specifies the `encoding`.
@@ -1470,7 +1470,7 @@ The `atime` and `mtime` arguments follow these rules:
14701470
14711471
* Values can be either numbers representing Unix epoch time, `Date`s, or a
14721472
numeric string like `'123456789.0'`.
1473-
* If the value can not be converted to a number, or is `NaN`, `Infinity` or
1473+
* If the value can not be converted to a number, or is `NaN`, `Infinity`, or
14741474
`-Infinity`, an `Error` will be thrown.
14751475
14761476
### `fsPromises.watch(filename[, options])`
@@ -1534,7 +1534,7 @@ changes:
15341534
- v15.14.0
15351535
- v14.18.0
15361536
pr-url: https://github.com/nodejs/node/pull/37490
1537-
description: The `data` argument supports `AsyncIterable`, `Iterable` and `Stream`.
1537+
description: The `data` argument supports `AsyncIterable`, `Iterable`, and `Stream`.
15381538
- version:
15391539
- v15.2.0
15401540
- v14.17.0
@@ -1557,7 +1557,7 @@ changes:
15571557
* Returns: {Promise} Fulfills with `undefined` upon success.
15581558
15591559
Asynchronously writes data to a file, replacing the file if it already exists.
1560-
`data` can be a string, a buffer, an {AsyncIterable} or {Iterable} object.
1560+
`data` can be a string, a buffer, an {AsyncIterable}, or an {Iterable} object.
15611561
15621562
The `encoding` option is ignored if `data` is a buffer.
15631563
@@ -1682,7 +1682,7 @@ access(file, constants.R_OK | constants.W_OK, (err) => {
16821682
```
16831683
16841684
Do not use `fs.access()` to check for the accessibility of a file before calling
1685-
`fs.open()`, `fs.readFile()` or `fs.writeFile()`. Doing
1685+
`fs.open()`, `fs.readFile()`, or `fs.writeFile()`. Doing
16861686
so introduces a race condition, since other processes may change the file's
16871687
state between the two calls. Instead, user code should open/read/write the
16881688
file directly and handle the error raised if the file is not accessible.
@@ -1969,17 +1969,17 @@ specifies the permissions for others.
19691969
19701970
For example, the octal value `0o765` means:
19711971
1972-
* The owner may read, write and execute the file.
1972+
* The owner may read, write, and execute the file.
19731973
* The group may read and write the file.
19741974
* Others may read and execute the file.
19751975
19761976
When using raw numbers where file modes are expected, any value larger than
19771977
`0o777` may result in platform-specific behaviors that are not supported to work
1978-
consistently. Therefore constants like `S_ISVTX`, `S_ISGID` or `S_ISUID` are not
1979-
exposed in `fs.constants`.
1978+
consistently. Therefore constants like `S_ISVTX`, `S_ISGID`, or `S_ISUID` are
1979+
not exposed in `fs.constants`.
19801980
19811981
Caveats: on Windows only the write permission can be changed, and the
1982-
distinction among the permissions of group, owner or others is not
1982+
distinction among the permissions of group, owner, or others is not
19831983
implemented.
19841984
19851985
### `fs.chown(path, uid, gid, callback)`
@@ -2350,7 +2350,7 @@ By default, the stream will emit a `'close'` event after it has been
23502350
destroyed. Set the `emitClose` option to `false` to change this behavior.
23512351
23522352
By providing the `fs` option it is possible to override the corresponding `fs`
2353-
implementations for `open`, `write`, `writev` and `close`. Overriding `write()`
2353+
implementations for `open`, `write`, `writev`, and `close`. Overriding `write()`
23542354
without `writev()` can reduce performance as some optimizations (`_writev()`)
23552355
will be disabled. When providing the `fs` option, overrides for at least one of
23562356
`write` and `writev` are required. If no `fd` option is supplied, an override
@@ -2405,7 +2405,7 @@ has only one boolean parameter. This is one reason `fs.access()` is recommended
24052405
instead of `fs.exists()`.
24062406
24072407
Using `fs.exists()` to check for the existence of a file before calling
2408-
`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing
2408+
`fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended. Doing
24092409
so introduces a race condition, since other processes may change the file's
24102410
state between the two calls. Instead, user code should open/read/write the
24112411
file directly and handle the error raised if the file does not exist.
@@ -2755,7 +2755,7 @@ changes:
27552755
it will emit a deprecation warning with id DEP0013.
27562756
- version: v4.1.0
27572757
pr-url: https://github.com/nodejs/node/pull/2387
2758-
description: Numeric strings, `NaN` and `Infinity` are now allowed
2758+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
27592759
time specifiers.
27602760
-->
27612761
@@ -3252,7 +3252,7 @@ changes:
32523252
- v12.17.0
32533253
pr-url: https://github.com/nodejs/node/pull/31402
32543254
description: Options object can be passed in
3255-
to make Buffer, offset, length and position optional.
3255+
to make buffer, offset, length, and position optional.
32563256
-->
32573257
32583258
* `fd` {integer}
@@ -3607,7 +3607,7 @@ changes:
36073607
* `err` {Error}
36083608
* `resolvedPath` {string|Buffer}
36093609

3610-
Asynchronously computes the canonical pathname by resolving `.`, `..` and
3610+
Asynchronously computes the canonical pathname by resolving `.`, `..`, and
36113611
symbolic links.
36123612

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

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

@@ -4153,7 +4153,7 @@ changes:
41534153
it will emit a deprecation warning with id DEP0013.
41544154
- version: v4.1.0
41554155
pr-url: https://github.com/nodejs/node/pull/2387
4156-
description: Numeric strings, `NaN` and `Infinity` are now allowed
4156+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
41574157
time specifiers.
41584158
-->
41594159

@@ -4169,7 +4169,7 @@ The `atime` and `mtime` arguments follow these rules:
41694169

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

41754175
### `fs.watch(filename[, options][, listener])`
@@ -5063,7 +5063,7 @@ added: v0.4.2
50635063
changes:
50645064
- version: v4.1.0
50655065
pr-url: https://github.com/nodejs/node/pull/2387
5066-
description: Numeric strings, `NaN` and `Infinity` are now allowed
5066+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
50675067
time specifiers.
50685068
-->
50695069
@@ -5425,7 +5425,7 @@ changes:
54255425
- v12.17.0
54265426
pr-url: https://github.com/nodejs/node/pull/32460
54275427
description: Options object can be passed in
5428-
to make offset, length and position optional.
5428+
to make offset, length, and position optional.
54295429
-->
54305430
54315431
* `fd` {integer}
@@ -5730,7 +5730,7 @@ changes:
57305730
protocol.
57315731
- version: v4.1.0
57325732
pr-url: https://github.com/nodejs/node/pull/2387
5733-
description: Numeric strings, `NaN` and `Infinity` are now allowed
5733+
description: Numeric strings, `NaN`, and `Infinity` are now allowed
57345734
time specifiers.
57355735
-->
57365736
@@ -6357,7 +6357,7 @@ changes:
63576357
63586358
A {fs.Stats} object provides information about a file.
63596359
6360-
Objects returned from [`fs.stat()`][], [`fs.lstat()`][] and [`fs.fstat()`][] and
6360+
Objects returned from [`fs.stat()`][], [`fs.lstat()`][], [`fs.fstat()`][], and
63616361
their synchronous counterparts are of this type.
63626362
If `bigint` in the `options` passed to those methods is true, the numeric values
63636363
will be `bigint` instead of `number`, and the object will contain additional
@@ -7004,7 +7004,7 @@ The following constants are meant for use with `fs.open()`.
70047004
</table>
70057005
70067006
On Windows, only `O_APPEND`, `O_CREAT`, `O_EXCL`, `O_RDONLY`, `O_RDWR`,
7007-
`O_TRUNC`, `O_WRONLY` and `UV_FS_O_FILEMAP` are available.
7007+
`O_TRUNC`, `O_WRONLY`, and `UV_FS_O_FILEMAP` are available.
70087008
70097009
##### File type constants
70107010
@@ -7515,7 +7515,7 @@ fs.open('<directory>', 'a+', (err, fd) => {
75157515
```
75167516
75177517
On Windows, opening an existing hidden file using the `'w'` flag (either
7518-
through `fs.open()` or `fs.writeFile()` or `fsPromises.open()`) will fail with
7518+
through `fs.open()`, `fs.writeFile()`, or `fsPromises.open()`) will fail with
75197519
`EPERM`. Existing hidden files can be opened for writing with the `'r+'` flag.
75207520
75217521
A call to `fs.ftruncate()` or `filehandle.truncate()` can be used to reset

0 commit comments

Comments
 (0)